@sp-api-sdk/catalog-items-api-2022-04-01 3.1.1 → 4.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.
Files changed (111) hide show
  1. package/README.md +2 -2
  2. package/dist/cjs/api-model/api/{catalog-api.js → catalog-items-api.js} +63 -63
  3. package/dist/cjs/api-model/api.js +2 -2
  4. package/dist/cjs/api-model/base.js +1 -1
  5. package/dist/cjs/api-model/common.js +1 -1
  6. package/dist/cjs/api-model/configuration.js +1 -1
  7. package/dist/cjs/api-model/index.js +1 -1
  8. package/dist/cjs/api-model/models/brand-refinement.js +1 -1
  9. package/dist/cjs/api-model/models/classification-refinement.js +1 -1
  10. package/dist/cjs/api-model/models/dimension.js +1 -1
  11. package/dist/cjs/api-model/models/dimensions.js +1 -1
  12. package/dist/cjs/api-model/models/error-list.js +1 -1
  13. package/dist/cjs/api-model/models/item-browse-classification.js +1 -1
  14. package/dist/cjs/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  15. package/dist/cjs/api-model/models/item-classification-sales-rank.js +1 -1
  16. package/dist/cjs/api-model/models/item-contributor-role.js +1 -1
  17. package/dist/cjs/api-model/models/item-contributor.js +1 -1
  18. package/dist/cjs/api-model/models/item-dimensions-by-marketplace.js +1 -1
  19. package/dist/cjs/api-model/models/item-display-group-sales-rank.js +1 -1
  20. package/dist/cjs/api-model/models/item-identifier.js +1 -1
  21. package/dist/cjs/api-model/models/item-identifiers-by-marketplace.js +1 -1
  22. package/dist/cjs/api-model/models/item-image.js +1 -1
  23. package/dist/cjs/api-model/models/item-images-by-marketplace.js +1 -1
  24. package/dist/cjs/api-model/models/item-product-type-by-marketplace.js +1 -1
  25. package/dist/cjs/api-model/models/item-relationship.js +1 -1
  26. package/dist/cjs/api-model/models/item-relationships-by-marketplace.js +1 -1
  27. package/dist/cjs/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  28. package/dist/cjs/api-model/models/item-search-results.js +1 -1
  29. package/dist/cjs/api-model/models/item-summary-by-marketplace.js +1 -1
  30. package/dist/cjs/api-model/models/item-variation-theme.js +1 -1
  31. package/dist/cjs/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  32. package/dist/cjs/api-model/models/item-vendor-details-category.js +1 -1
  33. package/dist/cjs/api-model/models/item.js +1 -1
  34. package/dist/cjs/api-model/models/model-error.js +1 -1
  35. package/dist/cjs/api-model/models/pagination.js +1 -1
  36. package/dist/cjs/api-model/models/refinements.js +1 -1
  37. package/dist/cjs/client.js +5 -5
  38. package/dist/es/api-model/api/{catalog-api.js → catalog-items-api.js} +58 -58
  39. package/dist/es/api-model/api.js +2 -2
  40. package/dist/es/api-model/base.js +1 -1
  41. package/dist/es/api-model/common.js +1 -1
  42. package/dist/es/api-model/configuration.js +1 -1
  43. package/dist/es/api-model/index.js +1 -1
  44. package/dist/es/api-model/models/brand-refinement.js +1 -1
  45. package/dist/es/api-model/models/classification-refinement.js +1 -1
  46. package/dist/es/api-model/models/dimension.js +1 -1
  47. package/dist/es/api-model/models/dimensions.js +1 -1
  48. package/dist/es/api-model/models/error-list.js +1 -1
  49. package/dist/es/api-model/models/item-browse-classification.js +1 -1
  50. package/dist/es/api-model/models/item-browse-classifications-by-marketplace.js +1 -1
  51. package/dist/es/api-model/models/item-classification-sales-rank.js +1 -1
  52. package/dist/es/api-model/models/item-contributor-role.js +1 -1
  53. package/dist/es/api-model/models/item-contributor.js +1 -1
  54. package/dist/es/api-model/models/item-dimensions-by-marketplace.js +1 -1
  55. package/dist/es/api-model/models/item-display-group-sales-rank.js +1 -1
  56. package/dist/es/api-model/models/item-identifier.js +1 -1
  57. package/dist/es/api-model/models/item-identifiers-by-marketplace.js +1 -1
  58. package/dist/es/api-model/models/item-image.js +1 -1
  59. package/dist/es/api-model/models/item-images-by-marketplace.js +1 -1
  60. package/dist/es/api-model/models/item-product-type-by-marketplace.js +1 -1
  61. package/dist/es/api-model/models/item-relationship.js +1 -1
  62. package/dist/es/api-model/models/item-relationships-by-marketplace.js +1 -1
  63. package/dist/es/api-model/models/item-sales-ranks-by-marketplace.js +1 -1
  64. package/dist/es/api-model/models/item-search-results.js +1 -1
  65. package/dist/es/api-model/models/item-summary-by-marketplace.js +1 -1
  66. package/dist/es/api-model/models/item-variation-theme.js +1 -1
  67. package/dist/es/api-model/models/item-vendor-details-by-marketplace.js +1 -1
  68. package/dist/es/api-model/models/item-vendor-details-category.js +1 -1
  69. package/dist/es/api-model/models/item.js +1 -1
  70. package/dist/es/api-model/models/model-error.js +1 -1
  71. package/dist/es/api-model/models/pagination.js +1 -1
  72. package/dist/es/api-model/models/refinements.js +1 -1
  73. package/dist/es/client.js +6 -6
  74. package/dist/types/api-model/api/catalog-items-api.d.ts +285 -0
  75. package/dist/types/api-model/api.d.ts +2 -2
  76. package/dist/types/api-model/base.d.ts +1 -1
  77. package/dist/types/api-model/common.d.ts +1 -1
  78. package/dist/types/api-model/configuration.d.ts +1 -1
  79. package/dist/types/api-model/index.d.ts +1 -1
  80. package/dist/types/api-model/models/brand-refinement.d.ts +4 -4
  81. package/dist/types/api-model/models/classification-refinement.d.ts +4 -4
  82. package/dist/types/api-model/models/dimension.d.ts +4 -4
  83. package/dist/types/api-model/models/dimensions.d.ts +1 -1
  84. package/dist/types/api-model/models/error-list.d.ts +1 -1
  85. package/dist/types/api-model/models/item-browse-classification.d.ts +4 -4
  86. package/dist/types/api-model/models/item-browse-classifications-by-marketplace.d.ts +4 -4
  87. package/dist/types/api-model/models/item-classification-sales-rank.d.ts +6 -6
  88. package/dist/types/api-model/models/item-contributor-role.d.ts +3 -3
  89. package/dist/types/api-model/models/item-contributor.d.ts +2 -2
  90. package/dist/types/api-model/models/item-dimensions-by-marketplace.d.ts +3 -3
  91. package/dist/types/api-model/models/item-display-group-sales-rank.d.ts +6 -6
  92. package/dist/types/api-model/models/item-identifier.d.ts +3 -3
  93. package/dist/types/api-model/models/item-identifiers-by-marketplace.d.ts +4 -4
  94. package/dist/types/api-model/models/item-image.d.ts +2 -2
  95. package/dist/types/api-model/models/item-images-by-marketplace.d.ts +4 -4
  96. package/dist/types/api-model/models/item-product-type-by-marketplace.d.ts +4 -4
  97. package/dist/types/api-model/models/item-relationship.d.ts +3 -3
  98. package/dist/types/api-model/models/item-relationships-by-marketplace.d.ts +3 -3
  99. package/dist/types/api-model/models/item-sales-ranks-by-marketplace.d.ts +5 -5
  100. package/dist/types/api-model/models/item-search-results.d.ts +3 -3
  101. package/dist/types/api-model/models/item-summary-by-marketplace.d.ts +21 -21
  102. package/dist/types/api-model/models/item-variation-theme.d.ts +4 -4
  103. package/dist/types/api-model/models/item-vendor-details-by-marketplace.d.ts +8 -8
  104. package/dist/types/api-model/models/item-vendor-details-category.d.ts +4 -4
  105. package/dist/types/api-model/models/item.d.ts +10 -10
  106. package/dist/types/api-model/models/model-error.d.ts +1 -1
  107. package/dist/types/api-model/models/pagination.d.ts +4 -4
  108. package/dist/types/api-model/models/refinements.d.ts +4 -4
  109. package/dist/types/client.d.ts +2 -2
  110. package/package.json +5 -5
  111. package/dist/types/api-model/api/catalog-api.d.ts +0 -285
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -11,19 +11,19 @@
11
11
  */
12
12
  import type { ItemBrowseClassification } from './item-browse-classification';
13
13
  /**
14
- * Classifications (browse nodes) associated with the item in the Amazon catalog for the indicated Amazon marketplace.
14
+ * Classifications (browse nodes) that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
15
15
  * @export
16
16
  * @interface ItemBrowseClassificationsByMarketplace
17
17
  */
18
18
  export interface ItemBrowseClassificationsByMarketplace {
19
19
  /**
20
- * Amazon marketplace identifier.
20
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
21
21
  * @type {string}
22
22
  * @memberof ItemBrowseClassificationsByMarketplace
23
23
  */
24
24
  'marketplaceId': string;
25
25
  /**
26
- * Classifications (browse nodes) associated with the item in the Amazon catalog for the indicated Amazon marketplace.
26
+ * Classifications (browse nodes) that are associated with the item in the Amazon catalog.
27
27
  * @type {Array<ItemBrowseClassification>}
28
28
  * @memberof ItemBrowseClassificationsByMarketplace
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,31 +10,31 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Sales rank of an Amazon catalog item by classification.
13
+ * Sales rank of an Amazon catalog item.
14
14
  * @export
15
15
  * @interface ItemClassificationSalesRank
16
16
  */
17
17
  export interface ItemClassificationSalesRank {
18
18
  /**
19
- * Identifier of the classification associated with the sales rank.
19
+ * Identifier of the classification that is associated with the sales rank.
20
20
  * @type {string}
21
21
  * @memberof ItemClassificationSalesRank
22
22
  */
23
23
  'classificationId': string;
24
24
  /**
25
- * Title, or name, of the sales rank.
25
+ * Name of the sales rank.
26
26
  * @type {string}
27
27
  * @memberof ItemClassificationSalesRank
28
28
  */
29
29
  'title': string;
30
30
  /**
31
- * Corresponding Amazon retail website link, or URL, for the sales rank.
31
+ * Corresponding Amazon retail website URL for the sales category.
32
32
  * @type {string}
33
33
  * @memberof ItemClassificationSalesRank
34
34
  */
35
35
  'link'?: string;
36
36
  /**
37
- * Sales rank value.
37
+ * Sales rank.
38
38
  * @type {number}
39
39
  * @memberof ItemClassificationSalesRank
40
40
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -16,13 +16,13 @@
16
16
  */
17
17
  export interface ItemContributorRole {
18
18
  /**
19
- * Display name of the role in the requested locale, such as Author or Actor.
19
+ * Display name of the role in the requested locale, such as `Author` or `Actor`.
20
20
  * @type {string}
21
21
  * @memberof ItemContributorRole
22
22
  */
23
23
  'displayName'?: string;
24
24
  /**
25
- * Role value for the Amazon catalog item, such as author or actor.
25
+ * Role value for the Amazon catalog item, such as `author` or `actor`.
26
26
  * @type {string}
27
27
  * @memberof ItemContributorRole
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -23,7 +23,7 @@ export interface ItemContributor {
23
23
  */
24
24
  'role': ItemContributorRole;
25
25
  /**
26
- * Name of the contributor, such as Jane Austen.
26
+ * Name of the contributor, such as `Jane Austen`.
27
27
  * @type {string}
28
28
  * @memberof ItemContributor
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -11,13 +11,13 @@
11
11
  */
12
12
  import type { Dimensions } from './dimensions';
13
13
  /**
14
- * Dimensions associated with the item in the Amazon catalog for the indicated Amazon marketplace.
14
+ * Dimensions that are associated with the item in the Amazon catalog for the indicated `marketplaceId`.
15
15
  * @export
16
16
  * @interface ItemDimensionsByMarketplace
17
17
  */
18
18
  export interface ItemDimensionsByMarketplace {
19
19
  /**
20
- * Amazon marketplace identifier.
20
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
21
21
  * @type {string}
22
22
  * @memberof ItemDimensionsByMarketplace
23
23
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,31 +10,31 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Sales rank of an Amazon catalog item by website display group.
13
+ * Sales rank of an Amazon catalog item, grouped by website display group.
14
14
  * @export
15
15
  * @interface ItemDisplayGroupSalesRank
16
16
  */
17
17
  export interface ItemDisplayGroupSalesRank {
18
18
  /**
19
- * Name of the website display group associated with the sales rank
19
+ * Name of the website display group that is associated with the sales rank
20
20
  * @type {string}
21
21
  * @memberof ItemDisplayGroupSalesRank
22
22
  */
23
23
  'websiteDisplayGroup': string;
24
24
  /**
25
- * Title, or name, of the sales rank.
25
+ * Name of the sales rank.
26
26
  * @type {string}
27
27
  * @memberof ItemDisplayGroupSalesRank
28
28
  */
29
29
  'title': string;
30
30
  /**
31
- * Corresponding Amazon retail website link, or URL, for the sales rank.
31
+ * Corresponding Amazon retail website URL for the sales rank.
32
32
  * @type {string}
33
33
  * @memberof ItemDisplayGroupSalesRank
34
34
  */
35
35
  'link'?: string;
36
36
  /**
37
- * Sales rank value.
37
+ * Sales rank.
38
38
  * @type {number}
39
39
  * @memberof ItemDisplayGroupSalesRank
40
40
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Identifier associated with the item in the Amazon catalog, such as a UPC or EAN identifier.
13
+ * The identifier that is associated with the item in the Amazon catalog, such as a UPC or EAN identifier.
14
14
  * @export
15
15
  * @interface ItemIdentifier
16
16
  */
@@ -22,7 +22,7 @@ export interface ItemIdentifier {
22
22
  */
23
23
  'identifierType': string;
24
24
  /**
25
- * Identifier.
25
+ * Identifier of the item.
26
26
  * @type {string}
27
27
  * @memberof ItemIdentifier
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -11,19 +11,19 @@
11
11
  */
12
12
  import type { ItemIdentifier } from './item-identifier';
13
13
  /**
14
- * Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.
14
+ * Identifiers that are associated with the item in the Amazon catalog, grouped by `marketplaceId`.
15
15
  * @export
16
16
  * @interface ItemIdentifiersByMarketplace
17
17
  */
18
18
  export interface ItemIdentifiersByMarketplace {
19
19
  /**
20
- * Amazon marketplace identifier.
20
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).identifier.
21
21
  * @type {string}
22
22
  * @memberof ItemIdentifiersByMarketplace
23
23
  */
24
24
  'marketplaceId': string;
25
25
  /**
26
- * Identifiers associated with the item in the Amazon catalog for the indicated Amazon marketplace.
26
+ * Identifiers associated with the item in the Amazon catalog for the indicated `marketplaceId`.
27
27
  * @type {Array<ItemIdentifier>}
28
28
  * @memberof ItemIdentifiersByMarketplace
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -22,7 +22,7 @@ export interface ItemImage {
22
22
  */
23
23
  'variant': ItemImageVariantEnum;
24
24
  /**
25
- * Link, or URL, for the image.
25
+ * URL for the image.
26
26
  * @type {string}
27
27
  * @memberof ItemImage
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -11,19 +11,19 @@
11
11
  */
12
12
  import type { ItemImage } from './item-image';
13
13
  /**
14
- * Images for an item in the Amazon catalog for the indicated Amazon marketplace.
14
+ * Images for an item in the Amazon catalog, grouped by `marketplaceId`.
15
15
  * @export
16
16
  * @interface ItemImagesByMarketplace
17
17
  */
18
18
  export interface ItemImagesByMarketplace {
19
19
  /**
20
- * Amazon marketplace identifier.
20
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
21
21
  * @type {string}
22
22
  * @memberof ItemImagesByMarketplace
23
23
  */
24
24
  'marketplaceId': string;
25
25
  /**
26
- * Images for an item in the Amazon catalog for the indicated Amazon marketplace.
26
+ * Images for an item in the Amazon catalog, grouped by `marketplaceId`.
27
27
  * @type {Array<ItemImage>}
28
28
  * @memberof ItemImagesByMarketplace
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,19 +10,19 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Product type associated with the Amazon catalog item for the indicated Amazon marketplace.
13
+ * Product type that is associated with the Amazon catalog item, grouped by `marketplaceId`.
14
14
  * @export
15
15
  * @interface ItemProductTypeByMarketplace
16
16
  */
17
17
  export interface ItemProductTypeByMarketplace {
18
18
  /**
19
- * Amazon marketplace identifier.
19
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
20
20
  * @type {string}
21
21
  * @memberof ItemProductTypeByMarketplace
22
22
  */
23
23
  'marketplaceId'?: string;
24
24
  /**
25
- * Name of the product type associated with the Amazon catalog item.
25
+ * Name of the product type that is associated with the Amazon catalog item.
26
26
  * @type {string}
27
27
  * @memberof ItemProductTypeByMarketplace
28
28
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -17,13 +17,13 @@ import type { ItemVariationTheme } from './item-variation-theme';
17
17
  */
18
18
  export interface ItemRelationship {
19
19
  /**
20
- * Identifiers (ASINs) of the related items that are children of this item.
20
+ * ASINs of the related items that are children of this item.
21
21
  * @type {Array<string>}
22
22
  * @memberof ItemRelationship
23
23
  */
24
24
  'childAsins'?: Array<string>;
25
25
  /**
26
- * Identifiers (ASINs) of the related items that are parents of this item.
26
+ * ASINs of the related items that are parents of this item.
27
27
  * @type {Array<string>}
28
28
  * @memberof ItemRelationship
29
29
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -11,13 +11,13 @@
11
11
  */
12
12
  import type { ItemRelationship } from './item-relationship';
13
13
  /**
14
- * Relationship details for the Amazon catalog item for the indicated Amazon marketplace.
14
+ * Relationship details for the Amazon catalog item for the specified Amazon `marketplaceId`.
15
15
  * @export
16
16
  * @interface ItemRelationshipsByMarketplace
17
17
  */
18
18
  export interface ItemRelationshipsByMarketplace {
19
19
  /**
20
- * Amazon marketplace identifier.
20
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
21
21
  * @type {string}
22
22
  * @memberof ItemRelationshipsByMarketplace
23
23
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -12,25 +12,25 @@
12
12
  import type { ItemClassificationSalesRank } from './item-classification-sales-rank';
13
13
  import type { ItemDisplayGroupSalesRank } from './item-display-group-sales-rank';
14
14
  /**
15
- * Sales ranks of an Amazon catalog item for the indicated Amazon marketplace.
15
+ * Sales ranks of an Amazon catalog item, grouped by `marketplaceId`.
16
16
  * @export
17
17
  * @interface ItemSalesRanksByMarketplace
18
18
  */
19
19
  export interface ItemSalesRanksByMarketplace {
20
20
  /**
21
- * Amazon marketplace identifier.
21
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
22
22
  * @type {string}
23
23
  * @memberof ItemSalesRanksByMarketplace
24
24
  */
25
25
  'marketplaceId': string;
26
26
  /**
27
- * Sales ranks of an Amazon catalog item for an Amazon marketplace by classification.
27
+ * Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by classification.
28
28
  * @type {Array<ItemClassificationSalesRank>}
29
29
  * @memberof ItemSalesRanksByMarketplace
30
30
  */
31
31
  'classificationRanks'?: Array<ItemClassificationSalesRank>;
32
32
  /**
33
- * Sales ranks of an Amazon catalog item for an Amazon marketplace by website display group.
33
+ * Sales ranks of an Amazon catalog item for a `marketplaceId`, grouped by website display group.
34
34
  * @type {Array<ItemDisplayGroupSalesRank>}
35
35
  * @memberof ItemSalesRanksByMarketplace
36
36
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -13,13 +13,13 @@ import type { Item } from './item';
13
13
  import type { Pagination } from './pagination';
14
14
  import type { Refinements } from './refinements';
15
15
  /**
16
- * Items in the Amazon catalog and search related metadata.
16
+ * Items in the Amazon catalog and search-related metadata.
17
17
  * @export
18
18
  * @interface ItemSearchResults
19
19
  */
20
20
  export interface ItemSearchResults {
21
21
  /**
22
- * For `identifiers`-based searches, the total number of Amazon catalog items found. For `keywords`-based searches, the estimated total number of Amazon catalog items matched by the search query (only results up to the page count limit will be returned per request regardless of the number found). Note: The maximum number of items (ASINs) that can be returned and paged through is 1000.
22
+ * For searches that are based on `identifiers`, `numberOfResults` is the total number of Amazon catalog items found. For searches that are based on `keywords`, `numberOfResults` is the estimated total number of Amazon catalog items that are matched by the search query. Only results up to the page count limit are returned per request regardless of the number found. **Note:** The maximum number of items (ASINs) that can be returned and paged through is 1,000.
23
23
  * @type {number}
24
24
  * @memberof ItemSearchResults
25
25
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -12,31 +12,31 @@
12
12
  import type { ItemBrowseClassification } from './item-browse-classification';
13
13
  import type { ItemContributor } from './item-contributor';
14
14
  /**
15
- * Summary details of an Amazon catalog item for the indicated Amazon marketplace.
15
+ * Information about an Amazon catalog item for the indicated `marketplaceId`.
16
16
  * @export
17
17
  * @interface ItemSummaryByMarketplace
18
18
  */
19
19
  export interface ItemSummaryByMarketplace {
20
20
  /**
21
- * Amazon marketplace identifier.
21
+ * Amazon marketplace identifier. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
22
22
  * @type {string}
23
23
  * @memberof ItemSummaryByMarketplace
24
24
  */
25
25
  'marketplaceId': string;
26
26
  /**
27
- * Identifies an Amazon catalog item is intended for an adult audience or is sexual in nature.
27
+ * When `true`, the Amazon catalog item is intended for an adult audience or is sexual in nature.
28
28
  * @type {boolean}
29
29
  * @memberof ItemSummaryByMarketplace
30
30
  */
31
31
  'adultProduct'?: boolean;
32
32
  /**
33
- * Identifies an Amazon catalog item is autographed by a player or celebrity.
33
+ * When `true`, the Amazon catalog item is autographed.
34
34
  * @type {boolean}
35
35
  * @memberof ItemSummaryByMarketplace
36
36
  */
37
37
  'autographed'?: boolean;
38
38
  /**
39
- * Name of the brand associated with an Amazon catalog item.
39
+ * Name of the brand that is associated with the Amazon catalog item.
40
40
  * @type {string}
41
41
  * @memberof ItemSummaryByMarketplace
42
42
  */
@@ -48,91 +48,91 @@ export interface ItemSummaryByMarketplace {
48
48
  */
49
49
  'browseClassification'?: ItemBrowseClassification;
50
50
  /**
51
- * Name of the color associated with an Amazon catalog item.
51
+ * The color that is associated with the Amazon catalog item.
52
52
  * @type {string}
53
53
  * @memberof ItemSummaryByMarketplace
54
54
  */
55
55
  'color'?: string;
56
56
  /**
57
- * Individual contributors to the creation of an item, such as the authors or actors.
57
+ * Individual contributors to the creation of the item, such as the authors or actors.
58
58
  * @type {Array<ItemContributor>}
59
59
  * @memberof ItemSummaryByMarketplace
60
60
  */
61
61
  'contributors'?: Array<ItemContributor>;
62
62
  /**
63
- * Classification type associated with the Amazon catalog item.
63
+ * Classification type that is associated with the Amazon catalog item.
64
64
  * @type {string}
65
65
  * @memberof ItemSummaryByMarketplace
66
66
  */
67
67
  'itemClassification'?: ItemSummaryByMarketplaceItemClassificationEnum;
68
68
  /**
69
- * Name, or title, associated with an Amazon catalog item.
69
+ * The name that is associated with the Amazon catalog item.
70
70
  * @type {string}
71
71
  * @memberof ItemSummaryByMarketplace
72
72
  */
73
73
  'itemName'?: string;
74
74
  /**
75
- * Name of the manufacturer associated with an Amazon catalog item.
75
+ * The name of the manufacturer that is associated with the Amazon catalog item.
76
76
  * @type {string}
77
77
  * @memberof ItemSummaryByMarketplace
78
78
  */
79
79
  'manufacturer'?: string;
80
80
  /**
81
- * Identifies an Amazon catalog item is memorabilia valued for its connection with historical events, culture, or entertainment.
81
+ * When true, the item is classified as memorabilia.
82
82
  * @type {boolean}
83
83
  * @memberof ItemSummaryByMarketplace
84
84
  */
85
85
  'memorabilia'?: boolean;
86
86
  /**
87
- * Model number associated with an Amazon catalog item.
87
+ * The model number that is associated with the Amazon catalog item.
88
88
  * @type {string}
89
89
  * @memberof ItemSummaryByMarketplace
90
90
  */
91
91
  'modelNumber'?: string;
92
92
  /**
93
- * Quantity of an Amazon catalog item in one package.
93
+ * The quantity of the Amazon catalog item within one package.
94
94
  * @type {number}
95
95
  * @memberof ItemSummaryByMarketplace
96
96
  */
97
97
  'packageQuantity'?: number;
98
98
  /**
99
- * Part number associated with an Amazon catalog item.
99
+ * The part number that is associated with the Amazon catalog item.
100
100
  * @type {string}
101
101
  * @memberof ItemSummaryByMarketplace
102
102
  */
103
103
  'partNumber'?: string;
104
104
  /**
105
- * First date on which an Amazon catalog item is shippable to customers.
105
+ * The earliest date on which the Amazon catalog item can be shipped to customers.
106
106
  * @type {string}
107
107
  * @memberof ItemSummaryByMarketplace
108
108
  */
109
109
  'releaseDate'?: string;
110
110
  /**
111
- * Name of the size associated with an Amazon catalog item.
111
+ * The name of the size of the Amazon catalog item.
112
112
  * @type {string}
113
113
  * @memberof ItemSummaryByMarketplace
114
114
  */
115
115
  'size'?: string;
116
116
  /**
117
- * Name of the style associated with an Amazon catalog item.
117
+ * The name of the style that is associated with the Amazon catalog item.
118
118
  * @type {string}
119
119
  * @memberof ItemSummaryByMarketplace
120
120
  */
121
121
  'style'?: string;
122
122
  /**
123
- * Identifies an Amazon catalog item is eligible for trade-in.
123
+ * When true, the Amazon catalog item is eligible for trade-in.
124
124
  * @type {boolean}
125
125
  * @memberof ItemSummaryByMarketplace
126
126
  */
127
127
  'tradeInEligible'?: boolean;
128
128
  /**
129
- * Identifier of the website display group associated with an Amazon catalog item.
129
+ * The identifier of the website display group that is associated with the Amazon catalog item.
130
130
  * @type {string}
131
131
  * @memberof ItemSummaryByMarketplace
132
132
  */
133
133
  'websiteDisplayGroup'?: string;
134
134
  /**
135
- * Display name of the website display group associated with an Amazon catalog item.
135
+ * The display name of the website display group that is associated with the Amazon catalog item.
136
136
  * @type {string}
137
137
  * @memberof ItemSummaryByMarketplace
138
138
  */
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Selling Partner API for Catalog Items
3
- * The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog. For more information, refer to the [Catalog Items API Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/catalog-items-api-v2022-04-01-use-case-guide).
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
4
  *
5
5
  * The version of the OpenAPI document: 2022-04-01
6
6
  *
@@ -10,19 +10,19 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Variation theme indicating the combination of Amazon item catalog attributes that define the variation family.
13
+ * The variation theme is a list of Amazon catalog item attributes that define the variation family.
14
14
  * @export
15
15
  * @interface ItemVariationTheme
16
16
  */
17
17
  export interface ItemVariationTheme {
18
18
  /**
19
- * Names of the Amazon catalog item attributes associated with the variation theme.
19
+ * Names of the Amazon catalog item attributes that are associated with the variation theme.
20
20
  * @type {Array<string>}
21
21
  * @memberof ItemVariationTheme
22
22
  */
23
23
  'attributes'?: Array<string>;
24
24
  /**
25
- * Variation theme indicating the combination of Amazon item catalog attributes that define the variation family.
25
+ * Variation theme that indicates the combination of Amazon catalog item attributes that define the variation family.
26
26
  * @type {string}
27
27
  * @memberof ItemVariationTheme
28
28
  */