Selling Partner API SDK for JavaScript
    Preparing search index...
    • ProductPricingApi - functional programming interface

      Parameters

      • Optionalconfiguration: Configuration

      Returns {
          getCompetitivePricing(
              marketplaceId: string,
              itemType: GetCompetitivePricingItemTypeEnum,
              asins?: string[],
              skus?: string[],
              customerType?: GetCompetitivePricingCustomerTypeEnum,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetPricingResponse>,
          >;
          getItemOffers(
              marketplaceId: string,
              itemCondition: GetItemOffersItemConditionEnum,
              asin: string,
              customerType?: GetItemOffersCustomerTypeEnum,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetOffersResponse>,
          >;
          getItemOffersBatch(
              getItemOffersBatchRequestBody: GetItemOffersBatchRequest,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetItemOffersBatchResponse>,
          >;
          getListingOffers(
              marketplaceId: string,
              itemCondition: GetListingOffersItemConditionEnum,
              sellerSKU: string,
              customerType?: GetListingOffersCustomerTypeEnum,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetOffersResponse>,
          >;
          getListingOffersBatch(
              getListingOffersBatchRequestBody: GetListingOffersBatchRequest,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetListingOffersBatchResponse>,
          >;
          getPricing(
              marketplaceId: string,
              itemType: GetPricingItemTypeEnum,
              asins?: string[],
              skus?: string[],
              itemCondition?: GetPricingItemConditionEnum,
              offerType?: GetPricingOfferTypeEnum,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetPricingResponse>,
          >;
      }

      • getCompetitivePricing: function
        • Returns competitive pricing information for a seller's offer listings based on seller SKU or ASIN. Note: The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

          Parameters

          • marketplaceId: string

            A marketplace identifier. Specifies the marketplace for which prices are returned.

          • itemType: GetCompetitivePricingItemTypeEnum

            Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter. Possible values: Asin, Sku.

          • Optionalasins: string[]

            A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.

          • Optionalskus: string[]

            A list of up to twenty seller SKU values used to identify items in the given marketplace.

          • OptionalcustomerType: GetCompetitivePricingCustomerTypeEnum

            Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetPricingResponse>,
          >

      • getItemOffers: function
        • Returns the lowest priced offers for a single item based on ASIN. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

          Parameters

          • marketplaceId: string

            A marketplace identifier. Specifies the marketplace for which prices are returned.

          • itemCondition: GetItemOffersItemConditionEnum

            Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.

          • asin: string

            The Amazon Standard Identification Number (ASIN) of the item.

          • OptionalcustomerType: GetItemOffersCustomerTypeEnum

            Indicates whether to request Consumer or Business offers. Default is Consumer.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetOffersResponse>,
          >

      • getItemOffersBatch: function
        • Returns the lowest priced offers for a batch of items based on ASIN. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.1 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

          Parameters

          • getItemOffersBatchRequestBody: GetItemOffersBatchRequest

            The request associated with the `getItemOffersBatch` API call.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetItemOffersBatchResponse>,
          >

      • getListingOffers: function
        • Returns the lowest priced offers for a single SKU listing. Note: The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 2 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

          Parameters

          • marketplaceId: string

            A marketplace identifier. Specifies the marketplace for which prices are returned.

          • itemCondition: GetListingOffersItemConditionEnum

            Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.

          • sellerSKU: string

            Identifies an item in the given marketplace. SellerSKU is qualified by the seller&#39;s SellerId, which is included with every operation that you submit.

          • OptionalcustomerType: GetListingOffersCustomerTypeEnum

            Indicates whether to request Consumer or Business offers. Default is Consumer.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetOffersResponse>,
          >

      • getListingOffersBatch: function
        • Returns the lowest priced offers for a batch of listings by SKU. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

          Parameters

          • getListingOffersBatchRequestBody: GetListingOffersBatchRequest

            The request associated with the `getListingOffersBatch` API call.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetListingOffersBatchResponse>,
          >

      • getPricing: function
        • Returns pricing information for a seller's offer listings based on seller SKU or ASIN. Note: The parameters associated with this operation may contain special characters that require URL encoding to call the API. To avoid errors with SKUs when encoding URLs, refer to URL Encoding. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 0.5 | 1 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see Usage Plans and Rate Limits in the Selling Partner API.

          Parameters

          • marketplaceId: string

            A marketplace identifier. Specifies the marketplace for which prices are returned.

          • itemType: GetPricingItemTypeEnum

            Indicates whether ASIN values or seller SKU values are used to identify items. If you specify Asin, the information in the response will be dependent on the list of Asins you provide in the Asins parameter. If you specify Sku, the information in the response will be dependent on the list of Skus you provide in the Skus parameter.

          • Optionalasins: string[]

            A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace.

          • Optionalskus: string[]

            A list of up to twenty seller SKU values used to identify items in the given marketplace.

          • OptionalitemCondition: GetPricingItemConditionEnum

            Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club.

          • OptionalofferType: GetPricingOfferTypeEnum

            Indicates whether to request pricing information for the seller&#39;s B2C or B2B offers. Default is B2C.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<GetPricingResponse>,
          >