@sp-api-sdk/product-pricing-api-2022-05-01 2.2.0 → 2.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist/cjs/src/api-model/api/product-pricing-api.js +2 -2
  2. package/dist/cjs/src/api-model/models/competitive-summary-included-data.js +3 -1
  3. package/dist/cjs/src/api-model/models/index.js +4 -0
  4. package/dist/cjs/src/api-model/models/lowest-priced-offer.js +15 -0
  5. package/dist/cjs/src/api-model/models/lowest-priced-offers-input.js +19 -0
  6. package/dist/cjs/src/api-model/models/offer.js +16 -0
  7. package/dist/cjs/src/api-model/models/prime-details.js +21 -0
  8. package/dist/cjs/src/api-model/models/reference-price.js +15 -0
  9. package/dist/es/src/api-model/api/product-pricing-api.js +2 -2
  10. package/dist/es/src/api-model/models/competitive-summary-included-data.js +3 -1
  11. package/dist/es/src/api-model/models/index.js +4 -0
  12. package/dist/es/src/api-model/models/lowest-priced-offer.js +14 -0
  13. package/dist/es/src/api-model/models/lowest-priced-offers-input.js +16 -0
  14. package/dist/es/src/api-model/models/offer.js +15 -1
  15. package/dist/es/src/api-model/models/prime-details.js +18 -0
  16. package/dist/es/src/api-model/models/reference-price.js +14 -0
  17. package/dist/types/src/api-model/api/product-pricing-api.d.ts +3 -3
  18. package/dist/types/src/api-model/common.d.ts +0 -1
  19. package/dist/types/src/api-model/models/competitive-summary-included-data.d.ts +2 -0
  20. package/dist/types/src/api-model/models/competitive-summary-request.d.ts +7 -0
  21. package/dist/types/src/api-model/models/competitive-summary-response-body.d.ts +17 -4
  22. package/dist/types/src/api-model/models/featured-offer-expected-price-response.d.ts +1 -0
  23. package/dist/types/src/api-model/models/featured-offer.d.ts +1 -1
  24. package/dist/types/src/api-model/models/index.d.ts +4 -0
  25. package/dist/types/src/api-model/models/lowest-priced-offer.d.ts +32 -0
  26. package/dist/types/src/api-model/models/lowest-priced-offers-input.d.ts +35 -0
  27. package/dist/types/src/api-model/models/money-type.d.ts +1 -1
  28. package/dist/types/src/api-model/models/offer.d.ts +29 -0
  29. package/dist/types/src/api-model/models/points.d.ts +1 -1
  30. package/dist/types/src/api-model/models/price.d.ts +1 -1
  31. package/dist/types/src/api-model/models/prime-details.d.ts +30 -0
  32. package/dist/types/src/api-model/models/reference-price.d.ts +31 -0
  33. package/package.json +4 -4
@@ -60,7 +60,7 @@ const ProductPricingApiAxiosParamCreator = function (configuration) {
60
60
  },
61
61
  /**
62
62
  * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
63
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody
63
+ * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
64
64
  * @param {*} [options] Override http request option.
65
65
  * @throws {RequiredError}
66
66
  */
@@ -111,7 +111,7 @@ const ProductPricingApiFp = function (configuration) {
111
111
  },
112
112
  /**
113
113
  * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
114
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody
114
+ * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
115
115
  * @param {*} [options] Override http request option.
116
116
  * @throws {RequiredError}
117
117
  */
@@ -20,5 +20,7 @@ exports.CompetitiveSummaryIncludedData = void 0;
20
20
  * @enum {string}
21
21
  */
22
22
  exports.CompetitiveSummaryIncludedData = {
23
- FeaturedBuyingOptions: 'featuredBuyingOptions'
23
+ FeaturedBuyingOptions: 'featuredBuyingOptions',
24
+ ReferencePrices: 'referencePrices',
25
+ LowestPricedOffers: 'lowestPricedOffers'
24
26
  };
@@ -39,12 +39,16 @@ __exportStar(require("./get-featured-offer-expected-price-batch-request"), expor
39
39
  __exportStar(require("./get-featured-offer-expected-price-batch-response"), exports);
40
40
  __exportStar(require("./http-method"), exports);
41
41
  __exportStar(require("./http-status-line"), exports);
42
+ __exportStar(require("./lowest-priced-offer"), exports);
43
+ __exportStar(require("./lowest-priced-offers-input"), exports);
42
44
  __exportStar(require("./model-error"), exports);
43
45
  __exportStar(require("./money-type"), exports);
44
46
  __exportStar(require("./offer"), exports);
45
47
  __exportStar(require("./offer-identifier"), exports);
46
48
  __exportStar(require("./points"), exports);
47
49
  __exportStar(require("./price"), exports);
50
+ __exportStar(require("./prime-details"), exports);
51
+ __exportStar(require("./reference-price"), exports);
48
52
  __exportStar(require("./segment-details"), exports);
49
53
  __exportStar(require("./segmented-featured-offer"), exports);
50
54
  __exportStar(require("./segmented-featured-offer-all-of"), exports);
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Pricing
6
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
7
+ *
8
+ * The version of the OpenAPI document: 2022-05-01
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Pricing
6
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
7
+ *
8
+ * The version of the OpenAPI document: 2022-05-01
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.LowestPricedOffersInputOfferTypeEnum = void 0;
17
+ exports.LowestPricedOffersInputOfferTypeEnum = {
18
+ Consumer: 'CONSUMER'
19
+ };
@@ -13,3 +13,19 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.OfferSubConditionEnum = void 0;
17
+ exports.OfferSubConditionEnum = {
18
+ New: 'New',
19
+ Mint: 'Mint',
20
+ VeryGood: 'VeryGood',
21
+ Good: 'Good',
22
+ Acceptable: 'Acceptable',
23
+ Poor: 'Poor',
24
+ Club: 'Club',
25
+ Oem: 'OEM',
26
+ Warranty: 'Warranty',
27
+ RefurbishedWarranty: 'RefurbishedWarranty',
28
+ Refurbished: 'Refurbished',
29
+ OpenBox: 'OpenBox',
30
+ Other: 'Other'
31
+ };
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Pricing
6
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
7
+ *
8
+ * The version of the OpenAPI document: 2022-05-01
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.PrimeDetailsEligibilityEnum = void 0;
17
+ exports.PrimeDetailsEligibilityEnum = {
18
+ National: 'NATIONAL',
19
+ Regional: 'REGIONAL',
20
+ None: 'NONE'
21
+ };
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Selling Partner API for Pricing
6
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
7
+ *
8
+ * The version of the OpenAPI document: 2022-05-01
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -54,7 +54,7 @@ export const ProductPricingApiAxiosParamCreator = function (configuration) {
54
54
  },
55
55
  /**
56
56
  * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
57
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody
57
+ * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
58
58
  * @param {*} [options] Override http request option.
59
59
  * @throws {RequiredError}
60
60
  */
@@ -104,7 +104,7 @@ export const ProductPricingApiFp = function (configuration) {
104
104
  },
105
105
  /**
106
106
  * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
107
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody
107
+ * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
108
108
  * @param {*} [options] Override http request option.
109
109
  * @throws {RequiredError}
110
110
  */
@@ -17,5 +17,7 @@
17
17
  * @enum {string}
18
18
  */
19
19
  export const CompetitiveSummaryIncludedData = {
20
- FeaturedBuyingOptions: 'featuredBuyingOptions'
20
+ FeaturedBuyingOptions: 'featuredBuyingOptions',
21
+ ReferencePrices: 'referencePrices',
22
+ LowestPricedOffers: 'lowestPricedOffers'
21
23
  };
@@ -23,12 +23,16 @@ export * from './get-featured-offer-expected-price-batch-request';
23
23
  export * from './get-featured-offer-expected-price-batch-response';
24
24
  export * from './http-method';
25
25
  export * from './http-status-line';
26
+ export * from './lowest-priced-offer';
27
+ export * from './lowest-priced-offers-input';
26
28
  export * from './model-error';
27
29
  export * from './money-type';
28
30
  export * from './offer';
29
31
  export * from './offer-identifier';
30
32
  export * from './points';
31
33
  export * from './price';
34
+ export * from './prime-details';
35
+ export * from './reference-price';
32
36
  export * from './segment-details';
33
37
  export * from './segmented-featured-offer';
34
38
  export * from './segmented-featured-offer-all-of';
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Pricing
5
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
+ *
7
+ * The version of the OpenAPI document: 2022-05-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -0,0 +1,16 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Pricing
5
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
+ *
7
+ * The version of the OpenAPI document: 2022-05-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const LowestPricedOffersInputOfferTypeEnum = {
15
+ Consumer: 'CONSUMER'
16
+ };
@@ -11,4 +11,18 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
- export {};
14
+ export const OfferSubConditionEnum = {
15
+ New: 'New',
16
+ Mint: 'Mint',
17
+ VeryGood: 'VeryGood',
18
+ Good: 'Good',
19
+ Acceptable: 'Acceptable',
20
+ Poor: 'Poor',
21
+ Club: 'Club',
22
+ Oem: 'OEM',
23
+ Warranty: 'Warranty',
24
+ RefurbishedWarranty: 'RefurbishedWarranty',
25
+ Refurbished: 'Refurbished',
26
+ OpenBox: 'OpenBox',
27
+ Other: 'Other'
28
+ };
@@ -0,0 +1,18 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Pricing
5
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
+ *
7
+ * The version of the OpenAPI document: 2022-05-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export const PrimeDetailsEligibilityEnum = {
15
+ National: 'NATIONAL',
16
+ Regional: 'REGIONAL',
17
+ None: 'NONE'
18
+ };
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Selling Partner API for Pricing
5
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
6
+ *
7
+ * The version of the OpenAPI document: 2022-05-01
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -31,7 +31,7 @@ export declare const ProductPricingApiAxiosParamCreator: (configuration?: Config
31
31
  getCompetitiveSummary: (requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
32
32
  /**
33
33
  * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
34
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody
34
+ * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
35
35
  * @param {*} [options] Override http request option.
36
36
  * @throws {RequiredError}
37
37
  */
@@ -51,7 +51,7 @@ export declare const ProductPricingApiFp: (configuration?: Configuration) => {
51
51
  getCompetitiveSummary(requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompetitiveSummaryBatchResponse>>;
52
52
  /**
53
53
  * Returns the set of responses that correspond to the batched list of up to 40 requests defined in the request body. The response for each successful (HTTP status code 200) request in the set includes the computed listing price at or below which a seller can expect to become the featured offer (before applicable promotions). This is called the featured offer expected price (FOEP). Featured offer is not guaranteed, because competing offers may change, and different offers may be featured based on other factors, including fulfillment capabilities to a specific customer. The response to an unsuccessful request includes the available error text. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
54
- * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody
54
+ * @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
55
55
  * @param {*} [options] Override http request option.
56
56
  * @throws {RequiredError}
57
57
  */
@@ -97,7 +97,7 @@ export interface ProductPricingApiGetCompetitiveSummaryRequest {
97
97
  */
98
98
  export interface ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest {
99
99
  /**
100
- *
100
+ * The batch of &#x60;getFeaturedOfferExpectedPrice&#x60; requests.
101
101
  * @type {GetFeaturedOfferExpectedPriceBatchRequest}
102
102
  * @memberof ProductPricingApiGetFeaturedOfferExpectedPriceBatch
103
103
  */
@@ -9,7 +9,6 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- /// <reference types="node" />
13
12
  import type { Configuration } from "./configuration";
14
13
  import type { RequestArgs } from "./base";
15
14
  import type { AxiosInstance, AxiosResponse } from 'axios';
@@ -16,5 +16,7 @@
16
16
  */
17
17
  export declare const CompetitiveSummaryIncludedData: {
18
18
  readonly FeaturedBuyingOptions: "featuredBuyingOptions";
19
+ readonly ReferencePrices: "referencePrices";
20
+ readonly LowestPricedOffers: "lowestPricedOffers";
19
21
  };
20
22
  export type CompetitiveSummaryIncludedData = typeof CompetitiveSummaryIncludedData[keyof typeof CompetitiveSummaryIncludedData];
@@ -11,6 +11,7 @@
11
11
  */
12
12
  import type { CompetitiveSummaryIncludedData } from './competitive-summary-included-data';
13
13
  import type { HttpMethod } from './http-method';
14
+ import type { LowestPricedOffersInput } from './lowest-priced-offers-input';
14
15
  /**
15
16
  * An individual `competitiveSummary` request for an ASIN and `marketplaceId`.
16
17
  * @export
@@ -35,6 +36,12 @@ export interface CompetitiveSummaryRequest {
35
36
  * @memberof CompetitiveSummaryRequest
36
37
  */
37
38
  'includedData': Array<CompetitiveSummaryIncludedData>;
39
+ /**
40
+ * The list of `lowestPricedOffersInput` parameters used to build the `lowestPricedOffers` in the response. This attribute is valid only if `lowestPricedOffers` is requested in `includedData`.
41
+ * @type {Array<LowestPricedOffersInput>}
42
+ * @memberof CompetitiveSummaryRequest
43
+ */
44
+ 'lowestPricedOffersInputs'?: Array<LowestPricedOffersInput>;
38
45
  /**
39
46
  *
40
47
  * @type {HttpMethod}
@@ -9,8 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { Errors } from './errors';
13
12
  import type { FeaturedBuyingOption } from './featured-buying-option';
13
+ import type { LowestPricedOffer } from './lowest-priced-offer';
14
+ import type { ReferencePrice } from './reference-price';
14
15
  /**
15
16
  * The `competitiveSummaryResponse` body for a requested ASIN and `marketplaceId`.
16
17
  * @export
@@ -36,9 +37,21 @@ export interface CompetitiveSummaryResponseBody {
36
37
  */
37
38
  'featuredBuyingOptions'?: Array<FeaturedBuyingOption>;
38
39
  /**
39
- *
40
- * @type {Errors}
40
+ * A list of the lowest priced offers for the given ASIN `marketplaceId` combination.
41
+ * @type {Array<LowestPricedOffer>}
41
42
  * @memberof CompetitiveSummaryResponseBody
42
43
  */
43
- 'errors'?: Errors;
44
+ 'lowestPricedOffers'?: Array<LowestPricedOffer>;
45
+ /**
46
+ * A list of reference prices for the given ASIN `marketplaceId` combination.
47
+ * @type {Array<ReferencePrice>}
48
+ * @memberof CompetitiveSummaryResponseBody
49
+ */
50
+ 'referencePrices'?: Array<ReferencePrice>;
51
+ /**
52
+ * A list of error responses returned when a request is unsuccessful.
53
+ * @type {Array<Error>}
54
+ * @memberof CompetitiveSummaryResponseBody
55
+ */
56
+ 'errors'?: Array<Error>;
44
57
  }
@@ -13,6 +13,7 @@ import type { BatchResponse } from './batch-response';
13
13
  import type { FeaturedOfferExpectedPriceResponseAllOf } from './featured-offer-expected-price-response-all-of';
14
14
  /**
15
15
  * @type FeaturedOfferExpectedPriceResponse
16
+ * Schema for an individual featured offer expected price response.
16
17
  * @export
17
18
  */
18
19
  export type FeaturedOfferExpectedPriceResponse = BatchResponse & FeaturedOfferExpectedPriceResponseAllOf;
@@ -13,7 +13,7 @@ import type { Condition } from './condition';
13
13
  import type { OfferIdentifier } from './offer-identifier';
14
14
  import type { Price } from './price';
15
15
  /**
16
- *
16
+ * Schema for `currentFeaturedOffer` or `competingFeaturedOffer`.
17
17
  * @export
18
18
  * @interface FeaturedOffer
19
19
  */
@@ -23,12 +23,16 @@ export * from './get-featured-offer-expected-price-batch-request';
23
23
  export * from './get-featured-offer-expected-price-batch-response';
24
24
  export * from './http-method';
25
25
  export * from './http-status-line';
26
+ export * from './lowest-priced-offer';
27
+ export * from './lowest-priced-offers-input';
26
28
  export * from './model-error';
27
29
  export * from './money-type';
28
30
  export * from './offer';
29
31
  export * from './offer-identifier';
30
32
  export * from './points';
31
33
  export * from './price';
34
+ export * from './prime-details';
35
+ export * from './reference-price';
32
36
  export * from './segment-details';
33
37
  export * from './segmented-featured-offer';
34
38
  export * from './segmented-featured-offer-all-of';
@@ -0,0 +1,32 @@
1
+ /**
2
+ * Selling Partner API for Pricing
3
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
+ *
5
+ * The version of the OpenAPI document: 2022-05-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 { LowestPricedOffersInput } from './lowest-priced-offers-input';
13
+ import type { Offer } from './offer';
14
+ /**
15
+ * The lowest priced offer for the requested item condition and offer type.
16
+ * @export
17
+ * @interface LowestPricedOffer
18
+ */
19
+ export interface LowestPricedOffer {
20
+ /**
21
+ *
22
+ * @type {LowestPricedOffersInput}
23
+ * @memberof LowestPricedOffer
24
+ */
25
+ 'lowestPricedOffersInput': LowestPricedOffersInput;
26
+ /**
27
+ * A list of up to 20 lowest priced offers that match the criteria specified in the `lowestPricedOffersInput` parameter.
28
+ * @type {Array<Offer>}
29
+ * @memberof LowestPricedOffer
30
+ */
31
+ 'offers': Array<Offer>;
32
+ }
@@ -0,0 +1,35 @@
1
+ /**
2
+ * Selling Partner API for Pricing
3
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
+ *
5
+ * The version of the OpenAPI document: 2022-05-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 { Condition } from './condition';
13
+ /**
14
+ * The input required for building the `LowestPricedOffers` data in the response.
15
+ * @export
16
+ * @interface LowestPricedOffersInput
17
+ */
18
+ export interface LowestPricedOffersInput {
19
+ /**
20
+ *
21
+ * @type {Condition}
22
+ * @memberof LowestPricedOffersInput
23
+ */
24
+ 'itemCondition': Condition;
25
+ /**
26
+ * The type of offers requested for the `LowestPricedOffers`. The `offerType` options are `Consumer` or `Business`. The default `offerType` is `Consumer`.
27
+ * @type {string}
28
+ * @memberof LowestPricedOffersInput
29
+ */
30
+ 'offerType': LowestPricedOffersInputOfferTypeEnum;
31
+ }
32
+ export declare const LowestPricedOffersInputOfferTypeEnum: {
33
+ readonly Consumer: "CONSUMER";
34
+ };
35
+ export type LowestPricedOffersInputOfferTypeEnum = typeof LowestPricedOffersInputOfferTypeEnum[keyof typeof LowestPricedOffersInputOfferTypeEnum];
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- *
13
+ * Currency type and monetary value. Schema for demonstrating pricing info.
14
14
  * @export
15
15
  * @interface MoneyType
16
16
  */
@@ -13,6 +13,7 @@ import type { Condition } from './condition';
13
13
  import type { FulfillmentType } from './fulfillment-type';
14
14
  import type { MoneyType } from './money-type';
15
15
  import type { Points } from './points';
16
+ import type { PrimeDetails } from './prime-details';
16
17
  import type { ShippingOption } from './shipping-option';
17
18
  /**
18
19
  * The offer data of a product.
@@ -32,6 +33,12 @@ export interface Offer {
32
33
  * @memberof Offer
33
34
  */
34
35
  'condition': Condition;
36
+ /**
37
+ * The item subcondition for the offer.
38
+ * @type {string}
39
+ * @memberof Offer
40
+ */
41
+ 'subCondition'?: OfferSubConditionEnum;
35
42
  /**
36
43
  *
37
44
  * @type {FulfillmentType}
@@ -56,4 +63,26 @@ export interface Offer {
56
63
  * @memberof Offer
57
64
  */
58
65
  'points'?: Points;
66
+ /**
67
+ *
68
+ * @type {PrimeDetails}
69
+ * @memberof Offer
70
+ */
71
+ 'primeDetails'?: PrimeDetails;
59
72
  }
73
+ export declare const OfferSubConditionEnum: {
74
+ readonly New: "New";
75
+ readonly Mint: "Mint";
76
+ readonly VeryGood: "VeryGood";
77
+ readonly Good: "Good";
78
+ readonly Acceptable: "Acceptable";
79
+ readonly Poor: "Poor";
80
+ readonly Club: "Club";
81
+ readonly Oem: "OEM";
82
+ readonly Warranty: "Warranty";
83
+ readonly RefurbishedWarranty: "RefurbishedWarranty";
84
+ readonly Refurbished: "Refurbished";
85
+ readonly OpenBox: "OpenBox";
86
+ readonly Other: "Other";
87
+ };
88
+ export type OfferSubConditionEnum = typeof OfferSubConditionEnum[keyof typeof OfferSubConditionEnum];
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { MoneyType } from './money-type';
13
13
  /**
14
- *
14
+ * The number of Amazon Points offered with the purchase of an item, and their monetary value.
15
15
  * @export
16
16
  * @interface Points
17
17
  */
@@ -12,7 +12,7 @@
12
12
  import type { MoneyType } from './money-type';
13
13
  import type { Points } from './points';
14
14
  /**
15
- *
15
+ * Schema for item\'s price information, including listing price, shipping price, and Amazon points.
16
16
  * @export
17
17
  * @interface Price
18
18
  */
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Selling Partner API for Pricing
3
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
+ *
5
+ * The version of the OpenAPI document: 2022-05-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
+ * Amazon Prime details.
14
+ * @export
15
+ * @interface PrimeDetails
16
+ */
17
+ export interface PrimeDetails {
18
+ /**
19
+ * Indicates whether the offer is an Amazon Prime offer.
20
+ * @type {string}
21
+ * @memberof PrimeDetails
22
+ */
23
+ 'eligibility': PrimeDetailsEligibilityEnum;
24
+ }
25
+ export declare const PrimeDetailsEligibilityEnum: {
26
+ readonly National: "NATIONAL";
27
+ readonly Regional: "REGIONAL";
28
+ readonly None: "NONE";
29
+ };
30
+ export type PrimeDetailsEligibilityEnum = typeof PrimeDetailsEligibilityEnum[keyof typeof PrimeDetailsEligibilityEnum];
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Selling Partner API for Pricing
3
+ * The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the [Product Pricing v2022-05-01 Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
4
+ *
5
+ * The version of the OpenAPI document: 2022-05-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 { MoneyType } from './money-type';
13
+ /**
14
+ * The reference price for the given ASIN `marketplaceId` combination.
15
+ * @export
16
+ * @interface ReferencePrice
17
+ */
18
+ export interface ReferencePrice {
19
+ /**
20
+ * The name of the reference price like `CompetitivePriceThreshold`.
21
+ * @type {string}
22
+ * @memberof ReferencePrice
23
+ */
24
+ 'name': string;
25
+ /**
26
+ *
27
+ * @type {MoneyType}
28
+ * @memberof ReferencePrice
29
+ */
30
+ 'price': MoneyType;
31
+ }
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/product-pricing-api-2022-05-01",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Pricing helps you programmatically retrieve product pricing and offer pricing information for Amazon Marketplace products. For more information, refer to the Product Pricing v2022-05-01 Use Case Guide.",
5
- "version": "2.2.0",
5
+ "version": "2.3.1",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -18,8 +18,8 @@
18
18
  "dist/**/*.d.ts"
19
19
  ],
20
20
  "dependencies": {
21
- "@sp-api-sdk/common": "2.0.8",
22
- "axios": "^1.7.0"
21
+ "@sp-api-sdk/common": "2.0.10",
22
+ "axios": "^1.7.2"
23
23
  },
24
24
  "repository": {
25
25
  "type": "git",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "product pricing api"
42
42
  ],
43
- "gitHead": "5a245a25a9f1765c825e2178668d4b0f4e44689b"
43
+ "gitHead": "c646647a684e625c54e35ff8c141791efd60417c"
44
44
  }