urembo-hub-api
    Preparing search index...
    Index

    Constructors

    Methods

    • Parameters

      • id: string
      • userId: string
      • userRole: string
      • Optionalreason: string

      Returns Promise<
          {
              manufacturer: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
              product: {
                  currency: string;
                  description: string;
                  id: string;
                  imageUrl: string;
                  name: string;
                  price: Decimal;
                  sku: string;
                  stockQuantity: number;
              };
              retailer: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
          } & {
              actualDeliveryDate: Date;
              createdAt: Date;
              currency: string;
              discount: Decimal;
              estimatedDeliveryDate: Date;
              id: string;
              manufacturerId: string;
              notes: string;
              productId: string;
              quantity: number;
              requestedDeliveryDate: Date;
              retailerId: string;
              shippingCost: Decimal;
              status: string;
              subtotal: Decimal;
              tax: Decimal;
              totalAmount: Decimal;
              trackingNumber: string;
              unitPrice: Decimal;
              updatedAt: Date;
          },
      >

    • Parameters

      Returns Promise<
          {
              manufacturer: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
              product: {
                  currency: string;
                  description: string;
                  id: string;
                  imageUrl: string;
                  name: string;
                  price: Decimal;
                  sku: string;
                  stockQuantity: number;
              };
              retailer: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
          } & {
              actualDeliveryDate: Date;
              createdAt: Date;
              currency: string;
              discount: Decimal;
              estimatedDeliveryDate: Date;
              id: string;
              manufacturerId: string;
              notes: string;
              productId: string;
              quantity: number;
              requestedDeliveryDate: Date;
              retailerId: string;
              shippingCost: Decimal;
              status: string;
              subtotal: Decimal;
              tax: Decimal;
              totalAmount: Decimal;
              trackingNumber: string;
              unitPrice: Decimal;
              updatedAt: Date;
          },
      >

    • Parameters

      • page: number = 1
      • limit: number = 10
      • Optionalstatus: string
      • OptionalmanufacturerId: string
      • OptionalretailerId: string

      Returns Promise<
          {
              orders: (
                  {
                      manufacturer: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                          phone: string;
                      };
                      product: {
                          currency: string;
                          description: string;
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                          sku: string;
                          stockQuantity: number;
                      };
                      retailer: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                          phone: string;
                      };
                  } & {
                      actualDeliveryDate: Date;
                      createdAt: Date;
                      currency: string;
                      discount: Decimal;
                      estimatedDeliveryDate: Date;
                      id: string;
                      manufacturerId: string;
                      notes: string;
                      productId: string;
                      quantity: number;
                      requestedDeliveryDate: Date;
                      retailerId: string;
                      shippingCost: Decimal;
                      status: string;
                      subtotal: Decimal;
                      tax: Decimal;
                      totalAmount: Decimal;
                      trackingNumber: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              pagination: { limit: number; page: number; pages: number; total: number };
          },
      >

    • Parameters

      • manufacturerId: string
      • page: number = 1
      • limit: number = 10
      • Optionalstatus: string

      Returns Promise<
          {
              orders: (
                  {
                      product: {
                          currency: string;
                          description: string;
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                          sku: string;
                          stockQuantity: number;
                      };
                      retailer: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                          phone: string;
                      };
                  } & {
                      actualDeliveryDate: Date;
                      createdAt: Date;
                      currency: string;
                      discount: Decimal;
                      estimatedDeliveryDate: Date;
                      id: string;
                      manufacturerId: string;
                      notes: string;
                      productId: string;
                      quantity: number;
                      requestedDeliveryDate: Date;
                      retailerId: string;
                      shippingCost: Decimal;
                      status: string;
                      subtotal: Decimal;
                      tax: Decimal;
                      totalAmount: Decimal;
                      trackingNumber: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              pagination: { limit: number; page: number; pages: number; total: number };
          },
      >

    • Parameters

      • OptionalmanufacturerId: string
      • OptionalretailerId: string

      Returns Promise<
          {
              cancelledOrders: number;
              confirmedOrders: number;
              deliveredOrders: number;
              pendingOrders: number;
              processingOrders: number;
              shippedOrders: number;
              totalOrders: number;
              totalRevenue: number
              | Decimal;
          },
      >

    • Parameters

      • id: string

      Returns Promise<
          {
              manufacturer: {
                  businessAddress: string;
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
              product: {
                  category: {
                      createdAt: Date;
                      description: string;
                      id: string;
                      imageUrl: string;
                      isActive: boolean;
                      level: number;
                      name: string;
                      parentId: string;
                      position: number;
                      slug: string;
                      updatedAt: Date;
                  };
                  currency: string;
                  description: string;
                  id: string;
                  imageUrl: string;
                  name: string;
                  price: Decimal;
                  sku: string;
                  stockQuantity: number;
              };
              retailer: {
                  businessAddress: string;
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
          } & {
              actualDeliveryDate: Date;
              createdAt: Date;
              currency: string;
              discount: Decimal;
              estimatedDeliveryDate: Date;
              id: string;
              manufacturerId: string;
              notes: string;
              productId: string;
              quantity: number;
              requestedDeliveryDate: Date;
              retailerId: string;
              shippingCost: Decimal;
              status: string;
              subtotal: Decimal;
              tax: Decimal;
              totalAmount: Decimal;
              trackingNumber: string;
              unitPrice: Decimal;
              updatedAt: Date;
          },
      >

    • Parameters

      • retailerId: string
      • page: number = 1
      • limit: number = 10
      • Optionalstatus: string

      Returns Promise<
          {
              orders: (
                  {
                      manufacturer: {
                          businessName: string;
                          email: string;
                          fullName: string;
                          id: string;
                          phone: string;
                      };
                      product: {
                          currency: string;
                          description: string;
                          id: string;
                          imageUrl: string;
                          name: string;
                          price: Decimal;
                          sku: string;
                          stockQuantity: number;
                      };
                  } & {
                      actualDeliveryDate: Date;
                      createdAt: Date;
                      currency: string;
                      discount: Decimal;
                      estimatedDeliveryDate: Date;
                      id: string;
                      manufacturerId: string;
                      notes: string;
                      productId: string;
                      quantity: number;
                      requestedDeliveryDate: Date;
                      retailerId: string;
                      shippingCost: Decimal;
                      status: string;
                      subtotal: Decimal;
                      tax: Decimal;
                      totalAmount: Decimal;
                      trackingNumber: string;
                      unitPrice: Decimal;
                      updatedAt: Date;
                  }
              )[];
              pagination: { limit: number; page: number; pages: number; total: number };
          },
      >

    • Parameters

      • query: string
      • OptionalmanufacturerId: string
      • OptionalretailerId: string

      Returns Promise<
          (
              {
                  manufacturer: {
                      businessName: string;
                      email: string;
                      fullName: string;
                      id: string;
                      phone: string;
                  };
                  product: {
                      currency: string;
                      description: string;
                      id: string;
                      imageUrl: string;
                      name: string;
                      price: Decimal;
                      sku: string;
                      stockQuantity: number;
                  };
                  retailer: {
                      businessName: string;
                      email: string;
                      fullName: string;
                      id: string;
                      phone: string;
                  };
              } & {
                  actualDeliveryDate: Date;
                  createdAt: Date;
                  currency: string;
                  discount: Decimal;
                  estimatedDeliveryDate: Date;
                  id: string;
                  manufacturerId: string;
                  notes: string;
                  productId: string;
                  quantity: number;
                  requestedDeliveryDate: Date;
                  retailerId: string;
                  shippingCost: Decimal;
                  status: string;
                  subtotal: Decimal;
                  tax: Decimal;
                  totalAmount: Decimal;
                  trackingNumber: string;
                  unitPrice: Decimal;
                  updatedAt: Date;
              }
          )[],
      >

    • Parameters

      Returns Promise<
          {
              manufacturer: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
              product: {
                  currency: string;
                  description: string;
                  id: string;
                  imageUrl: string;
                  name: string;
                  price: Decimal;
                  sku: string;
                  stockQuantity: number;
              };
              retailer: {
                  businessName: string;
                  email: string;
                  fullName: string;
                  id: string;
                  phone: string;
              };
          } & {
              actualDeliveryDate: Date;
              createdAt: Date;
              currency: string;
              discount: Decimal;
              estimatedDeliveryDate: Date;
              id: string;
              manufacturerId: string;
              notes: string;
              productId: string;
              quantity: number;
              requestedDeliveryDate: Date;
              retailerId: string;
              shippingCost: Decimal;
              status: string;
              subtotal: Decimal;
              tax: Decimal;
              totalAmount: Decimal;
              trackingNumber: string;
              unitPrice: Decimal;
              updatedAt: Date;
          },
      >