Class ShippingRatesV2Service

constructor

• new ShippingRatesV2Service(httpRequest): ShippingRatesV2Service

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ShippingRatesV2Service

ReadonlyhttpRequest

calculateShppingRates

• calculateShppingRates(xPfStoreId?, xPfLanguage?, requestBody?): CancelablePromise<any>

• Calculate Shipping Rates Returns available shipping options and rates for the given list of products.

  Recipient Address Requirements:

  • Only country_code is required in the recipient object
  • state_code is only required for United States (US), Australia (AU), and Canada (CA)
  • All other recipient fields are optional

  Note: Providing more address information may produce more precise results and more shipping options. While only the country code is required, including additional details like city, postal code, and state/province can help return more accurate shipping rates and additional delivery options.

  Parameters

  • 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.
  • OptionalxPfLanguage: string

    Use this to specify which locale you would like to use in the responses, for some endpoints this can affect translations.
  • OptionalrequestBody: {
        currency?: string;
        order_items: (CatalogShippingRateItem | WarehouseShippingRateItem)[];
        recipient: ShippingRatesAddress;
    }

    POST request body

    • Optionalcurrency?: string

      Currency code in which the rate is returned. If not provided will use the default currency for the store.

    • order_items: (CatalogShippingRateItem | WarehouseShippingRateItem)[]

      Array of order items

    • recipient: ShippingRatesAddress

      The recipient data.

  Returns CancelablePromise<any>

  any OK

  Throws

  ApiError