@sp-api-sdk/catalog-items-api-2022-04-01 1.4.5 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/api-model/api/catalog-api.js +8 -8
- package/dist/cjs/src/api-model/models/index.js +2 -0
- package/dist/cjs/src/api-model/models/item-contributor-role.js +15 -0
- package/dist/cjs/src/api-model/models/item-contributor.js +15 -0
- package/dist/cjs/src/client.js +4 -4
- package/dist/es/src/api-model/api/catalog-api.js +8 -8
- package/dist/es/src/api-model/models/index.js +2 -0
- package/dist/es/src/api-model/models/item-contributor-role.js +14 -0
- package/dist/es/src/api-model/models/item-contributor.js +14 -0
- package/dist/es/src/client.js +4 -4
- package/dist/types/src/api-model/api/catalog-api.d.ts +8 -8
- package/dist/types/src/api-model/models/index.d.ts +2 -0
- package/dist/types/src/api-model/models/item-contributor-role.d.ts +30 -0
- package/dist/types/src/api-model/models/item-contributor.d.ts +31 -0
- package/dist/types/src/api-model/models/item-image.d.ts +1 -1
- package/dist/types/src/api-model/models/item-relationship.d.ts +1 -1
- package/dist/types/src/api-model/models/item-search-results.d.ts +1 -1
- package/dist/types/src/api-model/models/item-summary-by-marketplace.d.ts +38 -1
- package/dist/types/src/api-model/models/item-vendor-details-by-marketplace.d.ts +1 -1
- package/package.json +3 -3
|
@@ -28,7 +28,7 @@ const base_1 = require("../base");
|
|
|
28
28
|
const CatalogApiAxiosParamCreator = function (configuration) {
|
|
29
29
|
return {
|
|
30
30
|
/**
|
|
31
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
31
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
32
32
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
33
33
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
34
34
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -70,7 +70,7 @@ const CatalogApiAxiosParamCreator = function (configuration) {
|
|
|
70
70
|
};
|
|
71
71
|
},
|
|
72
72
|
/**
|
|
73
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
73
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
74
74
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
75
75
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
76
76
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -154,7 +154,7 @@ const CatalogApiFp = function (configuration) {
|
|
|
154
154
|
const localVarAxiosParamCreator = (0, exports.CatalogApiAxiosParamCreator)(configuration);
|
|
155
155
|
return {
|
|
156
156
|
/**
|
|
157
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
157
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
158
158
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
159
159
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
160
160
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -167,7 +167,7 @@ const CatalogApiFp = function (configuration) {
|
|
|
167
167
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
168
168
|
},
|
|
169
169
|
/**
|
|
170
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
170
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
171
171
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
172
172
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
173
173
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -198,7 +198,7 @@ const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
198
198
|
const localVarFp = (0, exports.CatalogApiFp)(configuration);
|
|
199
199
|
return {
|
|
200
200
|
/**
|
|
201
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
201
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
202
202
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
203
203
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
204
204
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -210,7 +210,7 @@ const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
210
210
|
return localVarFp.getCatalogItem(asin, marketplaceIds, includedData, locale, options).then((request) => request(axios, basePath));
|
|
211
211
|
},
|
|
212
212
|
/**
|
|
213
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
213
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
214
214
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
215
215
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
216
216
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -240,7 +240,7 @@ exports.CatalogApiFactory = CatalogApiFactory;
|
|
|
240
240
|
*/
|
|
241
241
|
class CatalogApi extends base_1.BaseAPI {
|
|
242
242
|
/**
|
|
243
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
243
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
244
244
|
* @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
245
245
|
* @param {*} [options] Override http request option.
|
|
246
246
|
* @throws {RequiredError}
|
|
@@ -250,7 +250,7 @@ class CatalogApi extends base_1.BaseAPI {
|
|
|
250
250
|
return (0, exports.CatalogApiFp)(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
251
251
|
}
|
|
252
252
|
/**
|
|
253
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
253
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
254
254
|
* @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
@@ -9,6 +9,8 @@ tslib_1.__exportStar(require("./error-list"), exports);
|
|
|
9
9
|
tslib_1.__exportStar(require("./item"), exports);
|
|
10
10
|
tslib_1.__exportStar(require("./item-browse-classification"), exports);
|
|
11
11
|
tslib_1.__exportStar(require("./item-classification-sales-rank"), exports);
|
|
12
|
+
tslib_1.__exportStar(require("./item-contributor"), exports);
|
|
13
|
+
tslib_1.__exportStar(require("./item-contributor-role"), exports);
|
|
12
14
|
tslib_1.__exportStar(require("./item-dimensions-by-marketplace"), exports);
|
|
13
15
|
tslib_1.__exportStar(require("./item-display-group-sales-rank"), exports);
|
|
14
16
|
tslib_1.__exportStar(require("./item-identifier"), exports);
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Catalog Items
|
|
6
|
+
* The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2022-04-01
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Catalog Items
|
|
6
|
+
* The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2022-04-01
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/cjs/src/client.js
CHANGED
|
@@ -8,15 +8,15 @@ exports.clientRateLimits = [
|
|
|
8
8
|
method: 'get',
|
|
9
9
|
// eslint-disable-next-line prefer-regex-literals
|
|
10
10
|
urlRegex: new RegExp('^/catalog/2022-04-01/items$'),
|
|
11
|
-
rate:
|
|
12
|
-
burst:
|
|
11
|
+
rate: 5,
|
|
12
|
+
burst: 5,
|
|
13
13
|
},
|
|
14
14
|
{
|
|
15
15
|
method: 'get',
|
|
16
16
|
// eslint-disable-next-line prefer-regex-literals
|
|
17
17
|
urlRegex: new RegExp('^/catalog/2022-04-01/items/[^/]*$'),
|
|
18
|
-
rate:
|
|
19
|
-
burst:
|
|
18
|
+
rate: 5,
|
|
19
|
+
burst: 5,
|
|
20
20
|
},
|
|
21
21
|
];
|
|
22
22
|
class CatalogItemsApiClient extends api_model_1.CatalogApi {
|
|
@@ -24,7 +24,7 @@ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
|
|
|
24
24
|
export const CatalogApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
27
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
28
28
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
29
29
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
30
30
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -66,7 +66,7 @@ export const CatalogApiAxiosParamCreator = function (configuration) {
|
|
|
66
66
|
};
|
|
67
67
|
},
|
|
68
68
|
/**
|
|
69
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
69
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
70
70
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
71
71
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
72
72
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -149,7 +149,7 @@ export const CatalogApiFp = function (configuration) {
|
|
|
149
149
|
const localVarAxiosParamCreator = CatalogApiAxiosParamCreator(configuration);
|
|
150
150
|
return {
|
|
151
151
|
/**
|
|
152
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
152
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
153
153
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
154
154
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
155
155
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -162,7 +162,7 @@ export const CatalogApiFp = function (configuration) {
|
|
|
162
162
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
163
163
|
},
|
|
164
164
|
/**
|
|
165
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
165
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
166
166
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
167
167
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
168
168
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -192,7 +192,7 @@ export const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
192
192
|
const localVarFp = CatalogApiFp(configuration);
|
|
193
193
|
return {
|
|
194
194
|
/**
|
|
195
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
195
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
196
196
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
197
197
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
198
198
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -204,7 +204,7 @@ export const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
204
204
|
return localVarFp.getCatalogItem(asin, marketplaceIds, includedData, locale, options).then((request) => request(axios, basePath));
|
|
205
205
|
},
|
|
206
206
|
/**
|
|
207
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
207
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
208
208
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
209
209
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
210
210
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -233,7 +233,7 @@ export const CatalogApiFactory = function (configuration, basePath, axios) {
|
|
|
233
233
|
*/
|
|
234
234
|
export class CatalogApi extends BaseAPI {
|
|
235
235
|
/**
|
|
236
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
236
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
237
237
|
* @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
238
238
|
* @param {*} [options] Override http request option.
|
|
239
239
|
* @throws {RequiredError}
|
|
@@ -243,7 +243,7 @@ export class CatalogApi extends BaseAPI {
|
|
|
243
243
|
return CatalogApiFp(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
|
|
244
244
|
}
|
|
245
245
|
/**
|
|
246
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
246
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
247
247
|
* @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
248
248
|
* @param {*} [options] Override http request option.
|
|
249
249
|
* @throws {RequiredError}
|
|
@@ -6,6 +6,8 @@ export * from './error-list';
|
|
|
6
6
|
export * from './item';
|
|
7
7
|
export * from './item-browse-classification';
|
|
8
8
|
export * from './item-classification-sales-rank';
|
|
9
|
+
export * from './item-contributor';
|
|
10
|
+
export * from './item-contributor-role';
|
|
9
11
|
export * from './item-dimensions-by-marketplace';
|
|
10
12
|
export * from './item-display-group-sales-rank';
|
|
11
13
|
export * from './item-identifier';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Catalog Items
|
|
5
|
+
* The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2022-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Catalog Items
|
|
5
|
+
* The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2022-04-01
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
package/dist/es/src/client.js
CHANGED
|
@@ -5,15 +5,15 @@ export const clientRateLimits = [
|
|
|
5
5
|
method: 'get',
|
|
6
6
|
// eslint-disable-next-line prefer-regex-literals
|
|
7
7
|
urlRegex: new RegExp('^/catalog/2022-04-01/items$'),
|
|
8
|
-
rate:
|
|
9
|
-
burst:
|
|
8
|
+
rate: 5,
|
|
9
|
+
burst: 5,
|
|
10
10
|
},
|
|
11
11
|
{
|
|
12
12
|
method: 'get',
|
|
13
13
|
// eslint-disable-next-line prefer-regex-literals
|
|
14
14
|
urlRegex: new RegExp('^/catalog/2022-04-01/items/[^/]*$'),
|
|
15
|
-
rate:
|
|
16
|
-
burst:
|
|
15
|
+
rate: 5,
|
|
16
|
+
burst: 5,
|
|
17
17
|
},
|
|
18
18
|
];
|
|
19
19
|
export class CatalogItemsApiClient extends CatalogApi {
|
|
@@ -20,7 +20,7 @@ import { ItemSearchResults } from '../models';
|
|
|
20
20
|
*/
|
|
21
21
|
export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
22
|
/**
|
|
23
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
23
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
24
24
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
25
25
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
26
26
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -30,7 +30,7 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
|
|
|
30
30
|
*/
|
|
31
31
|
getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
33
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
33
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
34
34
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
35
35
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
36
36
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -54,7 +54,7 @@ export declare const CatalogApiAxiosParamCreator: (configuration?: Configuration
|
|
|
54
54
|
*/
|
|
55
55
|
export declare const CatalogApiFp: (configuration?: Configuration) => {
|
|
56
56
|
/**
|
|
57
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
57
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
58
58
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
59
59
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
60
60
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -64,7 +64,7 @@ export declare const CatalogApiFp: (configuration?: Configuration) => {
|
|
|
64
64
|
*/
|
|
65
65
|
getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
|
|
66
66
|
/**
|
|
67
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
67
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
68
68
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
69
69
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
70
70
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -88,7 +88,7 @@ export declare const CatalogApiFp: (configuration?: Configuration) => {
|
|
|
88
88
|
*/
|
|
89
89
|
export declare const CatalogApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
90
90
|
/**
|
|
91
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
91
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
92
92
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
93
93
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.
|
|
94
94
|
* @param {Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>} [includedData] A comma-delimited list of data sets to include in the response. Default: `summaries`.
|
|
@@ -98,7 +98,7 @@ export declare const CatalogApiFactory: (configuration?: Configuration, basePath
|
|
|
98
98
|
*/
|
|
99
99
|
getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<'attributes' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>, locale?: string, options?: any): AxiosPromise<Item>;
|
|
100
100
|
/**
|
|
101
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
101
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
102
102
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
|
|
103
103
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with `keywords`.
|
|
104
104
|
* @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when `identifiers` are provided.
|
|
@@ -234,7 +234,7 @@ export interface CatalogApiSearchCatalogItemsRequest {
|
|
|
234
234
|
*/
|
|
235
235
|
export declare class CatalogApi extends BaseAPI {
|
|
236
236
|
/**
|
|
237
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
237
|
+
* Retrieves details for an item in the Amazon catalog. **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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
238
238
|
* @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
239
239
|
* @param {*} [options] Override http request option.
|
|
240
240
|
* @throws {RequiredError}
|
|
@@ -242,7 +242,7 @@ export declare class CatalogApi extends BaseAPI {
|
|
|
242
242
|
*/
|
|
243
243
|
getCatalogItem(requestParameters: CatalogApiGetCatalogItemRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Item, any>>;
|
|
244
244
|
/**
|
|
245
|
-
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
245
|
+
* Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords. **Usage Plans:** | 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 table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the [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).
|
|
246
246
|
* @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
247
247
|
* @param {*} [options] Override http request option.
|
|
248
248
|
* @throws {RequiredError}
|
|
@@ -6,6 +6,8 @@ export * from './error-list';
|
|
|
6
6
|
export * from './item';
|
|
7
7
|
export * from './item-browse-classification';
|
|
8
8
|
export * from './item-classification-sales-rank';
|
|
9
|
+
export * from './item-contributor';
|
|
10
|
+
export * from './item-contributor-role';
|
|
9
11
|
export * from './item-dimensions-by-marketplace';
|
|
10
12
|
export * from './item-display-group-sales-rank';
|
|
11
13
|
export * from './item-identifier';
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Catalog Items
|
|
3
|
+
* The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-04-01
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Role of an individual contributor in the creation of an item, such as author or actor.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ItemContributorRole
|
|
16
|
+
*/
|
|
17
|
+
export interface ItemContributorRole {
|
|
18
|
+
/**
|
|
19
|
+
* Display name of the role in the requested locale, such as Author or Actor.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ItemContributorRole
|
|
22
|
+
*/
|
|
23
|
+
'displayName'?: string;
|
|
24
|
+
/**
|
|
25
|
+
* Role value for the Amazon catalog item, such as author or actor.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof ItemContributorRole
|
|
28
|
+
*/
|
|
29
|
+
'value': string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Catalog Items
|
|
3
|
+
* The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2022-04-01
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { ItemContributorRole } from './item-contributor-role';
|
|
13
|
+
/**
|
|
14
|
+
* Individual contributor to the creation of an item, such as an author or actor.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ItemContributor
|
|
17
|
+
*/
|
|
18
|
+
export interface ItemContributor {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {ItemContributorRole}
|
|
22
|
+
* @memberof ItemContributor
|
|
23
|
+
*/
|
|
24
|
+
'role': ItemContributorRole;
|
|
25
|
+
/**
|
|
26
|
+
* Name of the contributor, such as Jane Austen.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ItemContributor
|
|
29
|
+
*/
|
|
30
|
+
'value': string;
|
|
31
|
+
}
|
|
@@ -52,4 +52,4 @@ export declare const ItemImageVariantEnum: {
|
|
|
52
52
|
readonly Pt08: "PT08";
|
|
53
53
|
readonly Swch: "SWCH";
|
|
54
54
|
};
|
|
55
|
-
export
|
|
55
|
+
export type ItemImageVariantEnum = typeof ItemImageVariantEnum[keyof typeof ItemImageVariantEnum];
|
|
@@ -45,4 +45,4 @@ export declare const ItemRelationshipTypeEnum: {
|
|
|
45
45
|
readonly Variation: "VARIATION";
|
|
46
46
|
readonly PackageHierarchy: "PACKAGE_HIERARCHY";
|
|
47
47
|
};
|
|
48
|
-
export
|
|
48
|
+
export type ItemRelationshipTypeEnum = typeof ItemRelationshipTypeEnum[keyof typeof ItemRelationshipTypeEnum];
|
|
@@ -19,7 +19,7 @@ import { Refinements } from './refinements';
|
|
|
19
19
|
*/
|
|
20
20
|
export interface ItemSearchResults {
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* For `identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items matched by the search query (only results up to the page count limit will be returned per request regardless of the number found). Note: The maximum number of items (ASINs) that can be returned and paged through is 1000.
|
|
23
23
|
* @type {number}
|
|
24
24
|
* @memberof ItemSearchResults
|
|
25
25
|
*/
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { ItemBrowseClassification } from './item-browse-classification';
|
|
13
|
+
import { ItemContributor } from './item-contributor';
|
|
13
14
|
/**
|
|
14
15
|
* Summary details of an Amazon catalog item for the indicated Amazon marketplace.
|
|
15
16
|
* @export
|
|
@@ -22,6 +23,18 @@ export interface ItemSummaryByMarketplace {
|
|
|
22
23
|
* @memberof ItemSummaryByMarketplace
|
|
23
24
|
*/
|
|
24
25
|
'marketplaceId': string;
|
|
26
|
+
/**
|
|
27
|
+
* Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature.
|
|
28
|
+
* @type {boolean}
|
|
29
|
+
* @memberof ItemSummaryByMarketplace
|
|
30
|
+
*/
|
|
31
|
+
'adultProduct'?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Identifies an Amazon catalog item is autographed by a player or celebrity.
|
|
34
|
+
* @type {boolean}
|
|
35
|
+
* @memberof ItemSummaryByMarketplace
|
|
36
|
+
*/
|
|
37
|
+
'autographed'?: boolean;
|
|
25
38
|
/**
|
|
26
39
|
* Name of the brand associated with an Amazon catalog item.
|
|
27
40
|
* @type {string}
|
|
@@ -40,6 +53,12 @@ export interface ItemSummaryByMarketplace {
|
|
|
40
53
|
* @memberof ItemSummaryByMarketplace
|
|
41
54
|
*/
|
|
42
55
|
'color'?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Individual contributors to the creation of an item, such as the authors or actors.
|
|
58
|
+
* @type {Array<ItemContributor>}
|
|
59
|
+
* @memberof ItemSummaryByMarketplace
|
|
60
|
+
*/
|
|
61
|
+
'contributors'?: Array<ItemContributor>;
|
|
43
62
|
/**
|
|
44
63
|
* Classification type associated with the Amazon catalog item.
|
|
45
64
|
* @type {string}
|
|
@@ -58,6 +77,12 @@ export interface ItemSummaryByMarketplace {
|
|
|
58
77
|
* @memberof ItemSummaryByMarketplace
|
|
59
78
|
*/
|
|
60
79
|
'manufacturer'?: string;
|
|
80
|
+
/**
|
|
81
|
+
* Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment.
|
|
82
|
+
* @type {boolean}
|
|
83
|
+
* @memberof ItemSummaryByMarketplace
|
|
84
|
+
*/
|
|
85
|
+
'memorabilia'?: boolean;
|
|
61
86
|
/**
|
|
62
87
|
* Model number associated with an Amazon catalog item.
|
|
63
88
|
* @type {string}
|
|
@@ -76,6 +101,12 @@ export interface ItemSummaryByMarketplace {
|
|
|
76
101
|
* @memberof ItemSummaryByMarketplace
|
|
77
102
|
*/
|
|
78
103
|
'partNumber'?: string;
|
|
104
|
+
/**
|
|
105
|
+
* First date on which an Amazon catalog item is shippable to customers.
|
|
106
|
+
* @type {string}
|
|
107
|
+
* @memberof ItemSummaryByMarketplace
|
|
108
|
+
*/
|
|
109
|
+
'releaseDate'?: string;
|
|
79
110
|
/**
|
|
80
111
|
* Name of the size associated with an Amazon catalog item.
|
|
81
112
|
* @type {string}
|
|
@@ -88,6 +119,12 @@ export interface ItemSummaryByMarketplace {
|
|
|
88
119
|
* @memberof ItemSummaryByMarketplace
|
|
89
120
|
*/
|
|
90
121
|
'style'?: string;
|
|
122
|
+
/**
|
|
123
|
+
* Identifies an Amazon catalog item is eligible for trade-in.
|
|
124
|
+
* @type {boolean}
|
|
125
|
+
* @memberof ItemSummaryByMarketplace
|
|
126
|
+
*/
|
|
127
|
+
'tradeInEligible'?: boolean;
|
|
91
128
|
/**
|
|
92
129
|
* Identifier of the website display group associated with an Amazon catalog item.
|
|
93
130
|
* @type {string}
|
|
@@ -107,4 +144,4 @@ export declare const ItemSummaryByMarketplaceItemClassificationEnum: {
|
|
|
107
144
|
readonly ProductBundle: "PRODUCT_BUNDLE";
|
|
108
145
|
readonly VariationParent: "VARIATION_PARENT";
|
|
109
146
|
};
|
|
110
|
-
export
|
|
147
|
+
export type ItemSummaryByMarketplaceItemClassificationEnum = typeof ItemSummaryByMarketplaceItemClassificationEnum[keyof typeof ItemSummaryByMarketplaceItemClassificationEnum];
|
|
@@ -77,4 +77,4 @@ export declare const ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum: {
|
|
|
77
77
|
readonly Obsolete: "OBSOLETE";
|
|
78
78
|
readonly PlannedReplenishment: "PLANNED_REPLENISHMENT";
|
|
79
79
|
};
|
|
80
|
-
export
|
|
80
|
+
export type ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum = typeof ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum[keyof typeof ItemVendorDetailsByMarketplaceReplenishmentCategoryEnum];
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/catalog-items-api-2022-04-01",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the Catalog Items API Use Case Guide.",
|
|
5
|
-
"version": "1.
|
|
5
|
+
"version": "1.5.1",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"test": "jest"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@sp-api-sdk/common": "^1.9.
|
|
29
|
+
"@sp-api-sdk/common": "^1.9.19",
|
|
30
30
|
"axios": "^0.27.2"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"typedoc": {
|
|
52
52
|
"entryPoint": "./index.ts"
|
|
53
53
|
},
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "51c491e1ac6ad46d8cfae56568f17b350fc9e367"
|
|
55
55
|
}
|