@sp-api-sdk/catalog-items-api-2022-04-01 4.2.12 → 5.0.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.
- package/README.md +4 -4
- package/dist/index.cjs +530 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +1280 -0
- package/dist/index.d.ts +1280 -0
- package/dist/index.js +481 -0
- package/dist/index.js.map +1 -0
- package/package.json +23 -12
- package/dist/cjs/api-model/api/catalog-items-api.js +0 -283
- package/dist/cjs/api-model/api.js +0 -30
- package/dist/cjs/api-model/base.js +0 -52
- package/dist/cjs/api-model/common.js +0 -123
- package/dist/cjs/api-model/configuration.js +0 -98
- package/dist/cjs/api-model/index.js +0 -32
- package/dist/cjs/api-model/models/brand-refinement.js +0 -15
- package/dist/cjs/api-model/models/classification-refinement.js +0 -15
- package/dist/cjs/api-model/models/dimension.js +0 -15
- package/dist/cjs/api-model/models/dimensions.js +0 -15
- package/dist/cjs/api-model/models/error-list.js +0 -15
- package/dist/cjs/api-model/models/index.js +0 -45
- package/dist/cjs/api-model/models/item-browse-classification.js +0 -15
- package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-classification-sales-rank.js +0 -15
- package/dist/cjs/api-model/models/item-contributor-role.js +0 -15
- package/dist/cjs/api-model/models/item-contributor.js +0 -15
- package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-display-group-sales-rank.js +0 -15
- package/dist/cjs/api-model/models/item-identifier.js +0 -15
- package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-image.js +0 -28
- package/dist/cjs/api-model/models/item-images-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-relationship.js +0 -20
- package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +0 -15
- package/dist/cjs/api-model/models/item-search-results.js +0 -15
- package/dist/cjs/api-model/models/item-summary-by-marketplace.js +0 -22
- package/dist/cjs/api-model/models/item-variation-theme.js +0 -15
- package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +0 -28
- package/dist/cjs/api-model/models/item-vendor-details-category.js +0 -15
- package/dist/cjs/api-model/models/item.js +0 -15
- package/dist/cjs/api-model/models/model-error.js +0 -15
- package/dist/cjs/api-model/models/pagination.js +0 -15
- package/dist/cjs/api-model/models/refinements.js +0 -15
- package/dist/cjs/client.js +0 -28
- package/dist/cjs/index.js +0 -19
- package/dist/es/api-model/api/catalog-items-api.js +0 -273
- package/dist/es/api-model/api.js +0 -14
- package/dist/es/api-model/base.js +0 -44
- package/dist/es/api-model/common.js +0 -110
- package/dist/es/api-model/configuration.js +0 -94
- package/dist/es/api-model/index.js +0 -16
- package/dist/es/api-model/models/brand-refinement.js +0 -14
- package/dist/es/api-model/models/classification-refinement.js +0 -14
- package/dist/es/api-model/models/dimension.js +0 -14
- package/dist/es/api-model/models/dimensions.js +0 -14
- package/dist/es/api-model/models/error-list.js +0 -14
- package/dist/es/api-model/models/index.js +0 -29
- package/dist/es/api-model/models/item-browse-classification.js +0 -14
- package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-classification-sales-rank.js +0 -14
- package/dist/es/api-model/models/item-contributor-role.js +0 -14
- package/dist/es/api-model/models/item-contributor.js +0 -14
- package/dist/es/api-model/models/item-dimensions-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-display-group-sales-rank.js +0 -14
- package/dist/es/api-model/models/item-identifier.js +0 -14
- package/dist/es/api-model/models/item-identifiers-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-image.js +0 -25
- package/dist/es/api-model/models/item-images-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-product-type-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-relationship.js +0 -17
- package/dist/es/api-model/models/item-relationships-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +0 -14
- package/dist/es/api-model/models/item-search-results.js +0 -14
- package/dist/es/api-model/models/item-summary-by-marketplace.js +0 -19
- package/dist/es/api-model/models/item-variation-theme.js +0 -14
- package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +0 -25
- package/dist/es/api-model/models/item-vendor-details-category.js +0 -14
- package/dist/es/api-model/models/item.js +0 -14
- package/dist/es/api-model/models/model-error.js +0 -14
- package/dist/es/api-model/models/pagination.js +0 -14
- package/dist/es/api-model/models/refinements.js +0 -14
- package/dist/es/client.js +0 -24
- package/dist/es/index.js +0 -3
- package/dist/types/api-model/api/catalog-items-api.d.ts +0 -232
- package/dist/types/api-model/api.d.ts +0 -12
- package/dist/types/api-model/base.d.ts +0 -42
- package/dist/types/api-model/common.d.ts +0 -34
- package/dist/types/api-model/configuration.d.ts +0 -98
- package/dist/types/api-model/index.d.ts +0 -14
- package/dist/types/api-model/models/brand-refinement.d.ts +0 -24
- package/dist/types/api-model/models/classification-refinement.d.ts +0 -28
- package/dist/types/api-model/models/dimension.d.ts +0 -24
- package/dist/types/api-model/models/dimensions.d.ts +0 -21
- package/dist/types/api-model/models/error-list.d.ts +0 -20
- package/dist/types/api-model/models/index.d.ts +0 -29
- package/dist/types/api-model/models/item-browse-classification.d.ts +0 -25
- package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +0 -25
- package/dist/types/api-model/models/item-classification-sales-rank.d.ts +0 -32
- package/dist/types/api-model/models/item-contributor-role.d.ts +0 -24
- package/dist/types/api-model/models/item-contributor.d.ts +0 -22
- package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +0 -23
- package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +0 -32
- package/dist/types/api-model/models/item-identifier.d.ts +0 -24
- package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +0 -25
- package/dist/types/api-model/models/item-image.d.ts +0 -45
- package/dist/types/api-model/models/item-images-by-marketplace.d.ts +0 -25
- package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +0 -24
- package/dist/types/api-model/models/item-relationship.d.ts +0 -35
- package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +0 -25
- package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +0 -30
- package/dist/types/api-model/models/item-search-results.d.ts +0 -29
- package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +0 -102
- package/dist/types/api-model/models/item-variation-theme.d.ts +0 -24
- package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +0 -56
- package/dist/types/api-model/models/item-vendor-details-category.d.ts +0 -24
- package/dist/types/api-model/models/item.d.ts +0 -71
- package/dist/types/api-model/models/model-error.d.ts +0 -28
- package/dist/types/api-model/models/pagination.d.ts +0 -24
- package/dist/types/api-model/models/refinements.d.ts +0 -26
- package/dist/types/client.d.ts +0 -6
- package/dist/types/index.d.ts +0 -3
|
@@ -1,71 +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 { ItemBrowseClassificationsByMarketplace } from './item-browse-classifications-by-marketplace';
|
|
13
|
-
import type { ItemDimensionsByMarketplace } from './item-dimensions-by-marketplace';
|
|
14
|
-
import type { ItemIdentifiersByMarketplace } from './item-identifiers-by-marketplace';
|
|
15
|
-
import type { ItemImagesByMarketplace } from './item-images-by-marketplace';
|
|
16
|
-
import type { ItemProductTypeByMarketplace } from './item-product-type-by-marketplace';
|
|
17
|
-
import type { ItemRelationshipsByMarketplace } from './item-relationships-by-marketplace';
|
|
18
|
-
import type { ItemSalesRanksByMarketplace } from './item-sales-ranks-by-marketplace';
|
|
19
|
-
import type { ItemSummaryByMarketplace } from './item-summary-by-marketplace';
|
|
20
|
-
import type { ItemVendorDetailsByMarketplace } from './item-vendor-details-by-marketplace';
|
|
21
|
-
/**
|
|
22
|
-
* An item in the Amazon catalog.
|
|
23
|
-
*/
|
|
24
|
-
export interface Item {
|
|
25
|
-
/**
|
|
26
|
-
* The unique identifier of an item in the Amazon catalog.
|
|
27
|
-
*/
|
|
28
|
-
'asin': string;
|
|
29
|
-
/**
|
|
30
|
-
* A JSON object containing structured item attribute data that is keyed by attribute name. Catalog item attributes conform to the related Amazon product type definitions that you can get from the [Product Type Definitions API](https://developer-docs.amazon.com/sp-api/reference/product-type-definitions-v2020-09-01).
|
|
31
|
-
*/
|
|
32
|
-
'attributes'?: {
|
|
33
|
-
[key: string]: any;
|
|
34
|
-
};
|
|
35
|
-
/**
|
|
36
|
-
* An array of classifications (browse nodes) that is associated with the item in the Amazon catalog, grouped by `marketplaceId`.
|
|
37
|
-
*/
|
|
38
|
-
'classifications'?: Array<ItemBrowseClassificationsByMarketplace>;
|
|
39
|
-
/**
|
|
40
|
-
* An array of dimensions that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
|
|
41
|
-
*/
|
|
42
|
-
'dimensions'?: Array<ItemDimensionsByMarketplace>;
|
|
43
|
-
/**
|
|
44
|
-
* Identifiers associated with the item in the Amazon catalog, such as UPC and EAN identifiers.
|
|
45
|
-
*/
|
|
46
|
-
'identifiers'?: Array<ItemIdentifiersByMarketplace>;
|
|
47
|
-
/**
|
|
48
|
-
* The images for an item in the Amazon catalog.
|
|
49
|
-
*/
|
|
50
|
-
'images'?: Array<ItemImagesByMarketplace>;
|
|
51
|
-
/**
|
|
52
|
-
* Product types that are associated with the Amazon catalog item.
|
|
53
|
-
*/
|
|
54
|
-
'productTypes'?: Array<ItemProductTypeByMarketplace>;
|
|
55
|
-
/**
|
|
56
|
-
* Relationships grouped by `marketplaceId` for an Amazon catalog item (for example, variations).
|
|
57
|
-
*/
|
|
58
|
-
'relationships'?: Array<ItemRelationshipsByMarketplace>;
|
|
59
|
-
/**
|
|
60
|
-
* Sales ranks of an Amazon catalog item.
|
|
61
|
-
*/
|
|
62
|
-
'salesRanks'?: Array<ItemSalesRanksByMarketplace>;
|
|
63
|
-
/**
|
|
64
|
-
* Summaries of Amazon catalog items.
|
|
65
|
-
*/
|
|
66
|
-
'summaries'?: Array<ItemSummaryByMarketplace>;
|
|
67
|
-
/**
|
|
68
|
-
* The vendor details that are associated with an Amazon catalog item. Vendor details are only available to vendors.
|
|
69
|
-
*/
|
|
70
|
-
'vendorDetails'?: Array<ItemVendorDetailsByMarketplace>;
|
|
71
|
-
}
|
|
@@ -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
|
-
* Error response returned when the request is unsuccessful.
|
|
14
|
-
*/
|
|
15
|
-
export interface ModelError {
|
|
16
|
-
/**
|
|
17
|
-
* An error code that identifies the type of error that occurred.
|
|
18
|
-
*/
|
|
19
|
-
'code': string;
|
|
20
|
-
/**
|
|
21
|
-
* A message that describes the error condition.
|
|
22
|
-
*/
|
|
23
|
-
'message': string;
|
|
24
|
-
/**
|
|
25
|
-
* Additional details that can help the caller understand or fix the issue.
|
|
26
|
-
*/
|
|
27
|
-
'details'?: 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
|
-
* Pagination occurs when a request produces a response that exceeds the `pageSize`. This means that the response is divided into individual pages. To retrieve the next page or the previous page of results, you must pass the `nextToken` value or the `previousToken` value as the `pageToken` parameter in the next request. There is no `nextToken` in the pagination object on the last page.
|
|
14
|
-
*/
|
|
15
|
-
export interface Pagination {
|
|
16
|
-
/**
|
|
17
|
-
* A token that you can use to retrieve the next page.
|
|
18
|
-
*/
|
|
19
|
-
'nextToken'?: string;
|
|
20
|
-
/**
|
|
21
|
-
* A token that you can use to retrieve the previous page.
|
|
22
|
-
*/
|
|
23
|
-
'previousToken'?: string;
|
|
24
|
-
}
|
|
@@ -1,26 +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 { BrandRefinement } from './brand-refinement';
|
|
13
|
-
import type { ClassificationRefinement } from './classification-refinement';
|
|
14
|
-
/**
|
|
15
|
-
* Optional fields that you can use to refine your search results.
|
|
16
|
-
*/
|
|
17
|
-
export interface Refinements {
|
|
18
|
-
/**
|
|
19
|
-
* A list of brands you can use to refine your search.
|
|
20
|
-
*/
|
|
21
|
-
'brands': Array<BrandRefinement>;
|
|
22
|
-
/**
|
|
23
|
-
* A list of classifications you can use to refine your search.
|
|
24
|
-
*/
|
|
25
|
-
'classifications': Array<ClassificationRefinement>;
|
|
26
|
-
}
|
package/dist/types/client.d.ts
DELETED
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
|
|
2
|
-
import { CatalogItemsApi } from './api-model';
|
|
3
|
-
export declare const clientRateLimits: RateLimit[];
|
|
4
|
-
export declare class CatalogItemsApiClient extends CatalogItemsApi {
|
|
5
|
-
constructor(configuration: ClientConfiguration);
|
|
6
|
-
}
|
package/dist/types/index.d.ts
DELETED