@sp-api-sdk/catalog-items-api-2022-04-01 4.0.1 → 4.1.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/api-model/api/catalog-items-api.js +8 -25
- package/dist/cjs/api-model/base.js +0 -19
- package/dist/cjs/api-model/common.js +0 -37
- package/dist/cjs/api-model/configuration.js +0 -17
- package/dist/cjs/client.js +4 -4
- package/dist/es/api-model/api/catalog-items-api.js +8 -25
- package/dist/es/api-model/base.js +0 -19
- package/dist/es/api-model/common.js +0 -37
- package/dist/es/api-model/configuration.js +0 -17
- package/dist/es/client.js +4 -4
- package/dist/types/api-model/api/catalog-items-api.d.ts +8 -61
- package/dist/types/api-model/base.d.ts +0 -24
- package/dist/types/api-model/common.d.ts +0 -37
- package/dist/types/api-model/configuration.d.ts +0 -17
- package/dist/types/api-model/models/brand-refinement.d.ts +0 -6
- package/dist/types/api-model/models/classification-refinement.d.ts +0 -8
- package/dist/types/api-model/models/dimension.d.ts +0 -6
- package/dist/types/api-model/models/dimensions.d.ts +0 -22
- package/dist/types/api-model/models/error-list.d.ts +0 -7
- package/dist/types/api-model/models/item-browse-classification.d.ts +0 -11
- package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +0 -6
- package/dist/types/api-model/models/item-classification-sales-rank.d.ts +0 -10
- package/dist/types/api-model/models/item-contributor-role.d.ts +0 -6
- package/dist/types/api-model/models/item-contributor.d.ts +0 -9
- package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +0 -14
- package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +0 -10
- package/dist/types/api-model/models/item-identifier.d.ts +0 -6
- package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +0 -6
- package/dist/types/api-model/models/item-image.d.ts +0 -10
- package/dist/types/api-model/models/item-images-by-marketplace.d.ts +0 -6
- package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +0 -6
- package/dist/types/api-model/models/item-relationship.d.ts +0 -13
- package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +0 -6
- package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +0 -8
- package/dist/types/api-model/models/item-search-results.d.ts +0 -16
- package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +0 -45
- package/dist/types/api-model/models/item-variation-theme.d.ts +0 -6
- package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +0 -24
- package/dist/types/api-model/models/item-vendor-details-category.d.ts +0 -6
- package/dist/types/api-model/models/item.d.ts +1 -25
- package/dist/types/api-model/models/model-error.d.ts +0 -8
- package/dist/types/api-model/models/pagination.d.ts +0 -6
- package/dist/types/api-model/models/refinements.d.ts +0 -6
- package/package.json +25 -4
|
@@ -15,49 +15,32 @@ export class Configuration {
|
|
|
15
15
|
/**
|
|
16
16
|
* parameter for apiKey security
|
|
17
17
|
* @param name security name
|
|
18
|
-
* @memberof Configuration
|
|
19
18
|
*/
|
|
20
19
|
apiKey;
|
|
21
20
|
/**
|
|
22
21
|
* parameter for basic security
|
|
23
|
-
*
|
|
24
|
-
* @type {string}
|
|
25
|
-
* @memberof Configuration
|
|
26
22
|
*/
|
|
27
23
|
username;
|
|
28
24
|
/**
|
|
29
25
|
* parameter for basic security
|
|
30
|
-
*
|
|
31
|
-
* @type {string}
|
|
32
|
-
* @memberof Configuration
|
|
33
26
|
*/
|
|
34
27
|
password;
|
|
35
28
|
/**
|
|
36
29
|
* parameter for oauth2 security
|
|
37
30
|
* @param name security name
|
|
38
31
|
* @param scopes oauth2 scope
|
|
39
|
-
* @memberof Configuration
|
|
40
32
|
*/
|
|
41
33
|
accessToken;
|
|
42
34
|
/**
|
|
43
35
|
* override base path
|
|
44
|
-
*
|
|
45
|
-
* @type {string}
|
|
46
|
-
* @memberof Configuration
|
|
47
36
|
*/
|
|
48
37
|
basePath;
|
|
49
38
|
/**
|
|
50
39
|
* override server index
|
|
51
|
-
*
|
|
52
|
-
* @type {number}
|
|
53
|
-
* @memberof Configuration
|
|
54
40
|
*/
|
|
55
41
|
serverIndex;
|
|
56
42
|
/**
|
|
57
43
|
* base options for axios calls
|
|
58
|
-
*
|
|
59
|
-
* @type {any}
|
|
60
|
-
* @memberof Configuration
|
|
61
44
|
*/
|
|
62
45
|
baseOptions;
|
|
63
46
|
/**
|
package/dist/es/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: 2,
|
|
9
|
+
burst: 2,
|
|
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: 2,
|
|
16
|
+
burst: 2,
|
|
17
17
|
},
|
|
18
18
|
];
|
|
19
19
|
export class CatalogItemsApiClient extends CatalogItemsApi {
|
|
@@ -17,11 +17,10 @@ import type { Item } from '../models';
|
|
|
17
17
|
import type { ItemSearchResults } from '../models';
|
|
18
18
|
/**
|
|
19
19
|
* CatalogItemsApi - axios parameter creator
|
|
20
|
-
* @export
|
|
21
20
|
*/
|
|
22
21
|
export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
22
|
/**
|
|
24
|
-
* 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 | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
25
24
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
26
25
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
27
26
|
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
|
|
@@ -31,7 +30,7 @@ export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configur
|
|
|
31
30
|
*/
|
|
32
31
|
getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
32
|
/**
|
|
34
|
-
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
33
|
+
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
35
34
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
36
35
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
|
|
37
36
|
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
|
|
@@ -51,11 +50,10 @@ export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configur
|
|
|
51
50
|
};
|
|
52
51
|
/**
|
|
53
52
|
* CatalogItemsApi - functional programming interface
|
|
54
|
-
* @export
|
|
55
53
|
*/
|
|
56
54
|
export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
|
|
57
55
|
/**
|
|
58
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
56
|
+
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
59
57
|
* @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
|
|
60
58
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
61
59
|
* @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
|
|
@@ -65,7 +63,7 @@ export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
|
|
|
65
63
|
*/
|
|
66
64
|
getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
|
|
67
65
|
/**
|
|
68
|
-
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
66
|
+
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
69
67
|
* @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
70
68
|
* @param {Array<string>} [identifiers] A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
|
|
71
69
|
* @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
|
|
@@ -85,18 +83,17 @@ export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
|
|
|
85
83
|
};
|
|
86
84
|
/**
|
|
87
85
|
* CatalogItemsApi - factory interface
|
|
88
|
-
* @export
|
|
89
86
|
*/
|
|
90
87
|
export declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
91
88
|
/**
|
|
92
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
89
|
+
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
93
90
|
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
94
91
|
* @param {*} [options] Override http request option.
|
|
95
92
|
* @throws {RequiredError}
|
|
96
93
|
*/
|
|
97
94
|
getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
|
|
98
95
|
/**
|
|
99
|
-
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
96
|
+
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
100
97
|
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
101
98
|
* @param {*} [options] Override http request option.
|
|
102
99
|
* @throws {RequiredError}
|
|
@@ -105,141 +102,97 @@ export declare const CatalogItemsApiFactory: (configuration?: Configuration, bas
|
|
|
105
102
|
};
|
|
106
103
|
/**
|
|
107
104
|
* Request parameters for getCatalogItem operation in CatalogItemsApi.
|
|
108
|
-
* @export
|
|
109
|
-
* @interface CatalogItemsApiGetCatalogItemRequest
|
|
110
105
|
*/
|
|
111
106
|
export interface CatalogItemsApiGetCatalogItemRequest {
|
|
112
107
|
/**
|
|
113
108
|
* The Amazon Standard Identification Number (ASIN) of the item.
|
|
114
|
-
* @type {string}
|
|
115
|
-
* @memberof CatalogItemsApiGetCatalogItem
|
|
116
109
|
*/
|
|
117
110
|
readonly asin: string;
|
|
118
111
|
/**
|
|
119
112
|
* A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
120
|
-
* @type {Array<string>}
|
|
121
|
-
* @memberof CatalogItemsApiGetCatalogItem
|
|
122
113
|
*/
|
|
123
114
|
readonly marketplaceIds: Array<string>;
|
|
124
115
|
/**
|
|
125
116
|
* A comma-delimited list of datasets to include in the response.
|
|
126
|
-
* @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
|
|
127
|
-
* @memberof CatalogItemsApiGetCatalogItem
|
|
128
117
|
*/
|
|
129
118
|
readonly includedData?: Array<GetCatalogItemIncludedDataEnum>;
|
|
130
119
|
/**
|
|
131
120
|
* The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
|
|
132
|
-
* @type {string}
|
|
133
|
-
* @memberof CatalogItemsApiGetCatalogItem
|
|
134
121
|
*/
|
|
135
122
|
readonly locale?: string;
|
|
136
123
|
}
|
|
137
124
|
/**
|
|
138
125
|
* Request parameters for searchCatalogItems operation in CatalogItemsApi.
|
|
139
|
-
* @export
|
|
140
|
-
* @interface CatalogItemsApiSearchCatalogItemsRequest
|
|
141
126
|
*/
|
|
142
127
|
export interface CatalogItemsApiSearchCatalogItemsRequest {
|
|
143
128
|
/**
|
|
144
129
|
* A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
145
|
-
* @type {Array<string>}
|
|
146
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
147
130
|
*/
|
|
148
131
|
readonly marketplaceIds: Array<string>;
|
|
149
132
|
/**
|
|
150
133
|
* A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include `identifiers` and `keywords` in the same request.
|
|
151
|
-
* @type {Array<string>}
|
|
152
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
153
134
|
*/
|
|
154
135
|
readonly identifiers?: Array<string>;
|
|
155
136
|
/**
|
|
156
137
|
* The type of product identifiers that you can use to search the Amazon catalog. **Note:** `identifiersType` is required when `identifiers` is in the request.
|
|
157
|
-
* @type {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'}
|
|
158
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
159
138
|
*/
|
|
160
139
|
readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
|
|
161
140
|
/**
|
|
162
141
|
* A comma-delimited list of datasets to include in the response.
|
|
163
|
-
* @type {Array<'attributes' | 'classifications' | 'dimensions' | 'identifiers' | 'images' | 'productTypes' | 'relationships' | 'salesRanks' | 'summaries' | 'vendorDetails'>}
|
|
164
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
165
142
|
*/
|
|
166
143
|
readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>;
|
|
167
144
|
/**
|
|
168
145
|
* The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
|
|
169
|
-
* @type {string}
|
|
170
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
171
146
|
*/
|
|
172
147
|
readonly locale?: string;
|
|
173
148
|
/**
|
|
174
149
|
* A selling partner identifier, such as a seller account or vendor code. **Note:** Required when `identifiersType` is `SKU`.
|
|
175
|
-
* @type {string}
|
|
176
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
177
150
|
*/
|
|
178
151
|
readonly sellerId?: string;
|
|
179
152
|
/**
|
|
180
153
|
* A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include `keywords` and `identifiers` in the same request.
|
|
181
|
-
* @type {Array<string>}
|
|
182
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
183
154
|
*/
|
|
184
155
|
readonly keywords?: Array<string>;
|
|
185
156
|
/**
|
|
186
157
|
* A comma-delimited list of brand names that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
|
|
187
|
-
* @type {Array<string>}
|
|
188
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
189
158
|
*/
|
|
190
159
|
readonly brandNames?: Array<string>;
|
|
191
160
|
/**
|
|
192
161
|
* A comma-delimited list of classification identifiers that you can use to limit the search in queries based on `keywords`. **Note:** Cannot be used with `identifiers`.
|
|
193
|
-
* @type {Array<string>}
|
|
194
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
195
162
|
*/
|
|
196
163
|
readonly classificationIds?: Array<string>;
|
|
197
164
|
/**
|
|
198
165
|
* The number of results to include on each page.
|
|
199
|
-
* @type {number}
|
|
200
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
201
166
|
*/
|
|
202
167
|
readonly pageSize?: number;
|
|
203
168
|
/**
|
|
204
169
|
* A token that you can use to fetch a specific page when there are multiple pages of results.
|
|
205
|
-
* @type {string}
|
|
206
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
207
170
|
*/
|
|
208
171
|
readonly pageToken?: string;
|
|
209
172
|
/**
|
|
210
173
|
* The language of the keywords that are included in queries based on `keywords`. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with `identifiers`.
|
|
211
|
-
* @type {string}
|
|
212
|
-
* @memberof CatalogItemsApiSearchCatalogItems
|
|
213
174
|
*/
|
|
214
175
|
readonly keywordsLocale?: string;
|
|
215
176
|
}
|
|
216
177
|
/**
|
|
217
178
|
* CatalogItemsApi - object-oriented interface
|
|
218
|
-
* @export
|
|
219
|
-
* @class CatalogItemsApi
|
|
220
|
-
* @extends {BaseAPI}
|
|
221
179
|
*/
|
|
222
180
|
export declare class CatalogItemsApi extends BaseAPI {
|
|
223
181
|
/**
|
|
224
|
-
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
182
|
+
* Retrieves details for an item in the Amazon catalog. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
225
183
|
* @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
|
|
226
184
|
* @param {*} [options] Override http request option.
|
|
227
185
|
* @throws {RequiredError}
|
|
228
|
-
* @memberof CatalogItemsApi
|
|
229
186
|
*/
|
|
230
187
|
getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any>>;
|
|
231
188
|
/**
|
|
232
|
-
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
189
|
+
* Search for a list of Amazon catalog items and item-related information. You can search by identifier or by keywords. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header contains the usage plan rate limits for the 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).
|
|
233
190
|
* @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
|
|
234
191
|
* @param {*} [options] Override http request option.
|
|
235
192
|
* @throws {RequiredError}
|
|
236
|
-
* @memberof CatalogItemsApi
|
|
237
193
|
*/
|
|
238
194
|
searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any>>;
|
|
239
195
|
}
|
|
240
|
-
/**
|
|
241
|
-
* @export
|
|
242
|
-
*/
|
|
243
196
|
export declare const GetCatalogItemIncludedDataEnum: {
|
|
244
197
|
readonly Attributes: "attributes";
|
|
245
198
|
readonly Classifications: "classifications";
|
|
@@ -253,9 +206,6 @@ export declare const GetCatalogItemIncludedDataEnum: {
|
|
|
253
206
|
readonly VendorDetails: "vendorDetails";
|
|
254
207
|
};
|
|
255
208
|
export type GetCatalogItemIncludedDataEnum = typeof GetCatalogItemIncludedDataEnum[keyof typeof GetCatalogItemIncludedDataEnum];
|
|
256
|
-
/**
|
|
257
|
-
* @export
|
|
258
|
-
*/
|
|
259
209
|
export declare const SearchCatalogItemsIdentifiersTypeEnum: {
|
|
260
210
|
readonly Asin: "ASIN";
|
|
261
211
|
readonly Ean: "EAN";
|
|
@@ -267,9 +217,6 @@ export declare const SearchCatalogItemsIdentifiersTypeEnum: {
|
|
|
267
217
|
readonly Upc: "UPC";
|
|
268
218
|
};
|
|
269
219
|
export type SearchCatalogItemsIdentifiersTypeEnum = typeof SearchCatalogItemsIdentifiersTypeEnum[keyof typeof SearchCatalogItemsIdentifiersTypeEnum];
|
|
270
|
-
/**
|
|
271
|
-
* @export
|
|
272
|
-
*/
|
|
273
220
|
export declare const SearchCatalogItemsIncludedDataEnum: {
|
|
274
221
|
readonly Attributes: "attributes";
|
|
275
222
|
readonly Classifications: "classifications";
|
|
@@ -12,42 +12,22 @@
|
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const COLLECTION_FORMATS: {
|
|
20
16
|
csv: string;
|
|
21
17
|
ssv: string;
|
|
22
18
|
tsv: string;
|
|
23
19
|
pipes: string;
|
|
24
20
|
};
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @export
|
|
28
|
-
* @interface RequestArgs
|
|
29
|
-
*/
|
|
30
21
|
export interface RequestArgs {
|
|
31
22
|
url: string;
|
|
32
23
|
options: RawAxiosRequestConfig;
|
|
33
24
|
}
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @export
|
|
37
|
-
* @class BaseAPI
|
|
38
|
-
*/
|
|
39
25
|
export declare class BaseAPI {
|
|
40
26
|
protected basePath: string;
|
|
41
27
|
protected axios: AxiosInstance;
|
|
42
28
|
protected configuration: Configuration | undefined;
|
|
43
29
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
30
|
}
|
|
45
|
-
/**
|
|
46
|
-
*
|
|
47
|
-
* @export
|
|
48
|
-
* @class RequiredError
|
|
49
|
-
* @extends {Error}
|
|
50
|
-
*/
|
|
51
31
|
export declare class RequiredError extends Error {
|
|
52
32
|
field: string;
|
|
53
33
|
constructor(field: string, msg?: string);
|
|
@@ -58,9 +38,5 @@ interface ServerMap {
|
|
|
58
38
|
description: string;
|
|
59
39
|
}[];
|
|
60
40
|
}
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
41
|
export declare const operationServerMap: ServerMap;
|
|
66
42
|
export {};
|
|
@@ -12,54 +12,17 @@
|
|
|
12
12
|
import type { Configuration } from "./configuration";
|
|
13
13
|
import type { RequestArgs } from "./base";
|
|
14
14
|
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const DUMMY_BASE_URL = "https://example.com";
|
|
20
16
|
/**
|
|
21
17
|
*
|
|
22
18
|
* @throws {RequiredError}
|
|
23
|
-
* @export
|
|
24
19
|
*/
|
|
25
20
|
export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
*/
|
|
30
21
|
export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @export
|
|
34
|
-
*/
|
|
35
22
|
export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
|
|
36
|
-
/**
|
|
37
|
-
*
|
|
38
|
-
* @export
|
|
39
|
-
*/
|
|
40
23
|
export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
|
|
41
|
-
/**
|
|
42
|
-
*
|
|
43
|
-
* @export
|
|
44
|
-
*/
|
|
45
24
|
export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
|
|
46
|
-
/**
|
|
47
|
-
*
|
|
48
|
-
* @export
|
|
49
|
-
*/
|
|
50
25
|
export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
|
|
51
|
-
/**
|
|
52
|
-
*
|
|
53
|
-
* @export
|
|
54
|
-
*/
|
|
55
26
|
export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
|
|
56
|
-
/**
|
|
57
|
-
*
|
|
58
|
-
* @export
|
|
59
|
-
*/
|
|
60
27
|
export declare const toPathString: (url: URL) => string;
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
28
|
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
|
|
@@ -23,49 +23,32 @@ export declare class Configuration {
|
|
|
23
23
|
/**
|
|
24
24
|
* parameter for apiKey security
|
|
25
25
|
* @param name security name
|
|
26
|
-
* @memberof Configuration
|
|
27
26
|
*/
|
|
28
27
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
28
|
/**
|
|
30
29
|
* parameter for basic security
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Configuration
|
|
34
30
|
*/
|
|
35
31
|
username?: string;
|
|
36
32
|
/**
|
|
37
33
|
* parameter for basic security
|
|
38
|
-
*
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof Configuration
|
|
41
34
|
*/
|
|
42
35
|
password?: string;
|
|
43
36
|
/**
|
|
44
37
|
* parameter for oauth2 security
|
|
45
38
|
* @param name security name
|
|
46
39
|
* @param scopes oauth2 scope
|
|
47
|
-
* @memberof Configuration
|
|
48
40
|
*/
|
|
49
41
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
42
|
/**
|
|
51
43
|
* override base path
|
|
52
|
-
*
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof Configuration
|
|
55
44
|
*/
|
|
56
45
|
basePath?: string;
|
|
57
46
|
/**
|
|
58
47
|
* override server index
|
|
59
|
-
*
|
|
60
|
-
* @type {number}
|
|
61
|
-
* @memberof Configuration
|
|
62
48
|
*/
|
|
63
49
|
serverIndex?: number;
|
|
64
50
|
/**
|
|
65
51
|
* base options for axios calls
|
|
66
|
-
*
|
|
67
|
-
* @type {any}
|
|
68
|
-
* @memberof Configuration
|
|
69
52
|
*/
|
|
70
53
|
baseOptions?: any;
|
|
71
54
|
/**
|
|
@@ -11,20 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* A brand that you can use to refine your search.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface BrandRefinement
|
|
16
14
|
*/
|
|
17
15
|
export interface BrandRefinement {
|
|
18
16
|
/**
|
|
19
17
|
* The estimated number of results that would be returned if you refine your search by the specified `brandName`.
|
|
20
|
-
* @type {number}
|
|
21
|
-
* @memberof BrandRefinement
|
|
22
18
|
*/
|
|
23
19
|
'numberOfResults': number;
|
|
24
20
|
/**
|
|
25
21
|
* The brand name that you can use to refine your search.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof BrandRefinement
|
|
28
22
|
*/
|
|
29
23
|
'brandName': string;
|
|
30
24
|
}
|
|
@@ -11,26 +11,18 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* A classification that you can use to refine your search.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface ClassificationRefinement
|
|
16
14
|
*/
|
|
17
15
|
export interface ClassificationRefinement {
|
|
18
16
|
/**
|
|
19
17
|
* The estimated number of results that would be returned if you refine your search by the specified `classificationId`.
|
|
20
|
-
* @type {number}
|
|
21
|
-
* @memberof ClassificationRefinement
|
|
22
18
|
*/
|
|
23
19
|
'numberOfResults': number;
|
|
24
20
|
/**
|
|
25
21
|
* Display name for the classification.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof ClassificationRefinement
|
|
28
22
|
*/
|
|
29
23
|
'displayName': string;
|
|
30
24
|
/**
|
|
31
25
|
* The identifier of the classification that you can use to refine your search.
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof ClassificationRefinement
|
|
34
26
|
*/
|
|
35
27
|
'classificationId': string;
|
|
36
28
|
}
|
|
@@ -11,20 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* The value of an individual dimension for an Amazon catalog item or item package.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface Dimension
|
|
16
14
|
*/
|
|
17
15
|
export interface Dimension {
|
|
18
16
|
/**
|
|
19
17
|
* Unit of measurement for the dimension value.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof Dimension
|
|
22
18
|
*/
|
|
23
19
|
'unit'?: string;
|
|
24
20
|
/**
|
|
25
21
|
* Numeric value of the dimension.
|
|
26
|
-
* @type {number}
|
|
27
|
-
* @memberof Dimension
|
|
28
22
|
*/
|
|
29
23
|
'value'?: number;
|
|
30
24
|
}
|
|
@@ -12,32 +12,10 @@
|
|
|
12
12
|
import type { Dimension } from './dimension';
|
|
13
13
|
/**
|
|
14
14
|
* Dimensions of an Amazon catalog item or item in its packaging.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface Dimensions
|
|
17
15
|
*/
|
|
18
16
|
export interface Dimensions {
|
|
19
|
-
/**
|
|
20
|
-
*
|
|
21
|
-
* @type {Dimension}
|
|
22
|
-
* @memberof Dimensions
|
|
23
|
-
*/
|
|
24
17
|
'height'?: Dimension;
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @type {Dimension}
|
|
28
|
-
* @memberof Dimensions
|
|
29
|
-
*/
|
|
30
18
|
'length'?: Dimension;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {Dimension}
|
|
34
|
-
* @memberof Dimensions
|
|
35
|
-
*/
|
|
36
19
|
'weight'?: Dimension;
|
|
37
|
-
/**
|
|
38
|
-
*
|
|
39
|
-
* @type {Dimension}
|
|
40
|
-
* @memberof Dimensions
|
|
41
|
-
*/
|
|
42
20
|
'width'?: Dimension;
|
|
43
21
|
}
|
|
@@ -11,14 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* A list of error responses returned when a request is unsuccessful.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface ErrorList
|
|
16
14
|
*/
|
|
17
15
|
export interface ErrorList {
|
|
18
|
-
/**
|
|
19
|
-
*
|
|
20
|
-
* @type {Array<Error>}
|
|
21
|
-
* @memberof ErrorList
|
|
22
|
-
*/
|
|
23
16
|
'errors': Array<Error>;
|
|
24
17
|
}
|
|
@@ -11,26 +11,15 @@
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* Classification (browse node) for an Amazon catalog item.
|
|
14
|
-
* @export
|
|
15
|
-
* @interface ItemBrowseClassification
|
|
16
14
|
*/
|
|
17
15
|
export interface ItemBrowseClassification {
|
|
18
16
|
/**
|
|
19
17
|
* Display name for the classification.
|
|
20
|
-
* @type {string}
|
|
21
|
-
* @memberof ItemBrowseClassification
|
|
22
18
|
*/
|
|
23
19
|
'displayName': string;
|
|
24
20
|
/**
|
|
25
21
|
* Identifier of the classification.
|
|
26
|
-
* @type {string}
|
|
27
|
-
* @memberof ItemBrowseClassification
|
|
28
22
|
*/
|
|
29
23
|
'classificationId': string;
|
|
30
|
-
/**
|
|
31
|
-
*
|
|
32
|
-
* @type {ItemBrowseClassification}
|
|
33
|
-
* @memberof ItemBrowseClassification
|
|
34
|
-
*/
|
|
35
24
|
'parent'?: ItemBrowseClassification;
|
|
36
25
|
}
|
|
@@ -12,20 +12,14 @@
|
|
|
12
12
|
import type { ItemBrowseClassification } from './item-browse-classification';
|
|
13
13
|
/**
|
|
14
14
|
* Classifications (browse nodes) that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
|
|
15
|
-
* @export
|
|
16
|
-
* @interface ItemBrowseClassificationsByMarketplace
|
|
17
15
|
*/
|
|
18
16
|
export interface ItemBrowseClassificationsByMarketplace {
|
|
19
17
|
/**
|
|
20
18
|
* Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof ItemBrowseClassificationsByMarketplace
|
|
23
19
|
*/
|
|
24
20
|
'marketplaceId': string;
|
|
25
21
|
/**
|
|
26
22
|
* Classifications (browse nodes) that are associated with the item in the Amazon catalog.
|
|
27
|
-
* @type {Array<ItemBrowseClassification>}
|
|
28
|
-
* @memberof ItemBrowseClassificationsByMarketplace
|
|
29
23
|
*/
|
|
30
24
|
'classifications'?: Array<ItemBrowseClassification>;
|
|
31
25
|
}
|