@sp-api-sdk/catalog-items-api-2022-04-01 1.1.0

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.
Files changed (108) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +108 -0
  3. package/dist/cjs/index.js +5 -0
  4. package/dist/cjs/src/api-model/api/catalog-api.js +263 -0
  5. package/dist/cjs/src/api-model/api.js +17 -0
  6. package/dist/cjs/src/api-model/base.js +62 -0
  7. package/dist/cjs/src/api-model/common.js +137 -0
  8. package/dist/cjs/src/api-model/configuration.js +42 -0
  9. package/dist/cjs/src/api-model/index.js +19 -0
  10. package/dist/cjs/src/api-model/models/brand-refinement.js +15 -0
  11. package/dist/cjs/src/api-model/models/classification-refinement.js +15 -0
  12. package/dist/cjs/src/api-model/models/error-list.js +15 -0
  13. package/dist/cjs/src/api-model/models/index.js +29 -0
  14. package/dist/cjs/src/api-model/models/item-browse-classification.js +15 -0
  15. package/dist/cjs/src/api-model/models/item-classification-sales-rank.js +15 -0
  16. package/dist/cjs/src/api-model/models/item-dimension.js +15 -0
  17. package/dist/cjs/src/api-model/models/item-dimensions-by-marketplace.js +15 -0
  18. package/dist/cjs/src/api-model/models/item-dimensions.js +15 -0
  19. package/dist/cjs/src/api-model/models/item-display-group-sales-rank.js +15 -0
  20. package/dist/cjs/src/api-model/models/item-identifier.js +15 -0
  21. package/dist/cjs/src/api-model/models/item-identifiers-by-marketplace.js +15 -0
  22. package/dist/cjs/src/api-model/models/item-image.js +33 -0
  23. package/dist/cjs/src/api-model/models/item-images-by-marketplace.js +15 -0
  24. package/dist/cjs/src/api-model/models/item-product-type-by-marketplace.js +15 -0
  25. package/dist/cjs/src/api-model/models/item-relationship.js +25 -0
  26. package/dist/cjs/src/api-model/models/item-relationships-by-marketplace.js +15 -0
  27. package/dist/cjs/src/api-model/models/item-sales-ranks-by-marketplace.js +15 -0
  28. package/dist/cjs/src/api-model/models/item-search-results.js +15 -0
  29. package/dist/cjs/src/api-model/models/item-summary-by-marketplace.js +27 -0
  30. package/dist/cjs/src/api-model/models/item-variation-theme.js +15 -0
  31. package/dist/cjs/src/api-model/models/item-vendor-details-by-marketplace.js +33 -0
  32. package/dist/cjs/src/api-model/models/item-vendor-details-category.js +15 -0
  33. package/dist/cjs/src/api-model/models/item.js +15 -0
  34. package/dist/cjs/src/api-model/models/model-error.js +15 -0
  35. package/dist/cjs/src/api-model/models/pagination.js +15 -0
  36. package/dist/cjs/src/api-model/models/refinements.js +15 -0
  37. package/dist/cjs/src/client.js +28 -0
  38. package/dist/es/index.js +2 -0
  39. package/dist/es/src/api-model/api/catalog-api.js +255 -0
  40. package/dist/es/src/api-model/api.js +14 -0
  41. package/dist/es/src/api-model/base.js +56 -0
  42. package/dist/es/src/api-model/common.js +125 -0
  43. package/dist/es/src/api-model/configuration.js +38 -0
  44. package/dist/es/src/api-model/index.js +16 -0
  45. package/dist/es/src/api-model/models/brand-refinement.js +14 -0
  46. package/dist/es/src/api-model/models/classification-refinement.js +14 -0
  47. package/dist/es/src/api-model/models/error-list.js +14 -0
  48. package/dist/es/src/api-model/models/index.js +26 -0
  49. package/dist/es/src/api-model/models/item-browse-classification.js +14 -0
  50. package/dist/es/src/api-model/models/item-classification-sales-rank.js +14 -0
  51. package/dist/es/src/api-model/models/item-dimension.js +14 -0
  52. package/dist/es/src/api-model/models/item-dimensions-by-marketplace.js +14 -0
  53. package/dist/es/src/api-model/models/item-dimensions.js +14 -0
  54. package/dist/es/src/api-model/models/item-display-group-sales-rank.js +14 -0
  55. package/dist/es/src/api-model/models/item-identifier.js +14 -0
  56. package/dist/es/src/api-model/models/item-identifiers-by-marketplace.js +14 -0
  57. package/dist/es/src/api-model/models/item-image.js +30 -0
  58. package/dist/es/src/api-model/models/item-images-by-marketplace.js +14 -0
  59. package/dist/es/src/api-model/models/item-product-type-by-marketplace.js +14 -0
  60. package/dist/es/src/api-model/models/item-relationship.js +22 -0
  61. package/dist/es/src/api-model/models/item-relationships-by-marketplace.js +14 -0
  62. package/dist/es/src/api-model/models/item-sales-ranks-by-marketplace.js +14 -0
  63. package/dist/es/src/api-model/models/item-search-results.js +14 -0
  64. package/dist/es/src/api-model/models/item-summary-by-marketplace.js +24 -0
  65. package/dist/es/src/api-model/models/item-variation-theme.js +14 -0
  66. package/dist/es/src/api-model/models/item-vendor-details-by-marketplace.js +30 -0
  67. package/dist/es/src/api-model/models/item-vendor-details-category.js +14 -0
  68. package/dist/es/src/api-model/models/item.js +14 -0
  69. package/dist/es/src/api-model/models/model-error.js +14 -0
  70. package/dist/es/src/api-model/models/pagination.js +14 -0
  71. package/dist/es/src/api-model/models/refinements.js +14 -0
  72. package/dist/es/src/client.js +24 -0
  73. package/dist/types/index.d.ts +2 -0
  74. package/dist/types/src/api-model/api/catalog-api.d.ts +252 -0
  75. package/dist/types/src/api-model/api.d.ts +12 -0
  76. package/dist/types/src/api-model/base.d.ts +55 -0
  77. package/dist/types/src/api-model/common.d.ts +65 -0
  78. package/dist/types/src/api-model/configuration.d.ts +83 -0
  79. package/dist/types/src/api-model/index.d.ts +14 -0
  80. package/dist/types/src/api-model/models/brand-refinement.d.ts +30 -0
  81. package/dist/types/src/api-model/models/classification-refinement.d.ts +36 -0
  82. package/dist/types/src/api-model/models/error-list.d.ts +24 -0
  83. package/dist/types/src/api-model/models/index.d.ts +26 -0
  84. package/dist/types/src/api-model/models/item-browse-classification.d.ts +30 -0
  85. package/dist/types/src/api-model/models/item-classification-sales-rank.d.ts +42 -0
  86. package/dist/types/src/api-model/models/item-dimension.d.ts +30 -0
  87. package/dist/types/src/api-model/models/item-dimensions-by-marketplace.d.ts +37 -0
  88. package/dist/types/src/api-model/models/item-dimensions.d.ts +43 -0
  89. package/dist/types/src/api-model/models/item-display-group-sales-rank.d.ts +42 -0
  90. package/dist/types/src/api-model/models/item-identifier.d.ts +30 -0
  91. package/dist/types/src/api-model/models/item-identifiers-by-marketplace.d.ts +31 -0
  92. package/dist/types/src/api-model/models/item-image.d.ts +58 -0
  93. package/dist/types/src/api-model/models/item-images-by-marketplace.d.ts +31 -0
  94. package/dist/types/src/api-model/models/item-product-type-by-marketplace.d.ts +30 -0
  95. package/dist/types/src/api-model/models/item-relationship.d.ts +51 -0
  96. package/dist/types/src/api-model/models/item-relationships-by-marketplace.d.ts +31 -0
  97. package/dist/types/src/api-model/models/item-sales-ranks-by-marketplace.d.ts +38 -0
  98. package/dist/types/src/api-model/models/item-search-results.d.ts +45 -0
  99. package/dist/types/src/api-model/models/item-summary-by-marketplace.d.ts +107 -0
  100. package/dist/types/src/api-model/models/item-variation-theme.d.ts +30 -0
  101. package/dist/types/src/api-model/models/item-vendor-details-by-marketplace.d.ts +83 -0
  102. package/dist/types/src/api-model/models/item-vendor-details-category.d.ts +30 -0
  103. package/dist/types/src/api-model/models/item.d.ts +86 -0
  104. package/dist/types/src/api-model/models/model-error.d.ts +36 -0
  105. package/dist/types/src/api-model/models/pagination.d.ts +30 -0
  106. package/dist/types/src/api-model/models/refinements.d.ts +32 -0
  107. package/dist/types/src/client.d.ts +6 -0
  108. package/package.json +54 -0
@@ -0,0 +1,255 @@
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
+ import globalAxios from 'axios';
15
+ // Some imports not used depending on template conditions
16
+ // @ts-ignore
17
+ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from '../common';
18
+ // @ts-ignore
19
+ import { BASE_PATH, COLLECTION_FORMATS, BaseAPI } from '../base';
20
+ /**
21
+ * CatalogApi - axios parameter creator
22
+ * @export
23
+ */
24
+ export const CatalogApiAxiosParamCreator = function (configuration) {
25
+ return {
26
+ /**
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
+ * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
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
+ * @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: &#x60;summaries&#x60;.
31
+ * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ getCatalogItem: async (asin, marketplaceIds, includedData, locale, options = {}) => {
36
+ // verify required parameter 'asin' is not null or undefined
37
+ assertParamExists('getCatalogItem', 'asin', asin);
38
+ // verify required parameter 'marketplaceIds' is not null or undefined
39
+ assertParamExists('getCatalogItem', 'marketplaceIds', marketplaceIds);
40
+ const localVarPath = `/catalog/2022-04-01/items/{asin}`
41
+ .replace(`{${"asin"}}`, encodeURIComponent(String(asin)));
42
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
43
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
44
+ let baseOptions;
45
+ if (configuration) {
46
+ baseOptions = configuration.baseOptions;
47
+ }
48
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
49
+ const localVarHeaderParameter = {};
50
+ const localVarQueryParameter = {};
51
+ if (marketplaceIds) {
52
+ localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
53
+ }
54
+ if (includedData) {
55
+ localVarQueryParameter['includedData'] = includedData.join(COLLECTION_FORMATS.csv);
56
+ }
57
+ if (locale !== undefined) {
58
+ localVarQueryParameter['locale'] = locale;
59
+ }
60
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
61
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
62
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
63
+ return {
64
+ url: toPathString(localVarUrlObj),
65
+ options: localVarRequestOptions,
66
+ };
67
+ },
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 | | ---- | ---- | | 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
+ * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
71
+ * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
72
+ * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
73
+ * @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: &#x60;summaries&#x60;.
74
+ * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
75
+ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
76
+ * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
77
+ * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
78
+ * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
79
+ * @param {number} [pageSize] Number of results to be returned per page.
80
+ * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
81
+ * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ */
85
+ searchCatalogItems: async (marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options = {}) => {
86
+ // verify required parameter 'marketplaceIds' is not null or undefined
87
+ assertParamExists('searchCatalogItems', 'marketplaceIds', marketplaceIds);
88
+ const localVarPath = `/catalog/2022-04-01/items`;
89
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
90
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
91
+ let baseOptions;
92
+ if (configuration) {
93
+ baseOptions = configuration.baseOptions;
94
+ }
95
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
96
+ const localVarHeaderParameter = {};
97
+ const localVarQueryParameter = {};
98
+ if (identifiers) {
99
+ localVarQueryParameter['identifiers'] = identifiers.join(COLLECTION_FORMATS.csv);
100
+ }
101
+ if (identifiersType !== undefined) {
102
+ localVarQueryParameter['identifiersType'] = identifiersType;
103
+ }
104
+ if (marketplaceIds) {
105
+ localVarQueryParameter['marketplaceIds'] = marketplaceIds.join(COLLECTION_FORMATS.csv);
106
+ }
107
+ if (includedData) {
108
+ localVarQueryParameter['includedData'] = includedData.join(COLLECTION_FORMATS.csv);
109
+ }
110
+ if (locale !== undefined) {
111
+ localVarQueryParameter['locale'] = locale;
112
+ }
113
+ if (sellerId !== undefined) {
114
+ localVarQueryParameter['sellerId'] = sellerId;
115
+ }
116
+ if (keywords) {
117
+ localVarQueryParameter['keywords'] = keywords.join(COLLECTION_FORMATS.csv);
118
+ }
119
+ if (brandNames) {
120
+ localVarQueryParameter['brandNames'] = brandNames.join(COLLECTION_FORMATS.csv);
121
+ }
122
+ if (classificationIds) {
123
+ localVarQueryParameter['classificationIds'] = classificationIds.join(COLLECTION_FORMATS.csv);
124
+ }
125
+ if (pageSize !== undefined) {
126
+ localVarQueryParameter['pageSize'] = pageSize;
127
+ }
128
+ if (pageToken !== undefined) {
129
+ localVarQueryParameter['pageToken'] = pageToken;
130
+ }
131
+ if (keywordsLocale !== undefined) {
132
+ localVarQueryParameter['keywordsLocale'] = keywordsLocale;
133
+ }
134
+ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
135
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
136
+ localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
137
+ return {
138
+ url: toPathString(localVarUrlObj),
139
+ options: localVarRequestOptions,
140
+ };
141
+ },
142
+ };
143
+ };
144
+ /**
145
+ * CatalogApi - functional programming interface
146
+ * @export
147
+ */
148
+ export const CatalogApiFp = function (configuration) {
149
+ const localVarAxiosParamCreator = CatalogApiAxiosParamCreator(configuration);
150
+ return {
151
+ /**
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
+ * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
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
+ * @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: &#x60;summaries&#x60;.
156
+ * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
157
+ * @param {*} [options] Override http request option.
158
+ * @throws {RequiredError}
159
+ */
160
+ async getCatalogItem(asin, marketplaceIds, includedData, locale, options) {
161
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCatalogItem(asin, marketplaceIds, includedData, locale, options);
162
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
163
+ },
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 | | ---- | ---- | | 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
+ * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
167
+ * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
168
+ * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
169
+ * @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: &#x60;summaries&#x60;.
170
+ * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
171
+ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
172
+ * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
173
+ * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
174
+ * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
175
+ * @param {number} [pageSize] Number of results to be returned per page.
176
+ * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
177
+ * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
178
+ * @param {*} [options] Override http request option.
179
+ * @throws {RequiredError}
180
+ */
181
+ async searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options) {
182
+ const localVarAxiosArgs = await localVarAxiosParamCreator.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options);
183
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
184
+ },
185
+ };
186
+ };
187
+ /**
188
+ * CatalogApi - factory interface
189
+ * @export
190
+ */
191
+ export const CatalogApiFactory = function (configuration, basePath, axios) {
192
+ const localVarFp = CatalogApiFp(configuration);
193
+ return {
194
+ /**
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
+ * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
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
+ * @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: &#x60;summaries&#x60;.
199
+ * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
200
+ * @param {*} [options] Override http request option.
201
+ * @throws {RequiredError}
202
+ */
203
+ getCatalogItem(asin, marketplaceIds, includedData, locale, options) {
204
+ return localVarFp.getCatalogItem(asin, marketplaceIds, includedData, locale, options).then((request) => request(axios, basePath));
205
+ },
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 | | ---- | ---- | | 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
+ * @param {Array<string>} marketplaceIds A comma-delimited list of Amazon marketplace identifiers for the request.
209
+ * @param {Array<string>} [identifiers] A comma-delimited list of product identifiers to search the Amazon catalog for. **Note:** Cannot be used with &#x60;keywords&#x60;.
210
+ * @param {'ASIN' | 'EAN' | 'GTIN' | 'ISBN' | 'JAN' | 'MINSAN' | 'SKU' | 'UPC'} [identifiersType] Type of product identifiers to search the Amazon catalog for. **Note:** Required when &#x60;identifiers&#x60; are provided.
211
+ * @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: &#x60;summaries&#x60;.
212
+ * @param {string} [locale] Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.
213
+ * @param {string} [sellerId] A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
214
+ * @param {Array<string>} [keywords] A comma-delimited list of words to search the Amazon catalog for. **Note:** Cannot be used with &#x60;identifiers&#x60;.
215
+ * @param {Array<string>} [brandNames] A comma-delimited list of brand names to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
216
+ * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers to limit the search for &#x60;keywords&#x60;-based queries. **Note:** Cannot be used with &#x60;identifiers&#x60;.
217
+ * @param {number} [pageSize] Number of results to be returned per page.
218
+ * @param {string} [pageToken] A token to fetch a certain page when there are multiple pages worth of results.
219
+ * @param {string} [keywordsLocale] The language of the keywords provided for &#x60;keywords&#x60;-based queries. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options) {
224
+ return localVarFp.searchCatalogItems(marketplaceIds, identifiers, identifiersType, includedData, locale, sellerId, keywords, brandNames, classificationIds, pageSize, pageToken, keywordsLocale, options).then((request) => request(axios, basePath));
225
+ },
226
+ };
227
+ };
228
+ /**
229
+ * CatalogApi - object-oriented interface
230
+ * @export
231
+ * @class CatalogApi
232
+ * @extends {BaseAPI}
233
+ */
234
+ export class CatalogApi extends BaseAPI {
235
+ /**
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
+ * @param {CatalogApiGetCatalogItemRequest} requestParameters Request parameters.
238
+ * @param {*} [options] Override http request option.
239
+ * @throws {RequiredError}
240
+ * @memberof CatalogApi
241
+ */
242
+ getCatalogItem(requestParameters, options) {
243
+ return CatalogApiFp(this.configuration).getCatalogItem(requestParameters.asin, requestParameters.marketplaceIds, requestParameters.includedData, requestParameters.locale, options).then((request) => request(this.axios, this.basePath));
244
+ }
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 | | ---- | ---- | | 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
+ * @param {CatalogApiSearchCatalogItemsRequest} requestParameters Request parameters.
248
+ * @param {*} [options] Override http request option.
249
+ * @throws {RequiredError}
250
+ * @memberof CatalogApi
251
+ */
252
+ searchCatalogItems(requestParameters, options) {
253
+ return CatalogApiFp(this.configuration).searchCatalogItems(requestParameters.marketplaceIds, requestParameters.identifiers, requestParameters.identifiersType, requestParameters.includedData, requestParameters.locale, requestParameters.sellerId, requestParameters.keywords, requestParameters.brandNames, requestParameters.classificationIds, requestParameters.pageSize, requestParameters.pageToken, requestParameters.keywordsLocale, options).then((request) => request(this.axios, this.basePath));
254
+ }
255
+ }
@@ -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 * from './api/catalog-api';
@@ -0,0 +1,56 @@
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
+ // Some imports not used depending on template conditions
15
+ // @ts-ignore
16
+ import globalAxios from 'axios';
17
+ export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
18
+ /**
19
+ *
20
+ * @export
21
+ */
22
+ export const COLLECTION_FORMATS = {
23
+ csv: ",",
24
+ ssv: " ",
25
+ tsv: "\t",
26
+ pipes: "|",
27
+ };
28
+ /**
29
+ *
30
+ * @export
31
+ * @class BaseAPI
32
+ */
33
+ export class BaseAPI {
34
+ constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
35
+ this.basePath = basePath;
36
+ this.axios = axios;
37
+ if (configuration) {
38
+ this.configuration = configuration;
39
+ this.basePath = configuration.basePath || this.basePath;
40
+ }
41
+ }
42
+ }
43
+ ;
44
+ /**
45
+ *
46
+ * @export
47
+ * @class RequiredError
48
+ * @extends {Error}
49
+ */
50
+ export class RequiredError extends Error {
51
+ constructor(field, msg) {
52
+ super(msg);
53
+ this.field = field;
54
+ this.name = "RequiredError";
55
+ }
56
+ }
@@ -0,0 +1,125 @@
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
+ import { RequiredError } from "./base";
15
+ /**
16
+ *
17
+ * @export
18
+ */
19
+ export const DUMMY_BASE_URL = 'https://example.com';
20
+ /**
21
+ *
22
+ * @throws {RequiredError}
23
+ * @export
24
+ */
25
+ export const assertParamExists = function (functionName, paramName, paramValue) {
26
+ if (paramValue === null || paramValue === undefined) {
27
+ throw new RequiredError(paramName, `Required parameter ${paramName} was null or undefined when calling ${functionName}.`);
28
+ }
29
+ };
30
+ /**
31
+ *
32
+ * @export
33
+ */
34
+ export const setApiKeyToObject = async function (object, keyParamName, configuration) {
35
+ if (configuration && configuration.apiKey) {
36
+ const localVarApiKeyValue = typeof configuration.apiKey === 'function'
37
+ ? await configuration.apiKey(keyParamName)
38
+ : await configuration.apiKey;
39
+ object[keyParamName] = localVarApiKeyValue;
40
+ }
41
+ };
42
+ /**
43
+ *
44
+ * @export
45
+ */
46
+ export const setBasicAuthToObject = function (object, configuration) {
47
+ if (configuration && (configuration.username || configuration.password)) {
48
+ object["auth"] = { username: configuration.username, password: configuration.password };
49
+ }
50
+ };
51
+ /**
52
+ *
53
+ * @export
54
+ */
55
+ export const setBearerAuthToObject = async function (object, configuration) {
56
+ if (configuration && configuration.accessToken) {
57
+ const accessToken = typeof configuration.accessToken === 'function'
58
+ ? await configuration.accessToken()
59
+ : await configuration.accessToken;
60
+ object["Authorization"] = "Bearer " + accessToken;
61
+ }
62
+ };
63
+ /**
64
+ *
65
+ * @export
66
+ */
67
+ export const setOAuthToObject = async function (object, name, scopes, configuration) {
68
+ if (configuration && configuration.accessToken) {
69
+ const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
70
+ ? await configuration.accessToken(name, scopes)
71
+ : await configuration.accessToken;
72
+ object["Authorization"] = "Bearer " + localVarAccessTokenValue;
73
+ }
74
+ };
75
+ /**
76
+ *
77
+ * @export
78
+ */
79
+ export const setSearchParams = function (url, ...objects) {
80
+ const searchParams = new URLSearchParams(url.search);
81
+ for (const object of objects) {
82
+ for (const key in object) {
83
+ if (Array.isArray(object[key])) {
84
+ searchParams.delete(key);
85
+ for (const item of object[key]) {
86
+ searchParams.append(key, item);
87
+ }
88
+ }
89
+ else {
90
+ searchParams.set(key, object[key]);
91
+ }
92
+ }
93
+ }
94
+ url.search = searchParams.toString();
95
+ };
96
+ /**
97
+ *
98
+ * @export
99
+ */
100
+ export const serializeDataIfNeeded = function (value, requestOptions, configuration) {
101
+ const nonString = typeof value !== 'string';
102
+ const needsSerialization = nonString && configuration && configuration.isJsonMime
103
+ ? configuration.isJsonMime(requestOptions.headers['Content-Type'])
104
+ : nonString;
105
+ return needsSerialization
106
+ ? JSON.stringify(value !== undefined ? value : {})
107
+ : (value || "");
108
+ };
109
+ /**
110
+ *
111
+ * @export
112
+ */
113
+ export const toPathString = function (url) {
114
+ return url.pathname + url.search + url.hash;
115
+ };
116
+ /**
117
+ *
118
+ * @export
119
+ */
120
+ export const createRequestFunction = function (axiosArgs, globalAxios, BASE_PATH, configuration) {
121
+ return (axios = globalAxios, basePath = BASE_PATH) => {
122
+ const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url };
123
+ return axios.request(axiosRequestArgs);
124
+ };
125
+ };
@@ -0,0 +1,38 @@
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 class Configuration {
15
+ constructor(param = {}) {
16
+ this.apiKey = param.apiKey;
17
+ this.username = param.username;
18
+ this.password = param.password;
19
+ this.accessToken = param.accessToken;
20
+ this.basePath = param.basePath;
21
+ this.baseOptions = param.baseOptions;
22
+ this.formDataCtor = param.formDataCtor;
23
+ }
24
+ /**
25
+ * Check if the given MIME is a JSON MIME.
26
+ * JSON MIME examples:
27
+ * application/json
28
+ * application/json; charset=UTF8
29
+ * APPLICATION/JSON
30
+ * application/vnd.company+json
31
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
32
+ * @return True if the given MIME is JSON, false otherwise.
33
+ */
34
+ isJsonMime(mime) {
35
+ const jsonMime = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i');
36
+ return mime !== null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json');
37
+ }
38
+ }
@@ -0,0 +1,16 @@
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 * from "./api";
15
+ export * from "./configuration";
16
+ export * from "./models";
@@ -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 {};
@@ -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,26 @@
1
+ export * from './brand-refinement';
2
+ export * from './classification-refinement';
3
+ export * from './error-list';
4
+ export * from './item';
5
+ export * from './item-browse-classification';
6
+ export * from './item-classification-sales-rank';
7
+ export * from './item-dimension';
8
+ export * from './item-dimensions';
9
+ export * from './item-dimensions-by-marketplace';
10
+ export * from './item-display-group-sales-rank';
11
+ export * from './item-identifier';
12
+ export * from './item-identifiers-by-marketplace';
13
+ export * from './item-image';
14
+ export * from './item-images-by-marketplace';
15
+ export * from './item-product-type-by-marketplace';
16
+ export * from './item-relationship';
17
+ export * from './item-relationships-by-marketplace';
18
+ export * from './item-sales-ranks-by-marketplace';
19
+ export * from './item-search-results';
20
+ export * from './item-summary-by-marketplace';
21
+ export * from './item-variation-theme';
22
+ export * from './item-vendor-details-by-marketplace';
23
+ export * from './item-vendor-details-category';
24
+ export * from './model-error';
25
+ export * from './pagination';
26
+ export * from './refinements';
@@ -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 {};
@@ -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 {};