import { ClientConfiguration, RateLimit } from "@sp-api-sdk/common"; import { AxiosInstance, AxiosPromise, RawAxiosRequestConfig } from "axios"; //#region src/api-model/configuration.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ interface AWSv4Configuration { options?: { region?: string; service?: string; }; credentials?: { accessKeyId?: string; secretAccessKey?: string; sessionToken?: string; }; } interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); awsv4?: AWSv4Configuration; basePath?: string; serverIndex?: number; baseOptions?: any; formDataCtor?: new () => any; } declare class Configuration { /** * parameter for apiKey security * @param name security name */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security */ username?: string; /** * parameter for basic security */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * parameter for aws4 signature security * @param {Object} AWS4Signature - AWS4 Signature security * @param {string} options.region - aws region * @param {string} options.service - name of the service. * @param {string} credentials.accessKeyId - aws access key id * @param {string} credentials.secretAccessKey - aws access key * @param {string} credentials.sessionToken - aws session token * @memberof Configuration */ awsv4?: AWSv4Configuration; /** * override base path */ basePath?: string; /** * override server index */ serverIndex?: number; /** * base options for axios calls */ baseOptions?: any; /** * The FormData constructor that will be used to create multipart form data * requests. You can inject this here so that execution environments that * do not support the FormData class can still run the generated client. * * @type {new () => FormData} */ formDataCtor?: new () => any; constructor(param?: ConfigurationParameters); /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ isJsonMime(mime: string): boolean; } //#endregion //#region src/api-model/base.d.ts interface RequestArgs { url: string; options: RawAxiosRequestConfig; } declare class BaseAPI { protected basePath: string; protected axios: AxiosInstance; protected configuration: Configuration | undefined; constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); } //#endregion //#region src/api-model/models/asinidentifier.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Schema to identify an item by MarketPlaceId and ASIN. */ export interface ASINIdentifier { /** * A marketplace identifier. */ 'MarketplaceId': string; /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN': string; } //#endregion //#region src/api-model/models/customer-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates whether to request Consumer or Business offers. Default is Consumer. */ export declare const CustomerType: { readonly Consumer: "Consumer"; readonly Business: "Business"; }; export type CustomerType = typeof CustomerType[keyof typeof CustomerType]; //#endregion //#region src/api-model/models/item-condition.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. */ export declare const ItemCondition: { readonly New: "New"; readonly Used: "Used"; readonly Collectible: "Collectible"; readonly Refurbished: "Refurbished"; readonly Club: "Club"; }; export type ItemCondition = typeof ItemCondition[keyof typeof ItemCondition]; //#endregion //#region src/api-model/models/batch-offers-request-params.d.ts /** * Common request parameters that can be accepted by `ItemOffersRequest` and `ListingOffersRequest` */ export interface BatchOffersRequestParams { /** * A marketplace identifier. Specifies the marketplace for which prices are returned. */ 'MarketplaceId': string; 'ItemCondition': ItemCondition; 'CustomerType'?: CustomerType; } //#endregion //#region src/api-model/models/get-offers-http-status-line.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The HTTP status line associated with the response. For more information, consult [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html). */ export interface GetOffersHttpStatusLine { /** * The HTTP response Status Code. */ 'statusCode'?: number; /** * The HTTP response Reason-Phase. */ 'reasonPhrase'?: string; } //#endregion //#region src/api-model/models/condition-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates the condition of the item. Possible values: New, Used, Collectible, Refurbished, Club. */ export declare const ConditionType: { readonly New: "New"; readonly Used: "Used"; readonly Collectible: "Collectible"; readonly Refurbished: "Refurbished"; readonly Club: "Club"; }; export type ConditionType = typeof ConditionType[keyof typeof ConditionType]; //#endregion //#region src/api-model/models/item-identifier.d.ts /** * Information that identifies an item. */ export interface ItemIdentifier { /** * A marketplace identifier. Specifies the marketplace from which prices are returned. */ 'MarketplaceId': string; /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN'?: string; /** * The seller stock keeping unit (SKU) of the item. */ 'SellerSKU'?: string; 'ItemCondition': ConditionType; } //#endregion //#region src/api-model/models/detailed-shipping-time-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The time range in which an item will likely be shipped once an order has been placed. */ export interface DetailedShippingTimeType { /** * The minimum time, in hours, that the item will likely be shipped after the order has been placed. */ 'minimumHours'?: number; /** * The maximum time, in hours, that the item will likely be shipped after the order has been placed. */ 'maximumHours'?: number; /** * The date when the item will be available for shipping. Only displayed for items that are not currently available for shipping. */ 'availableDate'?: string; /** * Indicates whether the item is available for shipping now, or on a known or an unknown date in the future. If known, the availableDate property indicates the date that the item will be available for shipping. Possible values: NOW, FUTURE_WITHOUT_DATE, FUTURE_WITH_DATE. */ 'availabilityType'?: DetailedShippingTimeTypeAvailabilityTypeEnum; } export declare const DetailedShippingTimeTypeAvailabilityTypeEnum: { readonly Now: "NOW"; readonly FutureWithoutDate: "FUTURE_WITHOUT_DATE"; readonly FutureWithDate: "FUTURE_WITH_DATE"; }; export type DetailedShippingTimeTypeAvailabilityTypeEnum = typeof DetailedShippingTimeTypeAvailabilityTypeEnum[keyof typeof DetailedShippingTimeTypeAvailabilityTypeEnum]; //#endregion //#region src/api-model/models/money-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Currency type and monetary value. Schema for demonstrating pricing info. */ export interface MoneyType { /** * The currency code in ISO 4217 format. */ 'CurrencyCode'?: string; /** * The monetary value. */ 'Amount'?: number; } //#endregion //#region src/api-model/models/offer-customer-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates whether the offer is a B2B or B2C offer */ export declare const OfferCustomerType: { readonly B2C: "B2C"; readonly B2B: "B2B"; }; export type OfferCustomerType = typeof OfferCustomerType[keyof typeof OfferCustomerType]; //#endregion //#region src/api-model/models/points.d.ts /** * The number of Amazon Points offered with the purchase of an item, and their monetary value. */ export interface Points { /** * The number of points. */ 'PointsNumber'?: number; 'PointsMonetaryValue'?: MoneyType; } //#endregion //#region src/api-model/models/prime-information-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Amazon Prime information. */ export interface PrimeInformationType { /** * Indicates whether the offer is an Amazon Prime offer. */ 'IsPrime': boolean; /** * Indicates whether the offer is an Amazon Prime offer throughout the entire marketplace where it is listed. */ 'IsNationalPrime': boolean; } //#endregion //#region src/api-model/models/quantity-discount-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates the type of quantity discount this price applies to. */ export declare const QuantityDiscountType: { readonly QuantityDiscount: "QUANTITY_DISCOUNT"; }; export type QuantityDiscountType = typeof QuantityDiscountType[keyof typeof QuantityDiscountType]; //#endregion //#region src/api-model/models/quantity-discount-price-type.d.ts /** * Contains pricing information that includes special pricing when buying in bulk. */ export interface QuantityDiscountPriceType { /** * Indicates at what quantity this price becomes active. */ 'quantityTier': number; 'quantityDiscountType': QuantityDiscountType; 'listingPrice': MoneyType; } //#endregion //#region src/api-model/models/seller-feedback-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Information about the seller\'s feedback, including the percentage of positive feedback, and the total number of ratings received. */ export interface SellerFeedbackType { /** * The percentage of positive feedback for the seller in the past 365 days. */ 'SellerPositiveFeedbackRating'?: number; /** * The number of ratings received about the seller. */ 'FeedbackCount': number; } //#endregion //#region src/api-model/models/ships-from-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The state and country from where the item is shipped. */ export interface ShipsFromType { /** * The state from where the item is shipped. */ 'State'?: string; /** * The country from where the item is shipped. */ 'Country'?: string; } //#endregion //#region src/api-model/models/offer-detail.d.ts /** * Schema for an individual offer. Object in `OfferDetailList`. */ export interface OfferDetail { /** * When true, this is the seller\'s offer. */ 'MyOffer'?: boolean; 'offerType'?: OfferCustomerType; /** * The subcondition of the item. Subcondition values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. */ 'SubCondition': string; /** * The seller identifier for the offer. */ 'SellerId'?: string; /** * Information about the condition of the item. */ 'ConditionNotes'?: string; 'SellerFeedbackRating'?: SellerFeedbackType; 'ShippingTime': DetailedShippingTimeType; 'ListingPrice': MoneyType; /** * List of `QuantityDiscountPrice` that contains item\'s pricing information when buy in bulk. */ 'quantityDiscountPrices'?: Array; 'Points'?: Points; 'Shipping': MoneyType; 'ShipsFrom'?: ShipsFromType; /** * When true, the offer is fulfilled by Amazon. */ 'IsFulfilledByAmazon': boolean; 'PrimeInformation'?: PrimeInformationType; /** * When true, the offer is currently in the Buy Box. There can be up to two Buy Box winners at any time per ASIN, one that is eligible for Prime and one that is not eligible for Prime. */ 'IsBuyBoxWinner'?: boolean; /** * When true, the seller of the item is eligible to win the Buy Box. */ 'IsFeaturedMerchant'?: boolean; } //#endregion //#region src/api-model/models/buy-box-price-type.d.ts /** * Schema for an individual buybox price. */ export interface BuyBoxPriceType { /** * Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. */ 'condition': string; 'offerType'?: OfferCustomerType; /** * Indicates at what quantity this price becomes active. */ 'quantityTier'?: number; 'quantityDiscountType'?: QuantityDiscountType; 'LandedPrice': MoneyType; 'ListingPrice': MoneyType; 'Shipping': MoneyType; 'Points'?: Points; /** * The seller identifier for the offer. */ 'sellerId'?: string; } //#endregion //#region src/api-model/models/lowest-price-type.d.ts /** * Schema for an individual lowest price. */ export interface LowestPriceType { /** * Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. */ 'condition': string; /** * Indicates whether the item is fulfilled by Amazon or by the seller. */ 'fulfillmentChannel': string; 'offerType'?: OfferCustomerType; /** * Indicates at what quantity this price becomes active. */ 'quantityTier'?: number; 'quantityDiscountType'?: QuantityDiscountType; 'LandedPrice'?: MoneyType; 'ListingPrice': MoneyType; 'Shipping'?: MoneyType; 'Points'?: Points; } //#endregion //#region src/api-model/models/fulfillment-channel-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Indicates whether the item is fulfilled by Amazon or by the seller (merchant). */ export declare const FulfillmentChannelType: { readonly Amazon: "Amazon"; readonly Merchant: "Merchant"; }; export type FulfillmentChannelType = typeof FulfillmentChannelType[keyof typeof FulfillmentChannelType]; //#endregion //#region src/api-model/models/offer-count-type.d.ts /** * The total number of offers for the specified condition and fulfillment channel. */ export interface OfferCountType { /** * Indicates the condition of the item. For example: New, Used, Collectible, Refurbished, or Club. */ 'condition'?: string; 'fulfillmentChannel'?: FulfillmentChannelType; /** * The number of offers in a fulfillment channel that meet a specific condition. */ 'OfferCount'?: number; } //#endregion //#region src/api-model/models/sales-rank-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Sales rank information for the item, by category */ export interface SalesRankType { /** * Identifies the item category from which the sales rank is taken. */ 'ProductCategoryId': string; /** * The sales rank of the item within the item category. */ 'Rank': number; } //#endregion //#region src/api-model/models/summary.d.ts /** * Contains price information about the product, including the LowestPrices and BuyBoxPrices, the ListPrice, the SuggestedLowerPricePlusShipping, and NumberOfOffers and NumberOfBuyBoxEligibleOffers. */ export interface Summary { /** * The number of unique offers contained in NumberOfOffers. */ 'TotalOfferCount': number; /** * A list that contains the total number of offers information for given conditions and fulfillment channels. */ 'NumberOfOffers'?: Array; /** * A list of the lowest prices. */ 'LowestPrices'?: Array; /** * A list of the Buy Box prices. */ 'BuyBoxPrices'?: Array; 'ListPrice'?: MoneyType; 'CompetitivePriceThreshold'?: MoneyType; 'SuggestedLowerPricePlusShipping'?: MoneyType; /** * A list of sales rank information for the item, by category. */ 'SalesRankings'?: Array; /** * A list that contains the total number of offers that are eligible for the Buy Box for the given conditions and fulfillment channels. */ 'BuyBoxEligibleOffers'?: Array; /** * When the status is ActiveButTooSoonForProcessing, this is the time when the offers will be available for processing. */ 'OffersAvailableTime'?: string; } //#endregion //#region src/api-model/models/get-offers-result.d.ts /** * The payload for the getListingOffers and getItemOffers operations. */ export interface GetOffersResult { /** * A marketplace identifier. */ 'marketplaceId': string; /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN'?: string; /** * The stock keeping unit (SKU) of the item. */ 'SKU'?: string; 'ItemCondition': ConditionType; /** * The status of the operation. */ 'status': string; 'Identifier': ItemIdentifier; 'Summary': Summary; /** * A list of offer details. The list is the same length as the TotalOfferCount in the Summary or 20, whichever is less. */ 'Offers': Array; } //#endregion //#region src/api-model/models/get-offers-response.d.ts /** * The response schema for the `getListingOffers` and `getItemOffers` operations. */ export interface GetOffersResponse { 'payload'?: GetOffersResult; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } //#endregion //#region src/api-model/models/http-response-headers.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * A mapping of additional HTTP headers to send/receive for the individual batch request. */ export interface HttpResponseHeaders { [key: string]: string | any; /** * The timestamp that the API request was received. For more information, consult [RFC 2616 Section 14](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). */ 'Date'?: string; /** * Unique request reference identifier. */ 'x-amzn-RequestId'?: string; } //#endregion //#region src/api-model/models/batch-offers-response.d.ts /** * Common schema that present in `ItemOffersResponse` and `ListingOffersResponse` */ export interface BatchOffersResponse { 'headers'?: HttpResponseHeaders; 'status'?: GetOffersHttpStatusLine; 'body': GetOffersResponse; } //#endregion //#region src/api-model/models/http-method.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The HTTP method associated with the individual APIs being called as part of the batch request. */ export declare const HttpMethod: { readonly Get: "GET"; readonly Put: "PUT"; readonly Patch: "PATCH"; readonly Delete: "DELETE"; readonly Post: "POST"; }; export type HttpMethod = typeof HttpMethod[keyof typeof HttpMethod]; //#endregion //#region src/api-model/models/batch-request.d.ts /** * Common properties of batch requests against individual APIs. */ export interface BatchRequest { /** * The resource path of the operation you are calling in batch without any query parameters. If you are calling `getItemOffersBatch`, supply the path of `getItemOffers`. **Example:** `/products/pricing/v0/items/B000P6Q7MY/offers` If you are calling `getListingOffersBatch`, supply the path of `getListingOffers`. **Example:** `/products/pricing/v0/listings/B000P6Q7MY/offers` */ 'uri': string; 'method': HttpMethod; /** * A mapping of additional HTTP headers to send/receive for the individual batch request. */ 'headers'?: { [key: string]: string; }; } //#endregion //#region src/api-model/models/price-type.d.ts /** * Schema for item\'s price information, including listing price, shipping price, and Amazon points. */ export interface PriceType { 'LandedPrice'?: MoneyType; 'ListingPrice': MoneyType; 'Shipping'?: MoneyType; 'Points'?: Points; } //#endregion //#region src/api-model/models/competitive-price-type.d.ts /** * Schema for competitive pricing information */ export interface CompetitivePriceType { /** * The pricing model for each price that is returned. Possible values: * 1 - New Buy Box Price. * 2 - Used Buy Box Price. */ 'CompetitivePriceId': string; 'Price': PriceType; /** * Indicates the condition of the item whose pricing information is returned. Possible values are: New, Used, Collectible, Refurbished, or Club. */ 'condition'?: string; /** * Indicates the subcondition of the item whose pricing information is returned. Possible values are: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. */ 'subcondition'?: string; 'offerType'?: OfferCustomerType; /** * Indicates at what quantity this price becomes active. */ 'quantityTier'?: number; 'quantityDiscountType'?: QuantityDiscountType; /** * The seller identifier for the offer. */ 'sellerId'?: string; /** * Indicates whether or not the pricing information is for an offer listing that belongs to the requester. The requester is the seller associated with the SellerId that was submitted with the request. Possible values are: true and false. */ 'belongsToRequester'?: boolean; } //#endregion //#region src/api-model/models/offer-listing-count-type.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * The number of offer listings with the specified condition. */ export interface OfferListingCountType { /** * The number of offer listings. */ 'Count': number; /** * The condition of the item. */ 'condition': string; } //#endregion //#region src/api-model/models/competitive-pricing-type.d.ts /** * Competitive pricing information for the item. */ export interface CompetitivePricingType { /** * A list of competitive pricing information. */ 'CompetitivePrices': Array; /** * The number of active offer listings for the item that was submitted. The listing count is returned by condition, one for each listing condition value that is returned. */ 'NumberOfOfferListings': Array; 'TradeInValue'?: MoneyType; } //#endregion //#region src/api-model/models/errors.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * A list of error responses returned when a request is unsuccessful. */ export interface Errors { /** * A list of error responses returned when a request is unsuccessful. */ 'errors': Array; } //#endregion //#region src/api-model/models/item-offers-request.d.ts /** * @type ItemOffersRequest * List of request parameters can be accepted by `ItemOffersRequests` operation */ export type ItemOffersRequest = BatchOffersRequestParams & BatchRequest; //#endregion //#region src/api-model/models/get-item-offers-batch-request.d.ts /** * The request associated with the `getItemOffersBatch` API call. */ export interface GetItemOffersBatchRequest { /** * A list of `getListingOffers` batched requests to run. */ 'requests'?: Array; } //#endregion //#region src/api-model/models/item-offers-request-params-all-of.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ export interface ItemOffersRequestParamsAllOf { /** * The Amazon Standard Identification Number (ASIN) of the item. This is the same Asin passed as a request parameter. */ 'Asin'?: string; } //#endregion //#region src/api-model/models/item-offers-request-params.d.ts /** * @type ItemOffersRequestParams * List of request parameters that can be accepted by `ItemOffersRequest` */ export type ItemOffersRequestParams = BatchOffersRequestParams & ItemOffersRequestParamsAllOf; //#endregion //#region src/api-model/models/item-offers-response-all-of.d.ts export interface ItemOffersResponseAllOf { 'request': ItemOffersRequestParams; } //#endregion //#region src/api-model/models/item-offers-response.d.ts /** * @type ItemOffersResponse * Schema for an individual `ItemOffersResponse` */ export type ItemOffersResponse = BatchOffersResponse & ItemOffersResponseAllOf; //#endregion //#region src/api-model/models/get-item-offers-batch-response.d.ts /** * The response associated with the `getItemOffersBatch` API call. */ export interface GetItemOffersBatchResponse { /** * A list of `getItemOffers` batched responses. */ 'responses'?: Array; } //#endregion //#region src/api-model/models/listing-offers-request.d.ts /** * @type ListingOffersRequest * List of request parameters that can be accepted by `ListingOffersRequest` operation */ export type ListingOffersRequest = BatchOffersRequestParams & BatchRequest; //#endregion //#region src/api-model/models/get-listing-offers-batch-request.d.ts /** * The request associated with the `getListingOffersBatch` API call. */ export interface GetListingOffersBatchRequest { /** * A list of `getListingOffers` batched requests to run. */ 'requests'?: Array; } //#endregion //#region src/api-model/models/listing-offers-request-params-all-of.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ export interface ListingOffersRequestParamsAllOf { /** * The seller stock keeping unit (SKU) of the item. This is the same SKU passed as a path parameter. */ 'SellerSKU': string; } //#endregion //#region src/api-model/models/listing-offers-request-params.d.ts /** * @type ListingOffersRequestParams * List of request parameters that can be accepted by `ListingOffersRequest` */ export type ListingOffersRequestParams = BatchOffersRequestParams & ListingOffersRequestParamsAllOf; //#endregion //#region src/api-model/models/listing-offers-response-all-of.d.ts export interface ListingOffersResponseAllOf { 'request'?: ListingOffersRequestParams; } //#endregion //#region src/api-model/models/listing-offers-response.d.ts /** * @type ListingOffersResponse * Schema for an individual `ListingOffersResponse` */ export type ListingOffersResponse = BatchOffersResponse & ListingOffersResponseAllOf; //#endregion //#region src/api-model/models/get-listing-offers-batch-response.d.ts /** * The response associated with the `getListingOffersBatch` API call. */ export interface GetListingOffersBatchResponse { /** * A list of `getListingOffers` batched responses. */ 'responses'?: Array; } //#endregion //#region src/api-model/models/seller-skuidentifier.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Schema to identify an item by MarketPlaceId, SellerId, and SellerSKU. */ export interface SellerSKUIdentifier { /** * A marketplace identifier. */ 'MarketplaceId': string; /** * The seller identifier submitted for the operation. */ 'SellerId': string; /** * The seller stock keeping unit (SKU) of the item. */ 'SellerSKU': string; } //#endregion //#region src/api-model/models/identifier-type.d.ts /** * Specifies the identifiers used to uniquely identify an item. */ export interface IdentifierType { 'MarketplaceASIN': ASINIdentifier; 'SKUIdentifier'?: SellerSKUIdentifier; } //#endregion //#region src/api-model/models/offer-type.d.ts /** * Schema for an individual offer. */ export interface OfferType { 'offerType'?: OfferCustomerType; 'BuyingPrice': PriceType; 'RegularPrice': MoneyType; 'businessPrice'?: MoneyType; /** * List of `QuantityDiscountPrice` that contains item\'s pricing information when buy in bulk. */ 'quantityDiscountPrices'?: Array; /** * The fulfillment channel for the offer listing. Possible values: * Amazon - Fulfilled by Amazon. * Merchant - Fulfilled by the seller. */ 'FulfillmentChannel': string; /** * The item condition for the offer listing. Possible values: New, Used, Collectible, Refurbished, or Club. */ 'ItemCondition': string; /** * The item subcondition for the offer listing. Possible values: New, Mint, Very Good, Good, Acceptable, Poor, Club, OEM, Warranty, Refurbished Warranty, Refurbished, Open Box, or Other. */ 'ItemSubCondition': string; /** * The seller stock keeping unit (SKU) of the item. */ 'SellerSKU': string; } //#endregion //#region src/api-model/models/product.d.ts /** * An item. */ export interface Product { 'Identifiers': IdentifierType; /** * A list of product attributes if they are applicable to the product that is returned. */ 'AttributeSets'?: Array; /** * A list that contains product variation information, if applicable. */ 'Relationships'?: Array; 'CompetitivePricing'?: CompetitivePricingType; /** * A list of sales rank information for the item, by category. */ 'SalesRankings'?: Array; /** * A list of offers. */ 'Offers'?: Array; } //#endregion //#region src/api-model/models/price.d.ts /** * Schema for price info in `getPricing` response */ export interface Price { /** * The status of the operation. */ 'status': string; /** * The seller stock keeping unit (SKU) of the item. */ 'SellerSKU'?: string; /** * The Amazon Standard Identification Number (ASIN) of the item. */ 'ASIN'?: string; 'Product'?: Product; } //#endregion //#region src/api-model/models/get-pricing-response.d.ts /** * The response schema for the `getPricing` and `getCompetitivePricing` operations. */ export interface GetPricingResponse { /** * The payload for the `getPricing` and `getCompetitivePricing` operations. */ 'payload'?: Array; /** * A list of error responses returned when a request is unsuccessful. */ 'errors'?: Array; } //#endregion //#region src/api-model/models/model-error.d.ts /** * Selling Partner API for Pricing * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer information for Amazon Marketplace products. * * The version of the OpenAPI document: v0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * Error response returned when the request is unsuccessful. */ export interface ModelError { /** * An error code that identifies the type of error that occurred. */ 'code': string; /** * A message that describes the error condition. */ 'message': string; /** * Additional details that can help the caller understand or fix the issue. */ 'details'?: string; } //#endregion //#region src/api-model/api/product-pricing-api.d.ts /** * ProductPricingApi - axios parameter creator */ export declare const ProductPricingApiAxiosParamCreator: (configuration?: Configuration) => { /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetCompetitivePricingItemTypeEnum} itemType 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. * @param {Array} [asins] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. * @param {Array} [skus] A list of up to twenty seller SKU values used to identify items in the given marketplace. * @param {GetCompetitivePricingCustomerTypeEnum} [customerType] Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompetitivePricing: (marketplaceId: string, itemType: GetCompetitivePricingItemTypeEnum, asins?: Array, skus?: Array, customerType?: GetCompetitivePricingCustomerTypeEnum, options?: RawAxiosRequestConfig) => Promise; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetItemOffersItemConditionEnum} itemCondition Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {GetItemOffersCustomerTypeEnum} [customerType] Indicates whether to request Consumer or Business offers. Default is Consumer. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffers: (marketplaceId: string, itemCondition: GetItemOffersItemConditionEnum, asin: string, customerType?: GetItemOffersCustomerTypeEnum, options?: RawAxiosRequestConfig) => Promise; /** * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetItemOffersBatchRequest} getItemOffersBatchRequestBody The request associated with the `getItemOffersBatch` API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffersBatch: (getItemOffersBatchRequestBody: GetItemOffersBatchRequest, options?: RawAxiosRequestConfig) => Promise; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetListingOffersItemConditionEnum} itemCondition Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. * @param {string} sellerSKU Identifies an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {GetListingOffersCustomerTypeEnum} [customerType] Indicates whether to request Consumer or Business offers. Default is Consumer. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffers: (marketplaceId: string, itemCondition: GetListingOffersItemConditionEnum, sellerSKU: string, customerType?: GetListingOffersCustomerTypeEnum, options?: RawAxiosRequestConfig) => Promise; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetListingOffersBatchRequest} getListingOffersBatchRequestBody The request associated with the `getListingOffersBatch` API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffersBatch: (getListingOffersBatchRequestBody: GetListingOffersBatchRequest, options?: RawAxiosRequestConfig) => Promise; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetPricingItemTypeEnum} itemType 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. * @param {Array} [asins] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. * @param {Array} [skus] A list of up to twenty seller SKU values used to identify items in the given marketplace. * @param {GetPricingItemConditionEnum} [itemCondition] Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. * @param {GetPricingOfferTypeEnum} [offerType] Indicates whether to request pricing information for the seller\'s B2C or B2B offers. Default is B2C. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPricing: (marketplaceId: string, itemType: GetPricingItemTypeEnum, asins?: Array, skus?: Array, itemCondition?: GetPricingItemConditionEnum, offerType?: GetPricingOfferTypeEnum, options?: RawAxiosRequestConfig) => Promise; }; /** * ProductPricingApi - functional programming interface */ export declare const ProductPricingApiFp: (configuration?: Configuration) => { /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetCompetitivePricingItemTypeEnum} itemType 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. * @param {Array} [asins] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. * @param {Array} [skus] A list of up to twenty seller SKU values used to identify items in the given marketplace. * @param {GetCompetitivePricingCustomerTypeEnum} [customerType] Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompetitivePricing(marketplaceId: string, itemType: GetCompetitivePricingItemTypeEnum, asins?: Array, skus?: Array, customerType?: GetCompetitivePricingCustomerTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetItemOffersItemConditionEnum} itemCondition Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item. * @param {GetItemOffersCustomerTypeEnum} [customerType] Indicates whether to request Consumer or Business offers. Default is Consumer. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffers(marketplaceId: string, itemCondition: GetItemOffersItemConditionEnum, asin: string, customerType?: GetItemOffersCustomerTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetItemOffersBatchRequest} getItemOffersBatchRequestBody The request associated with the `getItemOffersBatch` API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffersBatch(getItemOffersBatchRequestBody: GetItemOffersBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetListingOffersItemConditionEnum} itemCondition Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. * @param {string} sellerSKU Identifies an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. * @param {GetListingOffersCustomerTypeEnum} [customerType] Indicates whether to request Consumer or Business offers. Default is Consumer. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffers(marketplaceId: string, itemCondition: GetListingOffersItemConditionEnum, sellerSKU: string, customerType?: GetListingOffersCustomerTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {GetListingOffersBatchRequest} getListingOffersBatchRequestBody The request associated with the `getListingOffersBatch` API call. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffersBatch(getListingOffersBatchRequestBody: GetListingOffersBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} marketplaceId A marketplace identifier. Specifies the marketplace for which prices are returned. * @param {GetPricingItemTypeEnum} itemType 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. * @param {Array} [asins] A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. * @param {Array} [skus] A list of up to twenty seller SKU values used to identify items in the given marketplace. * @param {GetPricingItemConditionEnum} [itemCondition] Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. * @param {GetPricingOfferTypeEnum} [offerType] Indicates whether to request pricing information for the seller\'s B2C or B2B offers. Default is B2C. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPricing(marketplaceId: string, itemType: GetPricingItemTypeEnum, asins?: Array, skus?: Array, itemCondition?: GetPricingItemConditionEnum, offerType?: GetPricingOfferTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ProductPricingApi - factory interface */ export declare const ProductPricingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetCompetitivePricingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompetitivePricing(requestParameters: ProductPricingApiGetCompetitivePricingRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetItemOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffers(requestParameters: ProductPricingApiGetItemOffersRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetItemOffersBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffersBatch(requestParameters: ProductPricingApiGetItemOffersBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetListingOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffers(requestParameters: ProductPricingApiGetListingOffersRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetListingOffersBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffersBatch(requestParameters: ProductPricingApiGetListingOffersBatchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetPricingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPricing(requestParameters: ProductPricingApiGetPricingRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for getCompetitivePricing operation in ProductPricingApi. */ export interface ProductPricingApiGetCompetitivePricingRequest { /** * A marketplace identifier. Specifies the marketplace for which prices are returned. */ readonly marketplaceId: string; /** * 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. */ readonly itemType: GetCompetitivePricingItemTypeEnum; /** * A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. */ readonly asins?: Array; /** * A list of up to twenty seller SKU values used to identify items in the given marketplace. */ readonly skus?: Array; /** * Indicates whether to request pricing information from the point of view of Consumer or Business buyers. Default is Consumer. */ readonly customerType?: GetCompetitivePricingCustomerTypeEnum; } /** * Request parameters for getItemOffers operation in ProductPricingApi. */ export interface ProductPricingApiGetItemOffersRequest { /** * A marketplace identifier. Specifies the marketplace for which prices are returned. */ readonly marketplaceId: string; /** * Filters the offer listings to be considered based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. */ readonly itemCondition: GetItemOffersItemConditionEnum; /** * The Amazon Standard Identification Number (ASIN) of the item. */ readonly asin: string; /** * Indicates whether to request Consumer or Business offers. Default is Consumer. */ readonly customerType?: GetItemOffersCustomerTypeEnum; } /** * Request parameters for getItemOffersBatch operation in ProductPricingApi. */ export interface ProductPricingApiGetItemOffersBatchRequest { /** * The request associated with the `getItemOffersBatch` API call. */ readonly getItemOffersBatchRequestBody: GetItemOffersBatchRequest; } /** * Request parameters for getListingOffers operation in ProductPricingApi. */ export interface ProductPricingApiGetListingOffersRequest { /** * A marketplace identifier. Specifies the marketplace for which prices are returned. */ readonly marketplaceId: string; /** * Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. */ readonly itemCondition: GetListingOffersItemConditionEnum; /** * Identifies an item in the given marketplace. SellerSKU is qualified by the seller\'s SellerId, which is included with every operation that you submit. */ readonly sellerSKU: string; /** * Indicates whether to request Consumer or Business offers. Default is Consumer. */ readonly customerType?: GetListingOffersCustomerTypeEnum; } /** * Request parameters for getListingOffersBatch operation in ProductPricingApi. */ export interface ProductPricingApiGetListingOffersBatchRequest { /** * The request associated with the `getListingOffersBatch` API call. */ readonly getListingOffersBatchRequestBody: GetListingOffersBatchRequest; } /** * Request parameters for getPricing operation in ProductPricingApi. */ export interface ProductPricingApiGetPricingRequest { /** * A marketplace identifier. Specifies the marketplace for which prices are returned. */ readonly marketplaceId: string; /** * 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. */ readonly itemType: GetPricingItemTypeEnum; /** * A list of up to twenty Amazon Standard Identification Number (ASIN) values used to identify items in the given marketplace. */ readonly asins?: Array; /** * A list of up to twenty seller SKU values used to identify items in the given marketplace. */ readonly skus?: Array; /** * Filters the offer listings based on item condition. Possible values: New, Used, Collectible, Refurbished, Club. */ readonly itemCondition?: GetPricingItemConditionEnum; /** * Indicates whether to request pricing information for the seller\'s B2C or B2B offers. Default is B2C. */ readonly offerType?: GetPricingOfferTypeEnum; } /** * ProductPricingApi - object-oriented interface */ export declare class ProductPricingApi extends BaseAPI { /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetCompetitivePricingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCompetitivePricing(requestParameters: ProductPricingApiGetCompetitivePricingRequest, options?: RawAxiosRequestConfig): Promise>; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetItemOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffers(requestParameters: ProductPricingApiGetItemOffersRequest, options?: RawAxiosRequestConfig): Promise>; /** * 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetItemOffersBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getItemOffersBatch(requestParameters: ProductPricingApiGetItemOffersBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetListingOffersRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffers(requestParameters: ProductPricingApiGetListingOffersRequest, options?: RawAxiosRequestConfig): Promise>; /** * 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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetListingOffersBatchRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingOffersBatch(requestParameters: ProductPricingApiGetListingOffersBatchRequest, options?: RawAxiosRequestConfig): Promise>; /** * 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](https://developer-docs.amazon.com/sp-api/docs/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](https://developer-docs.amazon/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ProductPricingApiGetPricingRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getPricing(requestParameters: ProductPricingApiGetPricingRequest, options?: RawAxiosRequestConfig): Promise>; } export declare const GetCompetitivePricingItemTypeEnum: { readonly Asin: "Asin"; readonly Sku: "Sku"; }; export type GetCompetitivePricingItemTypeEnum = typeof GetCompetitivePricingItemTypeEnum[keyof typeof GetCompetitivePricingItemTypeEnum]; export declare const GetCompetitivePricingCustomerTypeEnum: { readonly Consumer: "Consumer"; readonly Business: "Business"; }; export type GetCompetitivePricingCustomerTypeEnum = typeof GetCompetitivePricingCustomerTypeEnum[keyof typeof GetCompetitivePricingCustomerTypeEnum]; export declare const GetItemOffersItemConditionEnum: { readonly New: "New"; readonly Used: "Used"; readonly Collectible: "Collectible"; readonly Refurbished: "Refurbished"; readonly Club: "Club"; }; export type GetItemOffersItemConditionEnum = typeof GetItemOffersItemConditionEnum[keyof typeof GetItemOffersItemConditionEnum]; export declare const GetItemOffersCustomerTypeEnum: { readonly Consumer: "Consumer"; readonly Business: "Business"; }; export type GetItemOffersCustomerTypeEnum = typeof GetItemOffersCustomerTypeEnum[keyof typeof GetItemOffersCustomerTypeEnum]; export declare const GetListingOffersItemConditionEnum: { readonly New: "New"; readonly Used: "Used"; readonly Collectible: "Collectible"; readonly Refurbished: "Refurbished"; readonly Club: "Club"; }; export type GetListingOffersItemConditionEnum = typeof GetListingOffersItemConditionEnum[keyof typeof GetListingOffersItemConditionEnum]; export declare const GetListingOffersCustomerTypeEnum: { readonly Consumer: "Consumer"; readonly Business: "Business"; }; export type GetListingOffersCustomerTypeEnum = typeof GetListingOffersCustomerTypeEnum[keyof typeof GetListingOffersCustomerTypeEnum]; export declare const GetPricingItemTypeEnum: { readonly Asin: "Asin"; readonly Sku: "Sku"; }; export type GetPricingItemTypeEnum = typeof GetPricingItemTypeEnum[keyof typeof GetPricingItemTypeEnum]; export declare const GetPricingItemConditionEnum: { readonly New: "New"; readonly Used: "Used"; readonly Collectible: "Collectible"; readonly Refurbished: "Refurbished"; readonly Club: "Club"; }; export type GetPricingItemConditionEnum = typeof GetPricingItemConditionEnum[keyof typeof GetPricingItemConditionEnum]; export declare const GetPricingOfferTypeEnum: { readonly B2C: "B2C"; readonly B2B: "B2B"; }; export type GetPricingOfferTypeEnum = typeof GetPricingOfferTypeEnum[keyof typeof GetPricingOfferTypeEnum]; //#endregion //#region src/client.d.ts export declare const clientRateLimits: RateLimit[]; export declare class ProductPricingApiClient extends ProductPricingApi { constructor(configuration: ClientConfiguration); } //#endregion //# sourceMappingURL=index.d.ts.map