/** * Selling Partner API for Listings Items * The Selling Partner API for Listings Items (Listings Items API) provides programmatic access to selling partner listings on Amazon. Use this API in collaboration with the Selling Partner API for Product Type Definitions, which you use to retrieve the information about Amazon product types needed to use the Listings Items API. For more information, see the [Listings Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-use-case-guide). * * The version of the OpenAPI document: 2021-08-01 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import { Configuration } from './configuration'; import { AxiosPromise, AxiosInstance } from 'axios'; import { RequestArgs, BaseAPI } from './base'; /** * Buyer segment or program this offer is applicable to. * @export * @interface Audience */ export interface Audience { /** * Name of the audience an offer is applicable to. Common values: * \'ALL\' - Standard offer audience for buyers on Amazon retail websites. * \'B2B\' - Offer audience for Amazon Business website buyers. * @type {string} * @memberof Audience */ value?: string; /** * Localized display name for the audience. * @type {string} * @memberof Audience */ displayName?: string; } /** * A list of error responses returned when a request is unsuccessful. * @export * @interface ErrorList */ export interface ErrorList { /** * * @type {Array} * @memberof ErrorList */ errors: Array; } /** * The fulfillment availability details for the listings item. * @export * @interface FulfillmentAvailability */ export interface FulfillmentAvailability { /** * The code of the fulfillment network that will be used. * @type {string} * @memberof FulfillmentAvailability */ fulfillmentChannelCode: string; /** * The quantity of the item you are making available for sale. * @type {number} * @memberof FulfillmentAvailability */ quantity?: number; } /** * An issue with a listings item. * @export * @interface Issue */ export interface Issue { /** * An issue code that identifies the type of issue. * @type {string} * @memberof Issue */ code: string; /** * A message that describes the issue. * @type {string} * @memberof Issue */ message: string; /** * The severity of the issue. * @type {string} * @memberof Issue */ severity: IssueSeverityEnum | 'ERROR' | 'WARNING' | 'INFO'; /** * The names of the attributes associated with the issue, if applicable. * @type {Array} * @memberof Issue */ attributeNames?: Array; /** * List of issue categories. Possible vales: * `INVALID_ATTRIBUTE` - Indicating an invalid attribute in the listing. * `MISSING_ATTRIBUTE` - Highlighting a missing attribute in the listing. * `INVALID_IMAGE` - Signifying an invalid image in the listing. * `MISSING_IMAGE` - Noting the absence of an image in the listing. * `INVALID_PRICE` - Pertaining to issues with the listing\'s price-related attributes. * `MISSING_PRICE` - Pointing out the absence of a price attribute in the listing. * `DUPLICATE` - Identifying listings with potential duplicate problems, such as this ASIN potentially being a duplicate of another ASIN. * `QUALIFICATION_REQUIRED` - Indicating that the listing requires qualification-related approval. * @type {Array} * @memberof Issue */ categories: Array; /** * * @type {IssueEnforcements} * @memberof Issue */ enforcements?: IssueEnforcements; } /** * @export * @enum {string} */ export declare enum IssueSeverityEnum { Error = "ERROR", Warning = "WARNING", Info = "INFO" } /** * The enforcement action taken by Amazon that affect the publishing or status of a listing * @export * @interface IssueEnforcementAction */ export interface IssueEnforcementAction { /** * The enforcement action name. Possible values: * `LISTING_SUPPRESSED` - This enforcement takes down the current listing item\'s buyability. * `ATTRIBUTE_SUPPRESSED` - An attribute\'s value on the listing item is invalid, which causes it to be rejected by Amazon. * `CATALOG_ITEM_REMOVED` - This catalog item is inactive on Amazon, and all offers against it in the applicable marketplace are non-buyable. * `SEARCH_SUPPRESSED` - This value indicates that the catalog item is hidden from search results. * @type {string} * @memberof IssueEnforcementAction */ action: string; } /** * This field provides information about the enforcement actions taken by Amazon that affect the publishing or status of a listing. It also includes details about any associated exemptions. * @export * @interface IssueEnforcements */ export interface IssueEnforcements { /** * List of enforcement actions taken by Amazon that affect the publishing or status of a listing. * @type {Array} * @memberof IssueEnforcements */ actions: Array; /** * * @type {IssueExemption} * @memberof IssueEnforcements */ exemption: IssueExemption; } /** * Conveying the status of the listed enforcement actions and, if applicable, provides information about the exemption\'s expiry date. * @export * @interface IssueExemption */ export interface IssueExemption { /** * This field indicates the current exemption status for the listed enforcement actions. It can take values such as `EXEMPT`, signifying permanent exemption, `EXEMPT_UNTIL_EXPIRY_DATE` indicating temporary exemption until a specified date, or `NOT_EXEMPT` signifying no exemptions, and enforcement actions were already applied. * @type {string} * @memberof IssueExemption */ status: IssueExemptionStatusEnum | 'EXEMPT' | 'EXEMPT_UNTIL_EXPIRY_DATE' | 'NOT_EXEMPT'; /** * This field represents the timestamp, following the ISO 8601 format, which specifies the date when temporary exemptions, if applicable, will expire, and Amazon will begin enforcing the listed actions. * @type {string} * @memberof IssueExemption */ expiryDate?: string; } /** * @export * @enum {string} */ export declare enum IssueExemptionStatusEnum { Exempt = "EXEMPT", ExemptUntilExpiryDate = "EXEMPT_UNTIL_EXPIRY_DATE", NotExempt = "NOT_EXEMPT" } /** * A listings item. * @export * @interface Item */ export interface Item { /** * A selling partner provided identifier for an Amazon listing. * @type {string} * @memberof Item */ sku: string; /** * Summary details of a listings item. * @type {Array} * @memberof Item */ summaries?: Array; /** * A JSON object containing structured listings item attribute data keyed by attribute name. * @type {object} * @memberof Item */ attributes?: object; /** * The issues associated with the listings item. * @type {Array} * @memberof Item */ issues?: Array; /** * Offer details for the listings item. * @type {Array} * @memberof Item */ offers?: Array; /** * The fulfillment availability for the listings item. * @type {Array} * @memberof Item */ fulfillmentAvailability?: Array; /** * The vendor procurement information for the listings item. * @type {Array} * @memberof Item */ procurement?: Array; /** * Relationships for a listing item, by marketplace (for example, variations). * @type {Array} * @memberof Item */ relationships?: Array; /** * Product types for a listing item, by marketplace. * @type {Array} * @memberof Item */ productTypes?: Array; } /** * Identity attributes associated with the item in the Amazon catalog for the indicated Amazon marketplace. * @export * @interface ItemIdentifiersByMarketplace */ export interface ItemIdentifiersByMarketplace { /** * A marketplace identifier. Identifies the Amazon marketplace for the listings item. * @type {string} * @memberof ItemIdentifiersByMarketplace */ marketplaceId?: string; /** * Amazon Standard Identification Number (ASIN) of the listings item. * @type {string} * @memberof ItemIdentifiersByMarketplace */ asin?: string; } /** * The image for the listings item. * @export * @interface ItemImage */ export interface ItemImage { /** * The link, or URL, to the image. * @type {string} * @memberof ItemImage */ link: string; /** * The height of the image in pixels. * @type {number} * @memberof ItemImage */ height: number; /** * The width of the image in pixels. * @type {number} * @memberof ItemImage */ width: number; } /** * Offer details of a listings item for an Amazon marketplace. * @export * @interface ItemOfferByMarketplace */ export interface ItemOfferByMarketplace { /** * The Amazon marketplace identifier. * @type {string} * @memberof ItemOfferByMarketplace */ marketplaceId: string; /** * Type of offer for the listings item. * @type {string} * @memberof ItemOfferByMarketplace */ offerType: ItemOfferByMarketplaceOfferTypeEnum | 'B2C' | 'B2B'; /** * * @type {Money} * @memberof ItemOfferByMarketplace */ price: Money; /** * * @type {Points} * @memberof ItemOfferByMarketplace */ points?: Points; /** * * @type {Audience} * @memberof ItemOfferByMarketplace */ audience?: Audience; } /** * @export * @enum {string} */ export declare enum ItemOfferByMarketplaceOfferTypeEnum { B2C = "B2C", B2B = "B2B" } /** * The vendor procurement information for the listings item. * @export * @interface ItemProcurement */ export interface ItemProcurement { /** * * @type {Money} * @memberof ItemProcurement */ costPrice: Money; } /** * Product types that are associated with the listing item for the specified marketplace. * @export * @interface ItemProductTypeByMarketplace */ export interface ItemProductTypeByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemProductTypeByMarketplace */ marketplaceId: string; /** * The name of the product type that is submitted by the Selling Partner. * @type {string} * @memberof ItemProductTypeByMarketplace */ productType: string; } /** * the relationship details for a listing item. * @export * @interface ItemRelationship */ export interface ItemRelationship { /** * Identifiers (SKUs) of the related items that are children of this listing item. * @type {Array} * @memberof ItemRelationship */ childSkus?: Array; /** * Identifiers (SKUs) of the related items that are parents of this listing item. * @type {Array} * @memberof ItemRelationship */ parentSkus?: Array; /** * * @type {ItemVariationTheme} * @memberof ItemRelationship */ variationTheme?: ItemVariationTheme; /** * The type of relationship. * @type {string} * @memberof ItemRelationship */ type: ItemRelationshipTypeEnum | 'VARIATION' | 'PACKAGE_HIERARCHY'; } /** * @export * @enum {string} */ export declare enum ItemRelationshipTypeEnum { Variation = "VARIATION", PackageHierarchy = "PACKAGE_HIERARCHY" } /** * Relationship details for the listing item in the specified marketplace. * @export * @interface ItemRelationshipsByMarketplace */ export interface ItemRelationshipsByMarketplace { /** * Amazon marketplace identifier. * @type {string} * @memberof ItemRelationshipsByMarketplace */ marketplaceId: string; /** * Relationships for the listing item. * @type {Array} * @memberof ItemRelationshipsByMarketplace */ relationships: Array; } /** * Selling partner listings items and search related metadata. * @export * @interface ItemSearchResults */ export interface ItemSearchResults { /** * The total number of selling partner listings items found for the search criteria (only results up to the page count limit will be returned per request regardless of the number found). Note: The maximum number of items (SKUs) that can be returned and paged through is 1000. * @type {number} * @memberof ItemSearchResults */ numberOfResults: number; /** * * @type {Pagination} * @memberof ItemSearchResults */ pagination?: Pagination; /** * A list of listings items. * @type {Array} * @memberof ItemSearchResults */ items: Array; } /** * Summary details of a listings item for an Amazon marketplace. * @export * @interface ItemSummaryByMarketplace */ export interface ItemSummaryByMarketplace { /** * A marketplace identifier. Identifies the Amazon marketplace for the listings item. * @type {string} * @memberof ItemSummaryByMarketplace */ marketplaceId: string; /** * Amazon Standard Identification Number (ASIN) of the listings item. * @type {string} * @memberof ItemSummaryByMarketplace */ asin?: string; /** * The Amazon product type of the listings item. * @type {string} * @memberof ItemSummaryByMarketplace */ productType: string; /** * Identifies the condition of the listings item. * @type {string} * @memberof ItemSummaryByMarketplace */ conditionType?: ItemSummaryByMarketplaceConditionTypeEnum | 'new_new' | 'new_open_box' | 'new_oem' | 'refurbished_refurbished' | 'used_like_new' | 'used_very_good' | 'used_good' | 'used_acceptable' | 'collectible_like_new' | 'collectible_very_good' | 'collectible_good' | 'collectible_acceptable' | 'club_club'; /** * Statuses that apply to the listings item. * @type {Array} * @memberof ItemSummaryByMarketplace */ status: Array<(ItemSummaryByMarketplaceStatusEnum | 'BUYABLE' | 'DISCOVERABLE')>; /** * The fulfillment network stock keeping unit is an identifier used by Amazon fulfillment centers to identify each unique item. * @type {string} * @memberof ItemSummaryByMarketplace */ fnSku?: string; /** * The name or title associated with an Amazon catalog item. * @type {string} * @memberof ItemSummaryByMarketplace */ itemName?: string; /** * The date the listings item was created in ISO 8601 format. * @type {string} * @memberof ItemSummaryByMarketplace */ createdDate: string; /** * The date the listings item was last updated in ISO 8601 format. * @type {string} * @memberof ItemSummaryByMarketplace */ lastUpdatedDate: string; /** * * @type {ItemImage} * @memberof ItemSummaryByMarketplace */ mainImage?: ItemImage; } /** * @export * @enum {string} */ export declare enum ItemSummaryByMarketplaceConditionTypeEnum { NewNew = "new_new", NewOpenBox = "new_open_box", NewOem = "new_oem", RefurbishedRefurbished = "refurbished_refurbished", UsedLikeNew = "used_like_new", UsedVeryGood = "used_very_good", UsedGood = "used_good", UsedAcceptable = "used_acceptable", CollectibleLikeNew = "collectible_like_new", CollectibleVeryGood = "collectible_very_good", CollectibleGood = "collectible_good", CollectibleAcceptable = "collectible_acceptable", ClubClub = "club_club" } /** * @export * @enum {string} */ export declare enum ItemSummaryByMarketplaceStatusEnum { Buyable = "BUYABLE", Discoverable = "DISCOVERABLE" } /** * A variation theme that indicates the combination of listing item attributes that define the variation family. * @export * @interface ItemVariationTheme */ export interface ItemVariationTheme { /** * The names of the listing item attributes that are associated with the variation theme. * @type {Array} * @memberof ItemVariationTheme */ attributes: Array; /** * The variation theme that indicates the combination of listing item attributes that define the variation family. * @type {string} * @memberof ItemVariationTheme */ theme: string; } /** * The request body schema for the `patchListingsItem` operation. * @export * @interface ListingsItemPatchRequest */ export interface ListingsItemPatchRequest { /** * The Amazon product type of the listings item. * @type {string} * @memberof ListingsItemPatchRequest */ productType: string; /** * One or more JSON Patch operations to perform on the listings item. * @type {Array} * @memberof ListingsItemPatchRequest */ patches: Array; } /** * The request body schema for the `putListingsItem` operation. * @export * @interface ListingsItemPutRequest */ export interface ListingsItemPutRequest { /** * The Amazon product type of the listings item. * @type {string} * @memberof ListingsItemPutRequest */ productType: string; /** * The name of the requirements set for the provided data. * @type {string} * @memberof ListingsItemPutRequest */ requirements?: ListingsItemPutRequestRequirementsEnum | 'LISTING' | 'LISTING_PRODUCT_ONLY' | 'LISTING_OFFER_ONLY'; /** * A JSON object containing structured listings item attribute data keyed by attribute name. * @type {object} * @memberof ListingsItemPutRequest */ attributes: object; } /** * @export * @enum {string} */ export declare enum ListingsItemPutRequestRequirementsEnum { Listing = "LISTING", ListingProductOnly = "LISTING_PRODUCT_ONLY", ListingOfferOnly = "LISTING_OFFER_ONLY" } /** * Response containing the results of a submission to the Selling Partner API for Listings Items. * @export * @interface ListingsItemSubmissionResponse */ export interface ListingsItemSubmissionResponse { /** * A selling partner provided identifier for an Amazon listing. * @type {string} * @memberof ListingsItemSubmissionResponse */ sku: string; /** * The status of the listings item submission. * @type {string} * @memberof ListingsItemSubmissionResponse */ status: ListingsItemSubmissionResponseStatusEnum | 'ACCEPTED' | 'INVALID' | 'VALID'; /** * The unique identifier of the listings item submission. * @type {string} * @memberof ListingsItemSubmissionResponse */ submissionId: string; /** * Listings item issues related to the listings item submission. * @type {Array} * @memberof ListingsItemSubmissionResponse */ issues?: Array; /** * Identity attributes associated with the item in the Amazon catalog, such as the ASIN. * @type {Array} * @memberof ListingsItemSubmissionResponse */ identifiers?: Array; } /** * @export * @enum {string} */ export declare enum ListingsItemSubmissionResponseStatusEnum { Accepted = "ACCEPTED", Invalid = "INVALID", Valid = "VALID" } /** * Error response returned when the request is unsuccessful. * @export * @interface ModelError */ export interface ModelError { /** * An error code that identifies the type of error that occurred. * @type {string} * @memberof ModelError */ code: string; /** * A message that describes the error condition. * @type {string} * @memberof ModelError */ message: string; /** * Additional details that can help the caller understand or fix the issue. * @type {string} * @memberof ModelError */ details?: string; } /** * The currency type and amount. * @export * @interface Money */ export interface Money { /** * Three-digit currency code in ISO 4217 format. * @type {string} * @memberof Money */ currencyCode: string; /** * A decimal number with no loss of precision. Useful when precision loss is unnaceptable, as with currencies. Follows RFC7159 for number representation. * @type {string} * @memberof Money */ amount: string; } /** * When a request produces a response that exceeds the `pageSize`, pagination occurs. This means the response is divided into individual pages. To retrieve the next page or the previous page, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. When you receive the last page, there will be no `nextToken` key in the pagination object. * @export * @interface Pagination */ export interface Pagination { /** * A token that can be used to fetch the next page. * @type {string} * @memberof Pagination */ nextToken?: string; /** * A token that can be used to fetch the previous page. * @type {string} * @memberof Pagination */ previousToken?: string; } /** * Individual JSON Patch operation for an HTTP PATCH request. * @export * @interface PatchOperation */ export interface PatchOperation { /** * Type of JSON Patch operation. Supported JSON Patch operations include add, replace, and delete. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information. * @type {string} * @memberof PatchOperation */ op: PatchOperationOpEnum | 'add' | 'replace' | 'delete'; /** * JSON Pointer path of the element to patch. Refer to [JavaScript Object Notation (JSON) Patch](https://tools.ietf.org/html/rfc6902) for more information. * @type {string} * @memberof PatchOperation */ path: string; /** * JSON value to add, replace, or delete. * @type {Array} * @memberof PatchOperation */ value?: Array; } /** * @export * @enum {string} */ export declare enum PatchOperationOpEnum { Add = "add", Replace = "replace", Delete = "delete" } /** * The number of Amazon Points offered with the purchase of an item, and their monetary value. Note that the `Points` element is only returned in Japan (JP). * @export * @interface Points */ export interface Points { /** * * @type {number} * @memberof Points */ pointsNumber: number; } /** * ListingsApi - axios parameter creator * @export */ export declare const ListingsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteListingsItem: (sellerId: string, sku: string, marketplaceIds: Array, issueLocale?: string, options?: any) => Promise; /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingsItem: (sellerId: string, sku: string, marketplaceIds: Array, issueLocale?: string, includedData?: Array<"summaries" | "attributes" | "issues" | "offers" | "fulfillmentAvailability" | "procurement" | "relationships" | "productTypes">, options?: any) => Promise; /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {ListingsItemPatchRequest} body The request body schema for the `patchListingsItem` operation. * @param {Array<'identifiers' | 'issues'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `issues`. * @param {'VALIDATION_PREVIEW'} [mode] The mode of operation for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchListingsItem: (sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPatchRequest, includedData?: Array<"identifiers" | "issues">, mode?: "VALIDATION_PREVIEW", issueLocale?: string, options?: any) => Promise; /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {ListingsItemPutRequest} body The request body schema for the `putListingsItem` operation. * @param {Array<'identifiers' | 'issues'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `issues`. * @param {'VALIDATION_PREVIEW'} [mode] The mode of operation for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ putListingsItem: (sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPutRequest, includedData?: Array<"identifiers" | "issues">, mode?: "VALIDATION_PREVIEW", issueLocale?: string, options?: any) => Promise; /** * Search for and return a list of selling partner listings items and their respective details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". When a localization is not available in the specified locale, localized messages default to \"en_US\". * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} [includedData] A comma-delimited list of datasets that you want to include in the response. Default: `summaries`. * @param {Array} [identifiers] A comma-delimited list of product identifiers that you can use to search for listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use \'identifiers\' if you specify `variationParentSku` or `packageHierarchySku`. * @param {'ASIN' | 'EAN' | 'FNSKU' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] A type of product identifiers that you can use to search for listings items. **Note**: This is required when `identifiers` is provided. * @param {string} [variationParentSku] Filters results to include listing items that are variation children of the specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request. * @param {string} [packageHierarchySku] Filter results to include listing items that contain or are contained by the specified SKU. **Note**: You cannot use `packageHierarchySku` if you include `identifiers` or `variationParentSku` in your request. * @param {string} [createdAfter] A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [createdBefore] A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [lastUpdatedAfter] A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [lastUpdatedBefore] A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {Array<'WARNING' | 'ERROR'>} [withIssueSeverity] Filter results to include only listing items that have issues that match one or more of the specified severity levels. * @param {Array<'BUYABLE' | 'DISCOVERABLE'>} [withStatus] Filter results to include only listing items that have the specified status. * @param {Array<'BUYABLE' | 'DISCOVERABLE'>} [withoutStatus] Filter results to include only listing items that don\'t contain the specified statuses. * @param {'sku' | 'createdDate' | 'lastUpdatedDate'} [sortBy] An attribute by which to sort the returned listing items. * @param {'ASC' | 'DESC'} [sortOrder] The order in which to sort the result items. * @param {number} [pageSize] The number of results that you want to include on each page. * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchListingsItems: (sellerId: string, marketplaceIds: Array, issueLocale?: string, includedData?: Array<"summaries" | "attributes" | "issues" | "offers" | "fulfillmentAvailability" | "procurement" | "relationships" | "productTypes">, identifiers?: Array, identifiersType?: "ASIN" | "EAN" | "FNSKU" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC", variationParentSku?: string, packageHierarchySku?: string, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, withIssueSeverity?: Array<"WARNING" | "ERROR">, withStatus?: Array<"BUYABLE" | "DISCOVERABLE">, withoutStatus?: Array<"BUYABLE" | "DISCOVERABLE">, sortBy?: "sku" | "createdDate" | "lastUpdatedDate", sortOrder?: "ASC" | "DESC", pageSize?: number, pageToken?: string, options?: any) => Promise; }; /** * ListingsApi - functional programming interface * @export */ export declare const ListingsApiFp: (configuration?: Configuration) => { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteListingsItem(sellerId: string, sku: string, marketplaceIds: Array, issueLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingsItem(sellerId: string, sku: string, marketplaceIds: Array, issueLocale?: string, includedData?: Array<"summaries" | "attributes" | "issues" | "offers" | "fulfillmentAvailability" | "procurement" | "relationships" | "productTypes">, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {ListingsItemPatchRequest} body The request body schema for the `patchListingsItem` operation. * @param {Array<'identifiers' | 'issues'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `issues`. * @param {'VALIDATION_PREVIEW'} [mode] The mode of operation for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchListingsItem(sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPatchRequest, includedData?: Array<"identifiers" | "issues">, mode?: "VALIDATION_PREVIEW", issueLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {ListingsItemPutRequest} body The request body schema for the `putListingsItem` operation. * @param {Array<'identifiers' | 'issues'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `issues`. * @param {'VALIDATION_PREVIEW'} [mode] The mode of operation for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ putListingsItem(sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPutRequest, includedData?: Array<"identifiers" | "issues">, mode?: "VALIDATION_PREVIEW", issueLocale?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search for and return a list of selling partner listings items and their respective details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". When a localization is not available in the specified locale, localized messages default to \"en_US\". * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} [includedData] A comma-delimited list of datasets that you want to include in the response. Default: `summaries`. * @param {Array} [identifiers] A comma-delimited list of product identifiers that you can use to search for listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use \'identifiers\' if you specify `variationParentSku` or `packageHierarchySku`. * @param {'ASIN' | 'EAN' | 'FNSKU' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] A type of product identifiers that you can use to search for listings items. **Note**: This is required when `identifiers` is provided. * @param {string} [variationParentSku] Filters results to include listing items that are variation children of the specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request. * @param {string} [packageHierarchySku] Filter results to include listing items that contain or are contained by the specified SKU. **Note**: You cannot use `packageHierarchySku` if you include `identifiers` or `variationParentSku` in your request. * @param {string} [createdAfter] A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [createdBefore] A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [lastUpdatedAfter] A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [lastUpdatedBefore] A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {Array<'WARNING' | 'ERROR'>} [withIssueSeverity] Filter results to include only listing items that have issues that match one or more of the specified severity levels. * @param {Array<'BUYABLE' | 'DISCOVERABLE'>} [withStatus] Filter results to include only listing items that have the specified status. * @param {Array<'BUYABLE' | 'DISCOVERABLE'>} [withoutStatus] Filter results to include only listing items that don\'t contain the specified statuses. * @param {'sku' | 'createdDate' | 'lastUpdatedDate'} [sortBy] An attribute by which to sort the returned listing items. * @param {'ASC' | 'DESC'} [sortOrder] The order in which to sort the result items. * @param {number} [pageSize] The number of results that you want to include on each page. * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchListingsItems(sellerId: string, marketplaceIds: Array, issueLocale?: string, includedData?: Array<"summaries" | "attributes" | "issues" | "offers" | "fulfillmentAvailability" | "procurement" | "relationships" | "productTypes">, identifiers?: Array, identifiersType?: "ASIN" | "EAN" | "FNSKU" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC", variationParentSku?: string, packageHierarchySku?: string, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, withIssueSeverity?: Array<"WARNING" | "ERROR">, withStatus?: Array<"BUYABLE" | "DISCOVERABLE">, withoutStatus?: Array<"BUYABLE" | "DISCOVERABLE">, sortBy?: "sku" | "createdDate" | "lastUpdatedDate", sortOrder?: "ASC" | "DESC", pageSize?: number, pageToken?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ListingsApi - factory interface * @export */ export declare const ListingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteListingsItem(sellerId: string, sku: string, marketplaceIds: Array, issueLocale?: string, options?: any): AxiosPromise; /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getListingsItem(sellerId: string, sku: string, marketplaceIds: Array, issueLocale?: string, includedData?: Array<"summaries" | "attributes" | "issues" | "offers" | "fulfillmentAvailability" | "procurement" | "relationships" | "productTypes">, options?: any): AxiosPromise; /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {ListingsItemPatchRequest} body The request body schema for the `patchListingsItem` operation. * @param {Array<'identifiers' | 'issues'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `issues`. * @param {'VALIDATION_PREVIEW'} [mode] The mode of operation for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchListingsItem(sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPatchRequest, includedData?: Array<"identifiers" | "issues">, mode?: "VALIDATION_PREVIEW", issueLocale?: string, options?: any): AxiosPromise; /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {string} sku A selling partner provided identifier for an Amazon listing. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {ListingsItemPutRequest} body The request body schema for the `putListingsItem` operation. * @param {Array<'identifiers' | 'issues'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `issues`. * @param {'VALIDATION_PREVIEW'} [mode] The mode of operation for the request. * @param {string} [issueLocale] A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @param {*} [options] Override http request option. * @throws {RequiredError} */ putListingsItem(sellerId: string, sku: string, marketplaceIds: Array, body: ListingsItemPutRequest, includedData?: Array<"identifiers" | "issues">, mode?: "VALIDATION_PREVIEW", issueLocale?: string, options?: any): AxiosPromise; /** * Search for and return a list of selling partner listings items and their respective details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {string} sellerId A selling partner identifier, such as a merchant account or vendor code. * @param {Array} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request. * @param {string} [issueLocale] A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". When a localization is not available in the specified locale, localized messages default to \"en_US\". * @param {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} [includedData] A comma-delimited list of datasets that you want to include in the response. Default: `summaries`. * @param {Array} [identifiers] A comma-delimited list of product identifiers that you can use to search for listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use \'identifiers\' if you specify `variationParentSku` or `packageHierarchySku`. * @param {'ASIN' | 'EAN' | 'FNSKU' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] A type of product identifiers that you can use to search for listings items. **Note**: This is required when `identifiers` is provided. * @param {string} [variationParentSku] Filters results to include listing items that are variation children of the specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request. * @param {string} [packageHierarchySku] Filter results to include listing items that contain or are contained by the specified SKU. **Note**: You cannot use `packageHierarchySku` if you include `identifiers` or `variationParentSku` in your request. * @param {string} [createdAfter] A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [createdBefore] A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [lastUpdatedAfter] A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {string} [lastUpdatedBefore] A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @param {Array<'WARNING' | 'ERROR'>} [withIssueSeverity] Filter results to include only listing items that have issues that match one or more of the specified severity levels. * @param {Array<'BUYABLE' | 'DISCOVERABLE'>} [withStatus] Filter results to include only listing items that have the specified status. * @param {Array<'BUYABLE' | 'DISCOVERABLE'>} [withoutStatus] Filter results to include only listing items that don\'t contain the specified statuses. * @param {'sku' | 'createdDate' | 'lastUpdatedDate'} [sortBy] An attribute by which to sort the returned listing items. * @param {'ASC' | 'DESC'} [sortOrder] The order in which to sort the result items. * @param {number} [pageSize] The number of results that you want to include on each page. * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results. * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchListingsItems(sellerId: string, marketplaceIds: Array, issueLocale?: string, includedData?: Array<"summaries" | "attributes" | "issues" | "offers" | "fulfillmentAvailability" | "procurement" | "relationships" | "productTypes">, identifiers?: Array, identifiersType?: "ASIN" | "EAN" | "FNSKU" | "GTIN" | "ISBN" | "JAN" | "MINSAN" | "SKU" | "UPC", variationParentSku?: string, packageHierarchySku?: string, createdAfter?: string, createdBefore?: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, withIssueSeverity?: Array<"WARNING" | "ERROR">, withStatus?: Array<"BUYABLE" | "DISCOVERABLE">, withoutStatus?: Array<"BUYABLE" | "DISCOVERABLE">, sortBy?: "sku" | "createdDate" | "lastUpdatedDate", sortOrder?: "ASC" | "DESC", pageSize?: number, pageToken?: string, options?: any): AxiosPromise; }; /** * Request parameters for deleteListingsItem operation in ListingsApi. * @export * @interface ListingsApiDeleteListingsItemRequest */ export interface ListingsApiDeleteListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} * @memberof ListingsApiDeleteListingsItem */ readonly sellerId: string; /** * A selling partner provided identifier for an Amazon listing. * @type {string} * @memberof ListingsApiDeleteListingsItem */ readonly sku: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof ListingsApiDeleteListingsItem */ readonly marketplaceIds: Array; /** * A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @type {string} * @memberof ListingsApiDeleteListingsItem */ readonly issueLocale?: string; } /** * Request parameters for getListingsItem operation in ListingsApi. * @export * @interface ListingsApiGetListingsItemRequest */ export interface ListingsApiGetListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} * @memberof ListingsApiGetListingsItem */ readonly sellerId: string; /** * A selling partner provided identifier for an Amazon listing. * @type {string} * @memberof ListingsApiGetListingsItem */ readonly sku: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof ListingsApiGetListingsItem */ readonly marketplaceIds: Array; /** * A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @type {string} * @memberof ListingsApiGetListingsItem */ readonly issueLocale?: string; /** * A comma-delimited list of data sets to include in the response. Default: `summaries`. * @type {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} * @memberof ListingsApiGetListingsItem */ readonly includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>; } /** * Request parameters for patchListingsItem operation in ListingsApi. * @export * @interface ListingsApiPatchListingsItemRequest */ export interface ListingsApiPatchListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} * @memberof ListingsApiPatchListingsItem */ readonly sellerId: string; /** * A selling partner provided identifier for an Amazon listing. * @type {string} * @memberof ListingsApiPatchListingsItem */ readonly sku: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof ListingsApiPatchListingsItem */ readonly marketplaceIds: Array; /** * The request body schema for the `patchListingsItem` operation. * @type {ListingsItemPatchRequest} * @memberof ListingsApiPatchListingsItem */ readonly body: ListingsItemPatchRequest; /** * A comma-delimited list of data sets to include in the response. Default: `issues`. * @type {Array<'identifiers' | 'issues'>} * @memberof ListingsApiPatchListingsItem */ readonly includedData?: Array<'identifiers' | 'issues'>; /** * The mode of operation for the request. * @type {'VALIDATION_PREVIEW'} * @memberof ListingsApiPatchListingsItem */ readonly mode?: 'VALIDATION_PREVIEW'; /** * A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @type {string} * @memberof ListingsApiPatchListingsItem */ readonly issueLocale?: string; } /** * Request parameters for putListingsItem operation in ListingsApi. * @export * @interface ListingsApiPutListingsItemRequest */ export interface ListingsApiPutListingsItemRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} * @memberof ListingsApiPutListingsItem */ readonly sellerId: string; /** * A selling partner provided identifier for an Amazon listing. * @type {string} * @memberof ListingsApiPutListingsItem */ readonly sku: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof ListingsApiPutListingsItem */ readonly marketplaceIds: Array; /** * The request body schema for the `putListingsItem` operation. * @type {ListingsItemPutRequest} * @memberof ListingsApiPutListingsItem */ readonly body: ListingsItemPutRequest; /** * A comma-delimited list of data sets to include in the response. Default: `issues`. * @type {Array<'identifiers' | 'issues'>} * @memberof ListingsApiPutListingsItem */ readonly includedData?: Array<'identifiers' | 'issues'>; /** * The mode of operation for the request. * @type {'VALIDATION_PREVIEW'} * @memberof ListingsApiPutListingsItem */ readonly mode?: 'VALIDATION_PREVIEW'; /** * A locale for localization of issues. When not provided, the default language code of the first marketplace is used. Examples: `en_US`, `fr_CA`, `fr_FR`. Localized messages default to `en_US` when a localization is not available in the specified locale. * @type {string} * @memberof ListingsApiPutListingsItem */ readonly issueLocale?: string; } /** * Request parameters for searchListingsItems operation in ListingsApi. * @export * @interface ListingsApiSearchListingsItemsRequest */ export interface ListingsApiSearchListingsItemsRequest { /** * A selling partner identifier, such as a merchant account or vendor code. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly sellerId: string; /** * A comma-delimited list of Amazon marketplace identifiers for the request. * @type {Array} * @memberof ListingsApiSearchListingsItems */ readonly marketplaceIds: Array; /** * A locale that is used to localize issues. When not provided, the default language code of the first marketplace is used. Examples: \"en_US\", \"fr_CA\", \"fr_FR\". When a localization is not available in the specified locale, localized messages default to \"en_US\". * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly issueLocale?: string; /** * A comma-delimited list of datasets that you want to include in the response. Default: `summaries`. * @type {Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>} * @memberof ListingsApiSearchListingsItems */ readonly includedData?: Array<'summaries' | 'attributes' | 'issues' | 'offers' | 'fulfillmentAvailability' | 'procurement' | 'relationships' | 'productTypes'>; /** * A comma-delimited list of product identifiers that you can use to search for listings items. **Note**: 1. This is required when you specify `identifiersType`. 2. You cannot use \'identifiers\' if you specify `variationParentSku` or `packageHierarchySku`. * @type {Array} * @memberof ListingsApiSearchListingsItems */ readonly identifiers?: Array; /** * A type of product identifiers that you can use to search for listings items. **Note**: This is required when `identifiers` is provided. * @type {'ASIN' | 'EAN' | 'FNSKU' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} * @memberof ListingsApiSearchListingsItems */ readonly identifiersType?: 'ASIN' | 'EAN' | 'FNSKU' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'; /** * Filters results to include listing items that are variation children of the specified SKU. **Note**: You cannot use `variationParentSku` if you include `identifiers` or `packageHierarchySku` in your request. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly variationParentSku?: string; /** * Filter results to include listing items that contain or are contained by the specified SKU. **Note**: You cannot use `packageHierarchySku` if you include `identifiers` or `variationParentSku` in your request. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly packageHierarchySku?: string; /** * A date-time that is used to filter listing items. The response includes listings items that were created at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly createdAfter?: string; /** * A date-time that is used to filter listing items. The response includes listings items that were created at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly createdBefore?: string; /** * A date-time that is used to filter listing items. The response includes listings items that were last updated at or after this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly lastUpdatedAfter?: string; /** * A date-time that is used to filter listing items. The response includes listings items that were last updated at or before this time. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly lastUpdatedBefore?: string; /** * Filter results to include only listing items that have issues that match one or more of the specified severity levels. * @type {Array<'WARNING' | 'ERROR'>} * @memberof ListingsApiSearchListingsItems */ readonly withIssueSeverity?: Array<'WARNING' | 'ERROR'>; /** * Filter results to include only listing items that have the specified status. * @type {Array<'BUYABLE' | 'DISCOVERABLE'>} * @memberof ListingsApiSearchListingsItems */ readonly withStatus?: Array<'BUYABLE' | 'DISCOVERABLE'>; /** * Filter results to include only listing items that don\'t contain the specified statuses. * @type {Array<'BUYABLE' | 'DISCOVERABLE'>} * @memberof ListingsApiSearchListingsItems */ readonly withoutStatus?: Array<'BUYABLE' | 'DISCOVERABLE'>; /** * An attribute by which to sort the returned listing items. * @type {'sku' | 'createdDate' | 'lastUpdatedDate'} * @memberof ListingsApiSearchListingsItems */ readonly sortBy?: 'sku' | 'createdDate' | 'lastUpdatedDate'; /** * The order in which to sort the result items. * @type {'ASC' | 'DESC'} * @memberof ListingsApiSearchListingsItems */ readonly sortOrder?: 'ASC' | 'DESC'; /** * The number of results that you want to include on each page. * @type {number} * @memberof ListingsApiSearchListingsItems */ readonly pageSize?: number; /** * A token that you can use to fetch a specific page when there are multiple pages of results. * @type {string} * @memberof ListingsApiSearchListingsItems */ readonly pageToken?: string; } /** * ListingsApi - object-oriented interface * @export * @class ListingsApi * @extends {BaseAPI} */ export declare class ListingsApi extends BaseAPI { /** * Delete a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {ListingsApiDeleteListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListingsApi */ deleteListingsItem(requestParameters: ListingsApiDeleteListingsItemRequest, options?: any): Promise>; /** * Returns details about a listings item for a selling partner. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {ListingsApiGetListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListingsApi */ getListingsItem(requestParameters: ListingsApiGetListingsItemRequest, options?: any): Promise>; /** * Partially update (patch) a listings item for a selling partner. Only top-level listings item attributes can be patched. Patching nested attributes is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput can receive higher rate and burst values then those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API documentation. * @param {ListingsApiPatchListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListingsApi */ patchListingsItem(requestParameters: ListingsApiPatchListingsItemRequest, options?: any): Promise>; /** * Creates or fully updates an existing listings item for a selling partner. **Note:** This operation has a throttling rate of one request per second when `mode` is `VALIDATION_PREVIEW`. **Note:** The parameters associated with this operation may contain special characters that must be encoded to successfully 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 | | ---- | ---- | | 5 | 10 | 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 {ListingsApiPutListingsItemRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListingsApi */ putListingsItem(requestParameters: ListingsApiPutListingsItemRequest, options?: any): Promise>; /** * Search for and return a list of selling partner listings items and their respective details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 5 | 5 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api). * @param {ListingsApiSearchListingsItemsRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ListingsApi */ searchListingsItems(requestParameters: ListingsApiSearchListingsItemsRequest, options?: any): Promise>; }