Class WarehouseProductsV2Service

constructor

• new WarehouseProductsV2Service(httpRequest): WarehouseProductsV2Service

• Parameters

  • httpRequest: BaseHttpRequest

  Returns WarehouseProductsV2Service

ReadonlyhttpRequest

getWarehouseProductById

• getWarehouseProductById(warehouseProductId, xPfStoreId?): CancelablePromise<{
      data: {
          _links: {
              self?: HateoasLink;
              warehouse_variants?: HateoasLink;
          };
          currency: string;
          id: number;
          image_url: string;
          name: string;
          retail_price: string;
          status:
              | "draft"
              | "awaiting_approval"
              | "approved"
              | "declined"
              | "suspended";
          warehouse_variants: {
              _links: {
                  self?: HateoasLink;
              };
              dimensions: {
                  height: number;
                  length: number;
                  measurement_system: "imperial" | "metric";
                  weight: number;
                  width: number;
              };
              id: number;
              image_url: string;
              name: string;
              quantity: number;
              retail_price: string;
              sku: string;
              stock_location: {
                  available: number;
                  facility: string;
                  stocked: number;
              }[];
          }[];
      };
  }>

• Retrieve a single warehouse product Get information about a single warehouse product with it's stock location.

  Parameters

  • warehouseProductId: number

    Warehouse Product ID.
  • OptionalxPfStoreId: string

    Use this to specify which store you want to use (required only for account level token).

    The store IDs can be retrieved with the Get basic information about stores endpoint.

  Returns CancelablePromise<{
      data: {
          _links: {
              self?: HateoasLink;
              warehouse_variants?: HateoasLink;
          };
          currency: string;
          id: number;
          image_url: string;
          name: string;
          retail_price: string;
          status:
              | "draft"
              | "awaiting_approval"
              | "approved"
              | "declined"
              | "suspended";
          warehouse_variants: {
              _links: {
                  self?: HateoasLink;
              };
              dimensions: {
                  height: number;
                  length: number;
                  measurement_system: "imperial" | "metric";
                  weight: number;
                  width: number;
              };
              id: number;
              image_url: string;
              name: string;
              quantity: number;
              retail_price: string;
              sku: string;
              stock_location: {
                  available: number;
                  facility: string;
                  stocked: number;
              }[];
          }[];
      };
  }>

  any OK

  Throws

  ApiError

getWarehouseProducts

• getWarehouseProducts(filterName?, xPfStoreId?, limit?, offset?): CancelablePromise<{
      _links: {
          first?: HateoasLink;
          last?: HateoasLink;
          next?: HateoasLink;
          previous?: HateoasLink;
          self?: HateoasLink;
      };
      data: {
          _links: {
              self?: HateoasLink;
              warehouse_variants?: HateoasLink;
          };
          currency: string;
          id: number;
          image_url: string;
          name: string;
          retail_price: string;
          status:
              | "draft"
              | "awaiting_approval"
              | "approved"
              | "declined"
              | "suspended";
          warehouse_variants: {
              _links: {
                  self?: HateoasLink;
              };
              dimensions: {
                  height: number;
                  length: number;
                  measurement_system: "imperial" | "metric";
                  weight: number;
                  width: number;
              };
              id: number;
              image_url: string;
              name: string;
              quantity: number;
              retail_price: string;
              sku: string;
          }[];
      }[];
      paging: Paging;
  }>

• Retrieve a list of warehouse products This endpoint returns paginated results containing detailed information about warehouse products, including their variants, stock levels, and dimensions.

  Parameters

  • OptionalfilterName: string

    Wildcard match of the name value. Note that the value will be matched if the name property contains the value anywhere in the string.
  • OptionalxPfStoreId: string

    Use this to specify which store you want to use (required only for account level token).

    The store IDs can be retrieved with the Get basic information about stores endpoint.
  • limit: number = 20

    The number of results to return per page.
  • Optionaloffset: number

    The number of results to not include in the response starting from the beginning of the list.

    This can be used to return results after the initial 100. For example, sending offset 100

  Returns CancelablePromise<{
      _links: {
          first?: HateoasLink;
          last?: HateoasLink;
          next?: HateoasLink;
          previous?: HateoasLink;
          self?: HateoasLink;
      };
      data: {
          _links: {
              self?: HateoasLink;
              warehouse_variants?: HateoasLink;
          };
          currency: string;
          id: number;
          image_url: string;
          name: string;
          retail_price: string;
          status:
              | "draft"
              | "awaiting_approval"
              | "approved"
              | "declined"
              | "suspended";
          warehouse_variants: {
              _links: {
                  self?: HateoasLink;
              };
              dimensions: {
                  height: number;
                  length: number;
                  measurement_system: "imperial" | "metric";
                  weight: number;
                  width: number;
              };
              id: number;
              image_url: string;
              name: string;
              quantity: number;
              retail_price: string;
              sku: string;
          }[];
      }[];
      paging: Paging;
  }>

  any OK

  Throws

  ApiError