@sp-api-sdk/product-pricing-api-2022-05-01 2.6.1 → 2.7.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/dist/cjs/api-model/api/product-pricing-api.js +8 -8
- package/dist/cjs/api-model/models/competitive-summary-included-data.js +1 -1
- package/dist/es/api-model/api/product-pricing-api.js +8 -8
- package/dist/es/api-model/models/competitive-summary-included-data.js +1 -1
- package/dist/types/api-model/api/product-pricing-api.d.ts +8 -8
- package/dist/types/api-model/models/batch-request.d.ts +3 -3
- package/dist/types/api-model/models/batch-response.d.ts +1 -1
- package/dist/types/api-model/models/competitive-summary-batch-response.d.ts +2 -2
- package/dist/types/api-model/models/competitive-summary-included-data.d.ts +1 -1
- package/dist/types/api-model/models/competitive-summary-request.d.ts +3 -3
- package/dist/types/api-model/models/competitive-summary-response-body.d.ts +5 -5
- package/dist/types/api-model/models/errors.d.ts +1 -1
- package/dist/types/api-model/models/featured-buying-option.d.ts +3 -3
- package/dist/types/api-model/models/featured-offer-expected-price-request.d.ts +1 -1
- package/dist/types/api-model/models/featured-offer-expected-price-response-body.d.ts +3 -3
- package/dist/types/api-model/models/featured-offer-expected-price-response.d.ts +1 -1
- package/dist/types/api-model/models/featured-offer-expected-price-result.d.ts +2 -2
- package/dist/types/api-model/models/featured-offer-segment.d.ts +1 -1
- package/dist/types/api-model/models/get-featured-offer-expected-price-batch-request.d.ts +1 -1
- package/dist/types/api-model/models/get-featured-offer-expected-price-batch-response.d.ts +1 -1
- package/dist/types/api-model/models/http-status-line.d.ts +3 -3
- package/dist/types/api-model/models/lowest-priced-offer.d.ts +2 -2
- package/dist/types/api-model/models/lowest-priced-offers-input.d.ts +2 -2
- package/dist/types/api-model/models/money-type.d.ts +1 -1
- package/dist/types/api-model/models/offer-identifier.d.ts +3 -3
- package/dist/types/api-model/models/offer.d.ts +1 -1
- package/dist/types/api-model/models/points.d.ts +2 -2
- package/dist/types/api-model/models/price.d.ts +1 -1
- package/dist/types/api-model/models/reference-price.d.ts +2 -2
- package/dist/types/api-model/models/segment-details.d.ts +1 -1
- package/dist/types/api-model/models/shipping-option.d.ts +1 -1
- package/package.json +3 -3
|
@@ -30,7 +30,7 @@ const base_1 = require("../base");
|
|
|
30
30
|
const ProductPricingApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
33
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
34
34
|
* @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
36
36
|
* @throws {RequiredError}
|
|
@@ -59,7 +59,7 @@ const ProductPricingApiAxiosParamCreator = function (configuration) {
|
|
|
59
59
|
};
|
|
60
60
|
},
|
|
61
61
|
/**
|
|
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
|
|
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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
63
63
|
* @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
@@ -98,7 +98,7 @@ const ProductPricingApiFp = function (configuration) {
|
|
|
98
98
|
const localVarAxiosParamCreator = (0, exports.ProductPricingApiAxiosParamCreator)(configuration);
|
|
99
99
|
return {
|
|
100
100
|
/**
|
|
101
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
101
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
102
102
|
* @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
104
104
|
* @throws {RequiredError}
|
|
@@ -110,7 +110,7 @@ const ProductPricingApiFp = function (configuration) {
|
|
|
110
110
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
111
111
|
},
|
|
112
112
|
/**
|
|
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
|
|
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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
114
114
|
* @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
|
|
115
115
|
* @param {*} [options] Override http request option.
|
|
116
116
|
* @throws {RequiredError}
|
|
@@ -132,7 +132,7 @@ const ProductPricingApiFactory = function (configuration, basePath, axios) {
|
|
|
132
132
|
const localVarFp = (0, exports.ProductPricingApiFp)(configuration);
|
|
133
133
|
return {
|
|
134
134
|
/**
|
|
135
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
135
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
136
136
|
* @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
|
|
137
137
|
* @param {*} [options] Override http request option.
|
|
138
138
|
* @throws {RequiredError}
|
|
@@ -141,7 +141,7 @@ const ProductPricingApiFactory = function (configuration, basePath, axios) {
|
|
|
141
141
|
return localVarFp.getCompetitiveSummary(requestParameters.requests, options).then((request) => request(axios, basePath));
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* 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
|
|
144
|
+
* 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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
145
145
|
* @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
|
|
146
146
|
* @param {*} [options] Override http request option.
|
|
147
147
|
* @throws {RequiredError}
|
|
@@ -160,7 +160,7 @@ exports.ProductPricingApiFactory = ProductPricingApiFactory;
|
|
|
160
160
|
*/
|
|
161
161
|
class ProductPricingApi extends base_1.BaseAPI {
|
|
162
162
|
/**
|
|
163
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
163
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
164
164
|
* @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
@@ -170,7 +170,7 @@ class ProductPricingApi extends base_1.BaseAPI {
|
|
|
170
170
|
return (0, exports.ProductPricingApiFp)(this.configuration).getCompetitiveSummary(requestParameters.requests, options).then((request) => request(this.axios, this.basePath));
|
|
171
171
|
}
|
|
172
172
|
/**
|
|
173
|
-
* 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
|
|
173
|
+
* 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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
174
174
|
* @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
|
|
175
175
|
* @param {*} [options] Override http request option.
|
|
176
176
|
* @throws {RequiredError}
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.CompetitiveSummaryIncludedData = void 0;
|
|
17
17
|
/**
|
|
18
|
-
* The supported types
|
|
18
|
+
* The supported data types in the `getCompetitiveSummary` API.
|
|
19
19
|
* @export
|
|
20
20
|
* @enum {string}
|
|
21
21
|
*/
|
|
@@ -24,7 +24,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
24
24
|
export const ProductPricingApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
27
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
28
28
|
* @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
@@ -53,7 +53,7 @@ export const ProductPricingApiAxiosParamCreator = function (configuration) {
|
|
|
53
53
|
};
|
|
54
54
|
},
|
|
55
55
|
/**
|
|
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
|
|
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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
57
57
|
* @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
|
|
58
58
|
* @param {*} [options] Override http request option.
|
|
59
59
|
* @throws {RequiredError}
|
|
@@ -91,7 +91,7 @@ export const ProductPricingApiFp = function (configuration) {
|
|
|
91
91
|
const localVarAxiosParamCreator = ProductPricingApiAxiosParamCreator(configuration);
|
|
92
92
|
return {
|
|
93
93
|
/**
|
|
94
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
94
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
95
95
|
* @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
|
|
96
96
|
* @param {*} [options] Override http request option.
|
|
97
97
|
* @throws {RequiredError}
|
|
@@ -103,7 +103,7 @@ export const ProductPricingApiFp = function (configuration) {
|
|
|
103
103
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
104
104
|
},
|
|
105
105
|
/**
|
|
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
|
|
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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
107
107
|
* @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
|
|
108
108
|
* @param {*} [options] Override http request option.
|
|
109
109
|
* @throws {RequiredError}
|
|
@@ -124,7 +124,7 @@ export const ProductPricingApiFactory = function (configuration, basePath, axios
|
|
|
124
124
|
const localVarFp = ProductPricingApiFp(configuration);
|
|
125
125
|
return {
|
|
126
126
|
/**
|
|
127
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
127
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
128
128
|
* @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
|
|
129
129
|
* @param {*} [options] Override http request option.
|
|
130
130
|
* @throws {RequiredError}
|
|
@@ -133,7 +133,7 @@ export const ProductPricingApiFactory = function (configuration, basePath, axios
|
|
|
133
133
|
return localVarFp.getCompetitiveSummary(requestParameters.requests, options).then((request) => request(axios, basePath));
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* 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
|
|
136
|
+
* 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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
137
137
|
* @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
|
|
138
138
|
* @param {*} [options] Override http request option.
|
|
139
139
|
* @throws {RequiredError}
|
|
@@ -151,7 +151,7 @@ export const ProductPricingApiFactory = function (configuration, basePath, axios
|
|
|
151
151
|
*/
|
|
152
152
|
export class ProductPricingApi extends BaseAPI {
|
|
153
153
|
/**
|
|
154
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
154
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
155
155
|
* @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
|
|
156
156
|
* @param {*} [options] Override http request option.
|
|
157
157
|
* @throws {RequiredError}
|
|
@@ -161,7 +161,7 @@ export class ProductPricingApi extends BaseAPI {
|
|
|
161
161
|
return ProductPricingApiFp(this.configuration).getCompetitiveSummary(requestParameters.requests, options).then((request) => request(this.axios, this.basePath));
|
|
162
162
|
}
|
|
163
163
|
/**
|
|
164
|
-
* 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
|
|
164
|
+
* 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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
165
165
|
* @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
|
|
166
166
|
* @param {*} [options] Override http request option.
|
|
167
167
|
* @throws {RequiredError}
|
|
@@ -23,14 +23,14 @@ import type { GetFeaturedOfferExpectedPriceBatchResponse } from '../models';
|
|
|
23
23
|
*/
|
|
24
24
|
export declare const ProductPricingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
25
|
/**
|
|
26
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
26
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
27
27
|
* @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
|
|
28
28
|
* @param {*} [options] Override http request option.
|
|
29
29
|
* @throws {RequiredError}
|
|
30
30
|
*/
|
|
31
31
|
getCompetitiveSummary: (requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
32
|
/**
|
|
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
|
|
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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
34
34
|
* @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
36
36
|
* @throws {RequiredError}
|
|
@@ -43,14 +43,14 @@ export declare const ProductPricingApiAxiosParamCreator: (configuration?: Config
|
|
|
43
43
|
*/
|
|
44
44
|
export declare const ProductPricingApiFp: (configuration?: Configuration) => {
|
|
45
45
|
/**
|
|
46
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
46
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
47
47
|
* @param {CompetitiveSummaryBatchRequest} requests The batch of `getCompetitiveSummary` requests.
|
|
48
48
|
* @param {*} [options] Override http request option.
|
|
49
49
|
* @throws {RequiredError}
|
|
50
50
|
*/
|
|
51
51
|
getCompetitiveSummary(requests: CompetitiveSummaryBatchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompetitiveSummaryBatchResponse>>;
|
|
52
52
|
/**
|
|
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
|
|
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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
54
54
|
* @param {GetFeaturedOfferExpectedPriceBatchRequest} getFeaturedOfferExpectedPriceBatchRequestBody The batch of `getFeaturedOfferExpectedPrice` requests.
|
|
55
55
|
* @param {*} [options] Override http request option.
|
|
56
56
|
* @throws {RequiredError}
|
|
@@ -63,14 +63,14 @@ export declare const ProductPricingApiFp: (configuration?: Configuration) => {
|
|
|
63
63
|
*/
|
|
64
64
|
export declare const ProductPricingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
65
65
|
/**
|
|
66
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
66
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
67
67
|
* @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
|
|
68
68
|
* @param {*} [options] Override http request option.
|
|
69
69
|
* @throws {RequiredError}
|
|
70
70
|
*/
|
|
71
71
|
getCompetitiveSummary(requestParameters: ProductPricingApiGetCompetitiveSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<CompetitiveSummaryBatchResponse>;
|
|
72
72
|
/**
|
|
73
|
-
* 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
|
|
73
|
+
* 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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
74
74
|
* @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
|
|
75
75
|
* @param {*} [options] Override http request option.
|
|
76
76
|
* @throws {RequiredError}
|
|
@@ -111,7 +111,7 @@ export interface ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest {
|
|
|
111
111
|
*/
|
|
112
112
|
export declare class ProductPricingApi extends BaseAPI {
|
|
113
113
|
/**
|
|
114
|
-
* Returns the competitive summary response including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that
|
|
114
|
+
* Returns the competitive summary response, including featured buying options for the ASIN and `marketplaceId` combination. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.033 | 1 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
115
115
|
* @param {ProductPricingApiGetCompetitiveSummaryRequest} requestParameters Request parameters.
|
|
116
116
|
* @param {*} [options] Override http request option.
|
|
117
117
|
* @throws {RequiredError}
|
|
@@ -119,7 +119,7 @@ export declare class ProductPricingApi extends BaseAPI {
|
|
|
119
119
|
*/
|
|
120
120
|
getCompetitiveSummary(requestParameters: ProductPricingApiGetCompetitiveSummaryRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CompetitiveSummaryBatchResponse, any>>;
|
|
121
121
|
/**
|
|
122
|
-
* 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
|
|
122
|
+
* 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 might change. Other offers might be featured based on factors such as 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 are applied to the requested operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may receive higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api) in the Selling Partner API.
|
|
123
123
|
* @param {ProductPricingApiGetFeaturedOfferExpectedPriceBatchRequest} requestParameters Request parameters.
|
|
124
124
|
* @param {*} [options] Override http request option.
|
|
125
125
|
* @throws {RequiredError}
|
|
@@ -17,7 +17,7 @@ import type { HttpMethod } from './http-method';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface BatchRequest {
|
|
19
19
|
/**
|
|
20
|
-
* The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this
|
|
20
|
+
* The URI associated with an individual request within a batch. For `FeaturedOfferExpectedPrice`, this is `/products/pricing/2022-05-01/offer/featuredOfferExpectedPrice`.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof BatchRequest
|
|
23
23
|
*/
|
|
@@ -29,7 +29,7 @@ export interface BatchRequest {
|
|
|
29
29
|
*/
|
|
30
30
|
'method': HttpMethod;
|
|
31
31
|
/**
|
|
32
|
-
* Additional HTTP body information associated with an individual request within a batch.
|
|
32
|
+
* Additional HTTP body information that is associated with an individual request within a batch.
|
|
33
33
|
* @type {{ [key: string]: object; }}
|
|
34
34
|
* @memberof BatchRequest
|
|
35
35
|
*/
|
|
@@ -37,7 +37,7 @@ export interface BatchRequest {
|
|
|
37
37
|
[key: string]: object;
|
|
38
38
|
};
|
|
39
39
|
/**
|
|
40
|
-
* A mapping of additional HTTP headers to send
|
|
40
|
+
* A mapping of additional HTTP headers to send or receive for an individual request within a batch.
|
|
41
41
|
* @type {{ [key: string]: string; }}
|
|
42
42
|
* @memberof BatchRequest
|
|
43
43
|
*/
|
|
@@ -17,7 +17,7 @@ import type { HttpStatusLine } from './http-status-line';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface BatchResponse {
|
|
19
19
|
/**
|
|
20
|
-
* A mapping of additional HTTP headers to send
|
|
20
|
+
* A mapping of additional HTTP headers to send or receive for an individual request within a batch.
|
|
21
21
|
* @type {{ [key: string]: string; }}
|
|
22
22
|
* @memberof BatchResponse
|
|
23
23
|
*/
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { CompetitiveSummaryResponse } from './competitive-summary-response';
|
|
13
13
|
/**
|
|
14
|
-
* The response schema
|
|
14
|
+
* The response schema for the `competitiveSummaryBatch` operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface CompetitiveSummaryBatchResponse
|
|
17
17
|
*/
|
|
18
18
|
export interface CompetitiveSummaryBatchResponse {
|
|
19
19
|
/**
|
|
20
|
-
* The response list
|
|
20
|
+
* The response list for the `competitiveSummaryBatch` operation.
|
|
21
21
|
* @type {Array<CompetitiveSummaryResponse>}
|
|
22
22
|
* @memberof CompetitiveSummaryBatchResponse
|
|
23
23
|
*/
|
|
@@ -19,7 +19,7 @@ import type { LowestPricedOffersInput } from './lowest-priced-offers-input';
|
|
|
19
19
|
*/
|
|
20
20
|
export interface CompetitiveSummaryRequest {
|
|
21
21
|
/**
|
|
22
|
-
* The
|
|
22
|
+
* The ASIN of the item.
|
|
23
23
|
* @type {string}
|
|
24
24
|
* @memberof CompetitiveSummaryRequest
|
|
25
25
|
*/
|
|
@@ -37,7 +37,7 @@ export interface CompetitiveSummaryRequest {
|
|
|
37
37
|
*/
|
|
38
38
|
'includedData': Array<CompetitiveSummaryIncludedData>;
|
|
39
39
|
/**
|
|
40
|
-
* The list of `lowestPricedOffersInput` parameters used to build
|
|
40
|
+
* The list of `lowestPricedOffersInput` parameters that are used to build `lowestPricedOffers` in the response. This attribute is only valid if `lowestPricedOffers` is requested in `includedData`
|
|
41
41
|
* @type {Array<LowestPricedOffersInput>}
|
|
42
42
|
* @memberof CompetitiveSummaryRequest
|
|
43
43
|
*/
|
|
@@ -49,7 +49,7 @@ export interface CompetitiveSummaryRequest {
|
|
|
49
49
|
*/
|
|
50
50
|
'method': HttpMethod;
|
|
51
51
|
/**
|
|
52
|
-
* The URI associated with the individual APIs
|
|
52
|
+
* The URI associated with the individual APIs that are called as part of the batch request.
|
|
53
53
|
* @type {string}
|
|
54
54
|
* @memberof CompetitiveSummaryRequest
|
|
55
55
|
*/
|
|
@@ -19,7 +19,7 @@ import type { ReferencePrice } from './reference-price';
|
|
|
19
19
|
*/
|
|
20
20
|
export interface CompetitiveSummaryResponseBody {
|
|
21
21
|
/**
|
|
22
|
-
* The
|
|
22
|
+
* The ASIN of the item.
|
|
23
23
|
* @type {string}
|
|
24
24
|
* @memberof CompetitiveSummaryResponseBody
|
|
25
25
|
*/
|
|
@@ -31,25 +31,25 @@ export interface CompetitiveSummaryResponseBody {
|
|
|
31
31
|
*/
|
|
32
32
|
'marketplaceId': string;
|
|
33
33
|
/**
|
|
34
|
-
* A list of featured buying options for the
|
|
34
|
+
* A list of featured buying options for the specified ASIN `marketplaceId` combination.
|
|
35
35
|
* @type {Array<FeaturedBuyingOption>}
|
|
36
36
|
* @memberof CompetitiveSummaryResponseBody
|
|
37
37
|
*/
|
|
38
38
|
'featuredBuyingOptions'?: Array<FeaturedBuyingOption>;
|
|
39
39
|
/**
|
|
40
|
-
* A list of
|
|
40
|
+
* A list of lowest priced offers for the specified ASIN `marketplaceId` combination.
|
|
41
41
|
* @type {Array<LowestPricedOffer>}
|
|
42
42
|
* @memberof CompetitiveSummaryResponseBody
|
|
43
43
|
*/
|
|
44
44
|
'lowestPricedOffers'?: Array<LowestPricedOffer>;
|
|
45
45
|
/**
|
|
46
|
-
* A list of reference prices for the
|
|
46
|
+
* A list of reference prices for the specified ASIN `marketplaceId` combination.
|
|
47
47
|
* @type {Array<ReferencePrice>}
|
|
48
48
|
* @memberof CompetitiveSummaryResponseBody
|
|
49
49
|
*/
|
|
50
50
|
'referencePrices'?: Array<ReferencePrice>;
|
|
51
51
|
/**
|
|
52
|
-
* A list of error responses returned when a request is unsuccessful.
|
|
52
|
+
* A list of error responses that are returned when a request is unsuccessful.
|
|
53
53
|
* @type {Array<Error>}
|
|
54
54
|
* @memberof CompetitiveSummaryResponseBody
|
|
55
55
|
*/
|
|
@@ -11,19 +11,19 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { SegmentedFeaturedOffer } from './segmented-featured-offer';
|
|
13
13
|
/**
|
|
14
|
-
* Describes a featured buying option which includes a list of segmented featured offers for a particular item condition.
|
|
14
|
+
* Describes a featured buying option, which includes a list of segmented featured offers for a particular item condition.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface FeaturedBuyingOption
|
|
17
17
|
*/
|
|
18
18
|
export interface FeaturedBuyingOption {
|
|
19
19
|
/**
|
|
20
|
-
* The buying option type
|
|
20
|
+
* The buying option type for the featured offer. `buyingOptionType` represents the buying options that a customer receives on the detail page, such as `B2B`, `Fresh`, and `Subscribe n Save`. `buyingOptionType` currently supports `NEW` as a value.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof FeaturedBuyingOption
|
|
23
23
|
*/
|
|
24
24
|
'buyingOptionType': FeaturedBuyingOptionBuyingOptionTypeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region or postal code and buying option.
|
|
26
|
+
* A list of segmented featured offers for the current buying option type. A segment can be considered as a group of regional contexts that all have the same featured offer. A regional context is a combination of factors such as customer type, region, or postal code and buying option.
|
|
27
27
|
* @type {Array<SegmentedFeaturedOffer>}
|
|
28
28
|
* @memberof FeaturedBuyingOption
|
|
29
29
|
*/
|
|
@@ -13,7 +13,7 @@ import type { BatchRequest } from './batch-request';
|
|
|
13
13
|
import type { FeaturedOfferExpectedPriceRequestParams } from './featured-offer-expected-price-request-params';
|
|
14
14
|
/**
|
|
15
15
|
* @type FeaturedOfferExpectedPriceRequest
|
|
16
|
-
* An individual
|
|
16
|
+
* An individual FOEP request for a particular SKU.
|
|
17
17
|
* @export
|
|
18
18
|
*/
|
|
19
19
|
export type FeaturedOfferExpectedPriceRequest = BatchRequest & FeaturedOfferExpectedPriceRequestParams;
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { FeaturedOfferExpectedPriceResult } from './featured-offer-expected-price-result';
|
|
13
13
|
import type { OfferIdentifier } from './offer-identifier';
|
|
14
14
|
/**
|
|
15
|
-
* The
|
|
15
|
+
* The FOEP response data for a requested SKU.
|
|
16
16
|
* @export
|
|
17
17
|
* @interface FeaturedOfferExpectedPriceResponseBody
|
|
18
18
|
*/
|
|
@@ -24,13 +24,13 @@ export interface FeaturedOfferExpectedPriceResponseBody {
|
|
|
24
24
|
*/
|
|
25
25
|
'offerIdentifier'?: OfferIdentifier;
|
|
26
26
|
/**
|
|
27
|
-
* A list of
|
|
27
|
+
* A list of FOEP results for the requested offer.
|
|
28
28
|
* @type {Array<FeaturedOfferExpectedPriceResult>}
|
|
29
29
|
* @memberof FeaturedOfferExpectedPriceResponseBody
|
|
30
30
|
*/
|
|
31
31
|
'featuredOfferExpectedPriceResults'?: Array<FeaturedOfferExpectedPriceResult>;
|
|
32
32
|
/**
|
|
33
|
-
* A list of error responses returned when a request is unsuccessful.
|
|
33
|
+
* A list of error responses that are returned when a request is unsuccessful.
|
|
34
34
|
* @type {Array<Error>}
|
|
35
35
|
* @memberof FeaturedOfferExpectedPriceResponseBody
|
|
36
36
|
*/
|
|
@@ -13,7 +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
|
|
16
|
+
* Schema for an individual FOEP response.
|
|
17
17
|
* @export
|
|
18
18
|
*/
|
|
19
19
|
export type FeaturedOfferExpectedPriceResponse = BatchResponse & FeaturedOfferExpectedPriceResponseAllOf;
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { FeaturedOffer } from './featured-offer';
|
|
13
13
|
import type { FeaturedOfferExpectedPrice } from './featured-offer-expected-price';
|
|
14
14
|
/**
|
|
15
|
-
* The
|
|
15
|
+
* The FOEP result data for the requested offer.
|
|
16
16
|
* @export
|
|
17
17
|
* @interface FeaturedOfferExpectedPriceResult
|
|
18
18
|
*/
|
|
@@ -24,7 +24,7 @@ export interface FeaturedOfferExpectedPriceResult {
|
|
|
24
24
|
*/
|
|
25
25
|
'featuredOfferExpectedPrice'?: FeaturedOfferExpectedPrice;
|
|
26
26
|
/**
|
|
27
|
-
* The status of the
|
|
27
|
+
* The status of the FOEP computation. Possible values include `VALID_FOEP`, `NO_COMPETING_OFFER`, `OFFER_NOT_ELIGIBLE`, `OFFER_NOT_FOUND`, and `ASIN_NOT_ELIGIBLE`. Additional values might be added in the future.
|
|
28
28
|
* @type {string}
|
|
29
29
|
* @memberof FeaturedOfferExpectedPriceResult
|
|
30
30
|
*/
|
|
@@ -17,7 +17,7 @@ import type { SegmentDetails } from './segment-details';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface FeaturedOfferSegment {
|
|
19
19
|
/**
|
|
20
|
-
* The customer membership type that
|
|
20
|
+
* The customer membership type that makes up this segment
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof FeaturedOfferSegment
|
|
23
23
|
*/
|
|
@@ -17,7 +17,7 @@ import type { FeaturedOfferExpectedPriceRequest } from './featured-offer-expecte
|
|
|
17
17
|
*/
|
|
18
18
|
export interface GetFeaturedOfferExpectedPriceBatchRequest {
|
|
19
19
|
/**
|
|
20
|
-
* A batched list of
|
|
20
|
+
* A batched list of FOEP requests.
|
|
21
21
|
* @type {Array<FeaturedOfferExpectedPriceRequest>}
|
|
22
22
|
* @memberof GetFeaturedOfferExpectedPriceBatchRequest
|
|
23
23
|
*/
|
|
@@ -17,7 +17,7 @@ import type { FeaturedOfferExpectedPriceResponse } from './featured-offer-expect
|
|
|
17
17
|
*/
|
|
18
18
|
export interface GetFeaturedOfferExpectedPriceBatchResponse {
|
|
19
19
|
/**
|
|
20
|
-
* A batched list of
|
|
20
|
+
* A batched list of FOEP responses.
|
|
21
21
|
* @type {Array<FeaturedOfferExpectedPriceResponse>}
|
|
22
22
|
* @memberof GetFeaturedOfferExpectedPriceBatchResponse
|
|
23
23
|
*/
|
|
@@ -10,19 +10,19 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The HTTP status line associated with the response
|
|
13
|
+
* The HTTP status line associated with the response for an individual request within a batch. For more information, refer to [RFC 2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html).
|
|
14
14
|
* @export
|
|
15
15
|
* @interface HttpStatusLine
|
|
16
16
|
*/
|
|
17
17
|
export interface HttpStatusLine {
|
|
18
18
|
/**
|
|
19
|
-
* The HTTP response
|
|
19
|
+
* The HTTP response status code.
|
|
20
20
|
* @type {number}
|
|
21
21
|
* @memberof HttpStatusLine
|
|
22
22
|
*/
|
|
23
23
|
'statusCode'?: number;
|
|
24
24
|
/**
|
|
25
|
-
* The HTTP response
|
|
25
|
+
* The HTTP response reason phrase.
|
|
26
26
|
* @type {string}
|
|
27
27
|
* @memberof HttpStatusLine
|
|
28
28
|
*/
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { LowestPricedOffersInput } from './lowest-priced-offers-input';
|
|
13
13
|
import type { Offer } from './offer';
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* Describes the lowest priced offers for the specified item condition and offer type.
|
|
16
16
|
* @export
|
|
17
17
|
* @interface LowestPricedOffer
|
|
18
18
|
*/
|
|
@@ -24,7 +24,7 @@ export interface LowestPricedOffer {
|
|
|
24
24
|
*/
|
|
25
25
|
'lowestPricedOffersInput': LowestPricedOffersInput;
|
|
26
26
|
/**
|
|
27
|
-
* A list of up to 20 lowest priced offers that match the criteria specified in
|
|
27
|
+
* A list of up to 20 lowest priced offers that match the criteria specified in `lowestPricedOffersInput`.
|
|
28
28
|
* @type {Array<Offer>}
|
|
29
29
|
* @memberof LowestPricedOffer
|
|
30
30
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { Condition } from './condition';
|
|
13
13
|
/**
|
|
14
|
-
* The input required for building
|
|
14
|
+
* The input required for building `LowestPricedOffers` data in the response.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface LowestPricedOffersInput
|
|
17
17
|
*/
|
|
@@ -23,7 +23,7 @@ export interface LowestPricedOffersInput {
|
|
|
23
23
|
*/
|
|
24
24
|
'itemCondition': Condition;
|
|
25
25
|
/**
|
|
26
|
-
* The type of offers requested for
|
|
26
|
+
* The input parameter specifies the type of offers requested for `LowestPricedOffers`. This applies to `Consumer` and `Business` offers. `Consumer` is the default `offerType`.
|
|
27
27
|
* @type {string}
|
|
28
28
|
* @memberof LowestPricedOffersInput
|
|
29
29
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { FulfillmentType } from './fulfillment-type';
|
|
13
13
|
/**
|
|
14
|
-
* Identifies an offer from a particular seller
|
|
14
|
+
* Identifies an offer from a particular seller for a specified ASIN.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface OfferIdentifier
|
|
17
17
|
*/
|
|
@@ -29,13 +29,13 @@ export interface OfferIdentifier {
|
|
|
29
29
|
*/
|
|
30
30
|
'sellerId'?: string;
|
|
31
31
|
/**
|
|
32
|
-
* The seller
|
|
32
|
+
* The seller SKU of the item. This will only be present for the target offer, which belongs to the requesting seller.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof OfferIdentifier
|
|
35
35
|
*/
|
|
36
36
|
'sku'?: string;
|
|
37
37
|
/**
|
|
38
|
-
* The
|
|
38
|
+
* The ASIN of the item.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof OfferIdentifier
|
|
41
41
|
*/
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { MoneyType } from './money-type';
|
|
13
13
|
/**
|
|
14
|
-
* The number of Amazon Points offered with the purchase of an item
|
|
14
|
+
* The number of Amazon Points that are offered with the purchase of an item and the monetary value of these points.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface Points
|
|
17
17
|
*/
|
|
18
18
|
export interface Points {
|
|
19
19
|
/**
|
|
20
|
-
* The number of
|
|
20
|
+
* The number of Amazon Points.
|
|
21
21
|
* @type {number}
|
|
22
22
|
* @memberof Points
|
|
23
23
|
*/
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { MoneyType } from './money-type';
|
|
13
13
|
import type { Points } from './points';
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
* The schema for item\'s price information, including listing price, shipping price, and Amazon Points.
|
|
16
16
|
* @export
|
|
17
17
|
* @interface Price
|
|
18
18
|
*/
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { MoneyType } from './money-type';
|
|
13
13
|
/**
|
|
14
|
-
* The reference price for the
|
|
14
|
+
* The reference price for the specified ASIN `marketplaceId` combination.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface ReferencePrice
|
|
17
17
|
*/
|
|
18
18
|
export interface ReferencePrice {
|
|
19
19
|
/**
|
|
20
|
-
* The name of the reference price
|
|
20
|
+
* The name of the reference price, such as `CompetitivePriceThreshold` and `WasPrice`. For reference price definitions, refer to the [Use Case Guide](https://developer-docs.amazon.com/sp-api/docs/product-pricing-api-v2022-05-01-use-case-guide).
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof ReferencePrice
|
|
23
23
|
*/
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
*/
|
|
17
17
|
export interface SegmentDetails {
|
|
18
18
|
/**
|
|
19
|
-
*
|
|
19
|
+
* The glance view weighted percentage for this segment, which is the glance views for this segment as a percentage of total glance views across all segments for the ASIN. A higher percentage indicates that more Amazon customers receive this offer as the Featured Offer.
|
|
20
20
|
* @type {number}
|
|
21
21
|
* @memberof SegmentDetails
|
|
22
22
|
*/
|
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.
|
|
5
|
+
"version": "2.7.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.3",
|
|
22
22
|
"axios": "^1.7.7"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"product pricing api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "197cba539b751c24eb5cfc1dccf6fa4b1d8d4116"
|
|
44
44
|
}
|