@sp-api-sdk/catalog-items-api-2022-04-01 4.2.12 → 5.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 (122) hide show
  1. package/README.md +7 -8
  2. package/dist/index.cjs +479 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +1132 -0
  5. package/dist/index.d.ts +1132 -0
  6. package/dist/index.js +443 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +26 -12
  9. package/dist/cjs/api-model/api/catalog-items-api.js +0 -283
  10. package/dist/cjs/api-model/api.js +0 -30
  11. package/dist/cjs/api-model/base.js +0 -52
  12. package/dist/cjs/api-model/common.js +0 -123
  13. package/dist/cjs/api-model/configuration.js +0 -98
  14. package/dist/cjs/api-model/index.js +0 -32
  15. package/dist/cjs/api-model/models/brand-refinement.js +0 -15
  16. package/dist/cjs/api-model/models/classification-refinement.js +0 -15
  17. package/dist/cjs/api-model/models/dimension.js +0 -15
  18. package/dist/cjs/api-model/models/dimensions.js +0 -15
  19. package/dist/cjs/api-model/models/error-list.js +0 -15
  20. package/dist/cjs/api-model/models/index.js +0 -45
  21. package/dist/cjs/api-model/models/item-browse-classification.js +0 -15
  22. package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +0 -15
  23. package/dist/cjs/api-model/models/item-classification-sales-rank.js +0 -15
  24. package/dist/cjs/api-model/models/item-contributor-role.js +0 -15
  25. package/dist/cjs/api-model/models/item-contributor.js +0 -15
  26. package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +0 -15
  27. package/dist/cjs/api-model/models/item-display-group-sales-rank.js +0 -15
  28. package/dist/cjs/api-model/models/item-identifier.js +0 -15
  29. package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +0 -15
  30. package/dist/cjs/api-model/models/item-image.js +0 -28
  31. package/dist/cjs/api-model/models/item-images-by-marketplace.js +0 -15
  32. package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +0 -15
  33. package/dist/cjs/api-model/models/item-relationship.js +0 -20
  34. package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +0 -15
  35. package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +0 -15
  36. package/dist/cjs/api-model/models/item-search-results.js +0 -15
  37. package/dist/cjs/api-model/models/item-summary-by-marketplace.js +0 -22
  38. package/dist/cjs/api-model/models/item-variation-theme.js +0 -15
  39. package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +0 -28
  40. package/dist/cjs/api-model/models/item-vendor-details-category.js +0 -15
  41. package/dist/cjs/api-model/models/item.js +0 -15
  42. package/dist/cjs/api-model/models/model-error.js +0 -15
  43. package/dist/cjs/api-model/models/pagination.js +0 -15
  44. package/dist/cjs/api-model/models/refinements.js +0 -15
  45. package/dist/cjs/client.js +0 -28
  46. package/dist/cjs/index.js +0 -19
  47. package/dist/es/api-model/api/catalog-items-api.js +0 -273
  48. package/dist/es/api-model/api.js +0 -14
  49. package/dist/es/api-model/base.js +0 -44
  50. package/dist/es/api-model/common.js +0 -110
  51. package/dist/es/api-model/configuration.js +0 -94
  52. package/dist/es/api-model/index.js +0 -16
  53. package/dist/es/api-model/models/brand-refinement.js +0 -14
  54. package/dist/es/api-model/models/classification-refinement.js +0 -14
  55. package/dist/es/api-model/models/dimension.js +0 -14
  56. package/dist/es/api-model/models/dimensions.js +0 -14
  57. package/dist/es/api-model/models/error-list.js +0 -14
  58. package/dist/es/api-model/models/index.js +0 -29
  59. package/dist/es/api-model/models/item-browse-classification.js +0 -14
  60. package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +0 -14
  61. package/dist/es/api-model/models/item-classification-sales-rank.js +0 -14
  62. package/dist/es/api-model/models/item-contributor-role.js +0 -14
  63. package/dist/es/api-model/models/item-contributor.js +0 -14
  64. package/dist/es/api-model/models/item-dimensions-by-marketplace.js +0 -14
  65. package/dist/es/api-model/models/item-display-group-sales-rank.js +0 -14
  66. package/dist/es/api-model/models/item-identifier.js +0 -14
  67. package/dist/es/api-model/models/item-identifiers-by-marketplace.js +0 -14
  68. package/dist/es/api-model/models/item-image.js +0 -25
  69. package/dist/es/api-model/models/item-images-by-marketplace.js +0 -14
  70. package/dist/es/api-model/models/item-product-type-by-marketplace.js +0 -14
  71. package/dist/es/api-model/models/item-relationship.js +0 -17
  72. package/dist/es/api-model/models/item-relationships-by-marketplace.js +0 -14
  73. package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +0 -14
  74. package/dist/es/api-model/models/item-search-results.js +0 -14
  75. package/dist/es/api-model/models/item-summary-by-marketplace.js +0 -19
  76. package/dist/es/api-model/models/item-variation-theme.js +0 -14
  77. package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +0 -25
  78. package/dist/es/api-model/models/item-vendor-details-category.js +0 -14
  79. package/dist/es/api-model/models/item.js +0 -14
  80. package/dist/es/api-model/models/model-error.js +0 -14
  81. package/dist/es/api-model/models/pagination.js +0 -14
  82. package/dist/es/api-model/models/refinements.js +0 -14
  83. package/dist/es/client.js +0 -24
  84. package/dist/es/index.js +0 -3
  85. package/dist/types/api-model/api/catalog-items-api.d.ts +0 -232
  86. package/dist/types/api-model/api.d.ts +0 -12
  87. package/dist/types/api-model/base.d.ts +0 -42
  88. package/dist/types/api-model/common.d.ts +0 -34
  89. package/dist/types/api-model/configuration.d.ts +0 -98
  90. package/dist/types/api-model/index.d.ts +0 -14
  91. package/dist/types/api-model/models/brand-refinement.d.ts +0 -24
  92. package/dist/types/api-model/models/classification-refinement.d.ts +0 -28
  93. package/dist/types/api-model/models/dimension.d.ts +0 -24
  94. package/dist/types/api-model/models/dimensions.d.ts +0 -21
  95. package/dist/types/api-model/models/error-list.d.ts +0 -20
  96. package/dist/types/api-model/models/index.d.ts +0 -29
  97. package/dist/types/api-model/models/item-browse-classification.d.ts +0 -25
  98. package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +0 -25
  99. package/dist/types/api-model/models/item-classification-sales-rank.d.ts +0 -32
  100. package/dist/types/api-model/models/item-contributor-role.d.ts +0 -24
  101. package/dist/types/api-model/models/item-contributor.d.ts +0 -22
  102. package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +0 -23
  103. package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +0 -32
  104. package/dist/types/api-model/models/item-identifier.d.ts +0 -24
  105. package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +0 -25
  106. package/dist/types/api-model/models/item-image.d.ts +0 -45
  107. package/dist/types/api-model/models/item-images-by-marketplace.d.ts +0 -25
  108. package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +0 -24
  109. package/dist/types/api-model/models/item-relationship.d.ts +0 -35
  110. package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +0 -25
  111. package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +0 -30
  112. package/dist/types/api-model/models/item-search-results.d.ts +0 -29
  113. package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +0 -102
  114. package/dist/types/api-model/models/item-variation-theme.d.ts +0 -24
  115. package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +0 -56
  116. package/dist/types/api-model/models/item-vendor-details-category.d.ts +0 -24
  117. package/dist/types/api-model/models/item.d.ts +0 -71
  118. package/dist/types/api-model/models/model-error.d.ts +0 -28
  119. package/dist/types/api-model/models/pagination.d.ts +0 -24
  120. package/dist/types/api-model/models/refinements.d.ts +0 -26
  121. package/dist/types/client.d.ts +0 -6
  122. package/dist/types/index.d.ts +0 -3
@@ -1,232 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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 type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- import globalAxios from 'axios';
15
- import { type RequestArgs, BaseAPI } from '../base';
16
- import type { Item } from '../models';
17
- import type { ItemSearchResults } from '../models';
18
- /**
19
- * CatalogItemsApi - axios parameter creator
20
- */
21
- export declare const CatalogItemsApiAxiosParamCreator: (configuration?: Configuration) => {
22
- /**
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).
24
- * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
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).
26
- * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
27
- * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
28
- * @param {*} [options] Override http request option.
29
- * @throws {RequiredError}
30
- */
31
- getCatalogItem: (asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
32
- /**
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).
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).
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 &#x60;identifiers&#x60; and &#x60;keywords&#x60; in the same request.
36
- * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** &#x60;identifiersType&#x60; is required when &#x60;identifiers&#x60; is in the request.
37
- * @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
38
- * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
39
- * @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;.
40
- * @param {Array<string>} [keywords] A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;keywords&#x60; and &#x60;identifiers&#x60; in the same request.
41
- * @param {Array<string>} [brandNames] A comma-delimited list of brand names that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
42
- * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
43
- * @param {number} [pageSize] The number of results to include on each page.
44
- * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results.
45
- * @param {string} [keywordsLocale] The language of the keywords that are included in queries based on &#x60;keywords&#x60;. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
46
- * @param {*} [options] Override http request option.
47
- * @throws {RequiredError}
48
- */
49
- searchCatalogItems: (marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50
- };
51
- /**
52
- * CatalogItemsApi - functional programming interface
53
- */
54
- export declare const CatalogItemsApiFp: (configuration?: Configuration) => {
55
- /**
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).
57
- * @param {string} asin The Amazon Standard Identification Number (ASIN) of the item.
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).
59
- * @param {Array<GetCatalogItemIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
60
- * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
61
- * @param {*} [options] Override http request option.
62
- * @throws {RequiredError}
63
- */
64
- getCatalogItem(asin: string, marketplaceIds: Array<string>, includedData?: Array<GetCatalogItemIncludedDataEnum>, locale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Item>>;
65
- /**
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).
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).
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 &#x60;identifiers&#x60; and &#x60;keywords&#x60; in the same request.
69
- * @param {SearchCatalogItemsIdentifiersTypeEnum} [identifiersType] The type of product identifiers that you can use to search the Amazon catalog. **Note:** &#x60;identifiersType&#x60; is required when &#x60;identifiers&#x60; is in the request.
70
- * @param {Array<SearchCatalogItemsIncludedDataEnum>} [includedData] A comma-delimited list of datasets to include in the response.
71
- * @param {string} [locale] The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
72
- * @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;.
73
- * @param {Array<string>} [keywords] A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;keywords&#x60; and &#x60;identifiers&#x60; in the same request.
74
- * @param {Array<string>} [brandNames] A comma-delimited list of brand names that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
75
- * @param {Array<string>} [classificationIds] A comma-delimited list of classification identifiers that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
76
- * @param {number} [pageSize] The number of results to include on each page.
77
- * @param {string} [pageToken] A token that you can use to fetch a specific page when there are multiple pages of results.
78
- * @param {string} [keywordsLocale] The language of the keywords that are included in queries based on &#x60;keywords&#x60;. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
79
- * @param {*} [options] Override http request option.
80
- * @throws {RequiredError}
81
- */
82
- searchCatalogItems(marketplaceIds: Array<string>, identifiers?: Array<string>, identifiersType?: SearchCatalogItemsIdentifiersTypeEnum, includedData?: Array<SearchCatalogItemsIncludedDataEnum>, locale?: string, sellerId?: string, keywords?: Array<string>, brandNames?: Array<string>, classificationIds?: Array<string>, pageSize?: number, pageToken?: string, keywordsLocale?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemSearchResults>>;
83
- };
84
- /**
85
- * CatalogItemsApi - factory interface
86
- */
87
- export declare const CatalogItemsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
88
- /**
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).
90
- * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
91
- * @param {*} [options] Override http request option.
92
- * @throws {RequiredError}
93
- */
94
- getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<Item>;
95
- /**
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).
97
- * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
98
- * @param {*} [options] Override http request option.
99
- * @throws {RequiredError}
100
- */
101
- searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ItemSearchResults>;
102
- };
103
- /**
104
- * Request parameters for getCatalogItem operation in CatalogItemsApi.
105
- */
106
- export interface CatalogItemsApiGetCatalogItemRequest {
107
- /**
108
- * The Amazon Standard Identification Number (ASIN) of the item.
109
- */
110
- readonly asin: string;
111
- /**
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).
113
- */
114
- readonly marketplaceIds: Array<string>;
115
- /**
116
- * A comma-delimited list of datasets to include in the response.
117
- */
118
- readonly includedData?: Array<GetCatalogItemIncludedDataEnum>;
119
- /**
120
- * The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
121
- */
122
- readonly locale?: string;
123
- }
124
- /**
125
- * Request parameters for searchCatalogItems operation in CatalogItemsApi.
126
- */
127
- export interface CatalogItemsApiSearchCatalogItemsRequest {
128
- /**
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).
130
- */
131
- readonly marketplaceIds: Array<string>;
132
- /**
133
- * A comma-delimited list of product identifiers that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;identifiers&#x60; and &#x60;keywords&#x60; in the same request.
134
- */
135
- readonly identifiers?: Array<string>;
136
- /**
137
- * The type of product identifiers that you can use to search the Amazon catalog. **Note:** &#x60;identifiersType&#x60; is required when &#x60;identifiers&#x60; is in the request.
138
- */
139
- readonly identifiersType?: SearchCatalogItemsIdentifiersTypeEnum;
140
- /**
141
- * A comma-delimited list of datasets to include in the response.
142
- */
143
- readonly includedData?: Array<SearchCatalogItemsIncludedDataEnum>;
144
- /**
145
- * The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.
146
- */
147
- readonly locale?: string;
148
- /**
149
- * A selling partner identifier, such as a seller account or vendor code. **Note:** Required when &#x60;identifiersType&#x60; is &#x60;SKU&#x60;.
150
- */
151
- readonly sellerId?: string;
152
- /**
153
- * A comma-delimited list of keywords that you can use to search the Amazon catalog. **Note:** You cannot include &#x60;keywords&#x60; and &#x60;identifiers&#x60; in the same request.
154
- */
155
- readonly keywords?: Array<string>;
156
- /**
157
- * A comma-delimited list of brand names that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
158
- */
159
- readonly brandNames?: Array<string>;
160
- /**
161
- * A comma-delimited list of classification identifiers that you can use to limit the search in queries based on &#x60;keywords&#x60;. **Note:** Cannot be used with &#x60;identifiers&#x60;.
162
- */
163
- readonly classificationIds?: Array<string>;
164
- /**
165
- * The number of results to include on each page.
166
- */
167
- readonly pageSize?: number;
168
- /**
169
- * A token that you can use to fetch a specific page when there are multiple pages of results.
170
- */
171
- readonly pageToken?: string;
172
- /**
173
- * The language of the keywords that are included in queries based on &#x60;keywords&#x60;. Defaults to the primary locale of the marketplace. **Note:** Cannot be used with &#x60;identifiers&#x60;.
174
- */
175
- readonly keywordsLocale?: string;
176
- }
177
- /**
178
- * CatalogItemsApi - object-oriented interface
179
- */
180
- export declare class CatalogItemsApi extends BaseAPI {
181
- /**
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).
183
- * @param {CatalogItemsApiGetCatalogItemRequest} requestParameters Request parameters.
184
- * @param {*} [options] Override http request option.
185
- * @throws {RequiredError}
186
- */
187
- getCatalogItem(requestParameters: CatalogItemsApiGetCatalogItemRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<Item, any, {}>>;
188
- /**
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).
190
- * @param {CatalogItemsApiSearchCatalogItemsRequest} requestParameters Request parameters.
191
- * @param {*} [options] Override http request option.
192
- * @throws {RequiredError}
193
- */
194
- searchCatalogItems(requestParameters: CatalogItemsApiSearchCatalogItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ItemSearchResults, any, {}>>;
195
- }
196
- export declare const GetCatalogItemIncludedDataEnum: {
197
- readonly Attributes: "attributes";
198
- readonly Classifications: "classifications";
199
- readonly Dimensions: "dimensions";
200
- readonly Identifiers: "identifiers";
201
- readonly Images: "images";
202
- readonly ProductTypes: "productTypes";
203
- readonly Relationships: "relationships";
204
- readonly SalesRanks: "salesRanks";
205
- readonly Summaries: "summaries";
206
- readonly VendorDetails: "vendorDetails";
207
- };
208
- export type GetCatalogItemIncludedDataEnum = typeof GetCatalogItemIncludedDataEnum[keyof typeof GetCatalogItemIncludedDataEnum];
209
- export declare const SearchCatalogItemsIdentifiersTypeEnum: {
210
- readonly Asin: "ASIN";
211
- readonly Ean: "EAN";
212
- readonly Gtin: "GTIN";
213
- readonly Isbn: "ISBN";
214
- readonly Jan: "JAN";
215
- readonly Minsan: "MINSAN";
216
- readonly Sku: "SKU";
217
- readonly Upc: "UPC";
218
- };
219
- export type SearchCatalogItemsIdentifiersTypeEnum = typeof SearchCatalogItemsIdentifiersTypeEnum[keyof typeof SearchCatalogItemsIdentifiersTypeEnum];
220
- export declare const SearchCatalogItemsIncludedDataEnum: {
221
- readonly Attributes: "attributes";
222
- readonly Classifications: "classifications";
223
- readonly Dimensions: "dimensions";
224
- readonly Identifiers: "identifiers";
225
- readonly Images: "images";
226
- readonly ProductTypes: "productTypes";
227
- readonly Relationships: "relationships";
228
- readonly SalesRanks: "salesRanks";
229
- readonly Summaries: "summaries";
230
- readonly VendorDetails: "vendorDetails";
231
- };
232
- export type SearchCatalogItemsIncludedDataEnum = typeof SearchCatalogItemsIncludedDataEnum[keyof typeof SearchCatalogItemsIncludedDataEnum];
@@ -1,12 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- export * from './api/catalog-items-api';
@@ -1,42 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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 type { Configuration } from './configuration';
13
- import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
- export declare const BASE_PATH: string;
15
- export declare const COLLECTION_FORMATS: {
16
- csv: string;
17
- ssv: string;
18
- tsv: string;
19
- pipes: string;
20
- };
21
- export interface RequestArgs {
22
- url: string;
23
- options: RawAxiosRequestConfig;
24
- }
25
- export declare class BaseAPI {
26
- protected basePath: string;
27
- protected axios: AxiosInstance;
28
- protected configuration: Configuration | undefined;
29
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
30
- }
31
- export declare class RequiredError extends Error {
32
- field: string;
33
- constructor(field: string, msg?: string);
34
- }
35
- interface ServerMap {
36
- [key: string]: {
37
- url: string;
38
- description: string;
39
- }[];
40
- }
41
- export declare const operationServerMap: ServerMap;
42
- export {};
@@ -1,34 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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 type { Configuration } from "./configuration";
13
- import type { RequestArgs } from "./base";
14
- import type { AxiosInstance, AxiosResponse } from 'axios';
15
- export declare const DUMMY_BASE_URL = "https://example.com";
16
- /**
17
- *
18
- * @throws {RequiredError}
19
- */
20
- export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
21
- export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
22
- export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
23
- export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
24
- export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
25
- export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
26
- /**
27
- * JSON serialization helper function which replaces instances of unserializable types with serializable ones.
28
- * This function will run for every key-value pair encountered by JSON.stringify while traversing an object.
29
- * Converting a set to a string will return an empty object, so an intermediate conversion to an array is required.
30
- */
31
- export declare const replaceWithSerializableTypeIfNeeded: (key: string, value: any) => any;
32
- export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
33
- export declare const toPathString: (url: URL) => string;
34
- export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;
@@ -1,98 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- interface AWSv4Configuration {
13
- options?: {
14
- region?: string;
15
- service?: string;
16
- };
17
- credentials?: {
18
- accessKeyId?: string;
19
- secretAccessKey?: string;
20
- sessionToken?: string;
21
- };
22
- }
23
- export interface ConfigurationParameters {
24
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
25
- username?: string;
26
- password?: string;
27
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
28
- awsv4?: AWSv4Configuration;
29
- basePath?: string;
30
- serverIndex?: number;
31
- baseOptions?: any;
32
- formDataCtor?: new () => any;
33
- }
34
- export declare class Configuration {
35
- /**
36
- * parameter for apiKey security
37
- * @param name security name
38
- */
39
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
40
- /**
41
- * parameter for basic security
42
- */
43
- username?: string;
44
- /**
45
- * parameter for basic security
46
- */
47
- password?: string;
48
- /**
49
- * parameter for oauth2 security
50
- * @param name security name
51
- * @param scopes oauth2 scope
52
- */
53
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
54
- /**
55
- * parameter for aws4 signature security
56
- * @param {Object} AWS4Signature - AWS4 Signature security
57
- * @param {string} options.region - aws region
58
- * @param {string} options.service - name of the service.
59
- * @param {string} credentials.accessKeyId - aws access key id
60
- * @param {string} credentials.secretAccessKey - aws access key
61
- * @param {string} credentials.sessionToken - aws session token
62
- * @memberof Configuration
63
- */
64
- awsv4?: AWSv4Configuration;
65
- /**
66
- * override base path
67
- */
68
- basePath?: string;
69
- /**
70
- * override server index
71
- */
72
- serverIndex?: number;
73
- /**
74
- * base options for axios calls
75
- */
76
- baseOptions?: any;
77
- /**
78
- * The FormData constructor that will be used to create multipart form data
79
- * requests. You can inject this here so that execution environments that
80
- * do not support the FormData class can still run the generated client.
81
- *
82
- * @type {new () => FormData}
83
- */
84
- formDataCtor?: new () => any;
85
- constructor(param?: ConfigurationParameters);
86
- /**
87
- * Check if the given MIME is a JSON MIME.
88
- * JSON MIME examples:
89
- * application/json
90
- * application/json; charset=UTF8
91
- * APPLICATION/JSON
92
- * application/vnd.company+json
93
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
94
- * @return True if the given MIME is JSON, false otherwise.
95
- */
96
- isJsonMime(mime: string): boolean;
97
- }
98
- export {};
@@ -1,14 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- export * from "./api";
13
- export * from "./configuration";
14
- export * from "./models";
@@ -1,24 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- * A brand that you can use to refine your search.
14
- */
15
- export interface BrandRefinement {
16
- /**
17
- * The estimated number of results that would be returned if you refine your search by the specified `brandName`.
18
- */
19
- 'numberOfResults': number;
20
- /**
21
- * The brand name that you can use to refine your search.
22
- */
23
- 'brandName': string;
24
- }
@@ -1,28 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- * A classification that you can use to refine your search.
14
- */
15
- export interface ClassificationRefinement {
16
- /**
17
- * The estimated number of results that would be returned if you refine your search by the specified `classificationId`.
18
- */
19
- 'numberOfResults': number;
20
- /**
21
- * Display name for the classification.
22
- */
23
- 'displayName': string;
24
- /**
25
- * The identifier of the classification that you can use to refine your search.
26
- */
27
- 'classificationId': string;
28
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- * The value of an individual dimension for an Amazon catalog item or item package.
14
- */
15
- export interface Dimension {
16
- /**
17
- * Unit of measurement for the dimension value.
18
- */
19
- 'unit'?: string;
20
- /**
21
- * Numeric value of the dimension.
22
- */
23
- 'value'?: number;
24
- }
@@ -1,21 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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 type { Dimension } from './dimension';
13
- /**
14
- * Dimensions of an Amazon catalog item or item in its packaging.
15
- */
16
- export interface Dimensions {
17
- 'height'?: Dimension;
18
- 'length'?: Dimension;
19
- 'weight'?: Dimension;
20
- 'width'?: Dimension;
21
- }
@@ -1,20 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- * A list of error responses returned when a request is unsuccessful.
14
- */
15
- export interface ErrorList {
16
- /**
17
- * A list of error responses returned when a request is unsuccessful.
18
- */
19
- 'errors': Array<Error>;
20
- }
@@ -1,29 +0,0 @@
1
- export * from './brand-refinement';
2
- export * from './classification-refinement';
3
- export * from './dimension';
4
- export * from './dimensions';
5
- export * from './error-list';
6
- export * from './item';
7
- export * from './item-browse-classification';
8
- export * from './item-browse-classifications-by-marketplace';
9
- export * from './item-classification-sales-rank';
10
- export * from './item-contributor';
11
- export * from './item-contributor-role';
12
- export * from './item-dimensions-by-marketplace';
13
- export * from './item-display-group-sales-rank';
14
- export * from './item-identifier';
15
- export * from './item-identifiers-by-marketplace';
16
- export * from './item-image';
17
- export * from './item-images-by-marketplace';
18
- export * from './item-product-type-by-marketplace';
19
- export * from './item-relationship';
20
- export * from './item-relationships-by-marketplace';
21
- export * from './item-sales-ranks-by-marketplace';
22
- export * from './item-search-results';
23
- export * from './item-summary-by-marketplace';
24
- export * from './item-variation-theme';
25
- export * from './item-vendor-details-by-marketplace';
26
- export * from './item-vendor-details-category';
27
- export * from './model-error';
28
- export * from './pagination';
29
- export * from './refinements';
@@ -1,25 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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
- * Classification (browse node) for an Amazon catalog item.
14
- */
15
- export interface ItemBrowseClassification {
16
- /**
17
- * Display name for the classification.
18
- */
19
- 'displayName': string;
20
- /**
21
- * Identifier of the classification.
22
- */
23
- 'classificationId': string;
24
- 'parent'?: ItemBrowseClassification;
25
- }
@@ -1,25 +0,0 @@
1
- /**
2
- * Selling Partner API for Catalog Items
3
- * Use the Selling Partner API for Catalog Items to retrieve 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 type { ItemBrowseClassification } from './item-browse-classification';
13
- /**
14
- * Classifications (browse nodes) that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
15
- */
16
- export interface ItemBrowseClassificationsByMarketplace {
17
- /**
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).
19
- */
20
- 'marketplaceId': string;
21
- /**
22
- * Classifications (browse nodes) that are associated with the item in the Amazon catalog.
23
- */
24
- 'classifications'?: Array<ItemBrowseClassification>;
25
- }