@sp-api-sdk/orders-api-v0 1.8.5
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/LICENSE +21 -0
- package/README.md +58 -0
- package/dist/cjs/index.js +6 -0
- package/dist/cjs/src/api-model/api/orders-v0-api.js +513 -0
- package/dist/cjs/src/api-model/api.js +17 -0
- package/dist/cjs/src/api-model/base.js +62 -0
- package/dist/cjs/src/api-model/common.js +137 -0
- package/dist/cjs/src/api-model/configuration.js +42 -0
- package/dist/cjs/src/api-model/index.js +19 -0
- package/dist/cjs/src/api-model/models/address.js +25 -0
- package/dist/cjs/src/api-model/models/buyer-customized-info-detail.js +15 -0
- package/dist/cjs/src/api-model/models/buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/buyer-tax-info.js +15 -0
- package/dist/cjs/src/api-model/models/fulfillment-instruction.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-address-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-buyer-info-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-items-buyer-info-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-items-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-response.js +15 -0
- package/dist/cjs/src/api-model/models/get-orders-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +31 -0
- package/dist/cjs/src/api-model/models/item-buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/marketplace-tax-info.js +15 -0
- package/dist/cjs/src/api-model/models/model-error.js +15 -0
- package/dist/cjs/src/api-model/models/money.js +15 -0
- package/dist/cjs/src/api-model/models/order-address.js +15 -0
- package/dist/cjs/src/api-model/models/order-buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/order-item-buyer-info.js +15 -0
- package/dist/cjs/src/api-model/models/order-item.js +25 -0
- package/dist/cjs/src/api-model/models/order-items-buyer-info-list.js +15 -0
- package/dist/cjs/src/api-model/models/order-items-list.js +15 -0
- package/dist/cjs/src/api-model/models/order.js +62 -0
- package/dist/cjs/src/api-model/models/orders-list.js +15 -0
- package/dist/cjs/src/api-model/models/payment-execution-detail-item.js +15 -0
- package/dist/cjs/src/api-model/models/points-granted-detail.js +15 -0
- package/dist/cjs/src/api-model/models/product-info-detail.js +15 -0
- package/dist/cjs/src/api-model/models/tax-classification.js +15 -0
- package/dist/cjs/src/api-model/models/tax-collection.js +32 -0
- package/dist/cjs/src/client.js +65 -0
- package/dist/cjs/src/error.js +10 -0
- package/dist/es/index.js +3 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +505 -0
- package/dist/es/src/api-model/api.js +14 -0
- package/dist/es/src/api-model/base.js +56 -0
- package/dist/es/src/api-model/common.js +125 -0
- package/dist/es/src/api-model/configuration.js +38 -0
- package/dist/es/src/api-model/index.js +16 -0
- package/dist/es/src/api-model/models/address.js +22 -0
- package/dist/es/src/api-model/models/buyer-customized-info-detail.js +14 -0
- package/dist/es/src/api-model/models/buyer-info.js +14 -0
- package/dist/es/src/api-model/models/buyer-tax-info.js +14 -0
- package/dist/es/src/api-model/models/fulfillment-instruction.js +14 -0
- package/dist/es/src/api-model/models/get-order-address-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-buyer-info-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-items-buyer-info-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-items-response.js +14 -0
- package/dist/es/src/api-model/models/get-order-response.js +14 -0
- package/dist/es/src/api-model/models/get-orders-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +28 -0
- package/dist/es/src/api-model/models/item-buyer-info.js +14 -0
- package/dist/es/src/api-model/models/marketplace-tax-info.js +14 -0
- package/dist/es/src/api-model/models/model-error.js +14 -0
- package/dist/es/src/api-model/models/money.js +14 -0
- package/dist/es/src/api-model/models/order-address.js +14 -0
- package/dist/es/src/api-model/models/order-buyer-info.js +14 -0
- package/dist/es/src/api-model/models/order-item-buyer-info.js +14 -0
- package/dist/es/src/api-model/models/order-item.js +22 -0
- package/dist/es/src/api-model/models/order-items-buyer-info-list.js +14 -0
- package/dist/es/src/api-model/models/order-items-list.js +14 -0
- package/dist/es/src/api-model/models/order.js +59 -0
- package/dist/es/src/api-model/models/orders-list.js +14 -0
- package/dist/es/src/api-model/models/payment-execution-detail-item.js +14 -0
- package/dist/es/src/api-model/models/points-granted-detail.js +14 -0
- package/dist/es/src/api-model/models/product-info-detail.js +14 -0
- package/dist/es/src/api-model/models/tax-classification.js +14 -0
- package/dist/es/src/api-model/models/tax-collection.js +29 -0
- package/dist/es/src/client.js +61 -0
- package/dist/es/src/error.js +6 -0
- package/dist/types/index.d.ts +3 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +460 -0
- package/dist/types/src/api-model/api.d.ts +12 -0
- package/dist/types/src/api-model/base.d.ts +55 -0
- package/dist/types/src/api-model/common.d.ts +65 -0
- package/dist/types/src/api-model/configuration.d.ts +83 -0
- package/dist/types/src/api-model/index.d.ts +14 -0
- package/dist/types/src/api-model/models/address.d.ts +104 -0
- package/dist/types/src/api-model/models/buyer-customized-info-detail.d.ts +24 -0
- package/dist/types/src/api-model/models/buyer-info.d.ts +49 -0
- package/dist/types/src/api-model/models/buyer-tax-info.d.ts +37 -0
- package/dist/types/src/api-model/models/fulfillment-instruction.d.ts +24 -0
- package/dist/types/src/api-model/models/get-order-address-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-buyer-info-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-items-buyer-info-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-items-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-order-response.d.ts +31 -0
- package/dist/types/src/api-model/models/get-orders-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +28 -0
- package/dist/types/src/api-model/models/item-buyer-info.d.ts +50 -0
- package/dist/types/src/api-model/models/marketplace-tax-info.d.ts +25 -0
- package/dist/types/src/api-model/models/model-error.d.ts +36 -0
- package/dist/types/src/api-model/models/money.d.ts +30 -0
- package/dist/types/src/api-model/models/order-address.d.ts +31 -0
- package/dist/types/src/api-model/models/order-buyer-info.d.ts +55 -0
- package/dist/types/src/api-model/models/order-item-buyer-info.d.ts +56 -0
- package/dist/types/src/api-model/models/order-item.d.ts +229 -0
- package/dist/types/src/api-model/models/order-items-buyer-info-list.d.ts +37 -0
- package/dist/types/src/api-model/models/order-items-list.d.ts +37 -0
- package/dist/types/src/api-model/models/order.d.ts +306 -0
- package/dist/types/src/api-model/models/orders-list.d.ts +43 -0
- package/dist/types/src/api-model/models/payment-execution-detail-item.d.ts +31 -0
- package/dist/types/src/api-model/models/points-granted-detail.d.ts +31 -0
- package/dist/types/src/api-model/models/product-info-detail.d.ts +24 -0
- package/dist/types/src/api-model/models/tax-classification.d.ts +30 -0
- package/dist/types/src/api-model/models/tax-collection.d.ts +44 -0
- package/dist/types/src/client.d.ts +13 -0
- package/dist/types/src/error.d.ts +3 -0
- package/package.json +53 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2021 Bizon
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# `orders-api-v0`
|
|
2
|
+
|
|
3
|
+
The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
4
|
+
|
|
5
|
+
## Installing
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
yarn add @sp-api-sdk/orders-api-v0
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```sh
|
|
12
|
+
npm install @sp-api-sdk/orders-api-v0
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Getting Started
|
|
16
|
+
|
|
17
|
+
```javascript
|
|
18
|
+
import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
|
|
19
|
+
import {OrdersApiClient} from '@sp-api-sdk/orders-api-v0'
|
|
20
|
+
|
|
21
|
+
const auth = new SellingPartnerApiAuth({
|
|
22
|
+
clientId: '',
|
|
23
|
+
clientSecret: '',
|
|
24
|
+
refreshToken: '',
|
|
25
|
+
secretAccessKey: '',
|
|
26
|
+
accessKeyId: '',
|
|
27
|
+
region: '',
|
|
28
|
+
role: {
|
|
29
|
+
arn: '',
|
|
30
|
+
}
|
|
31
|
+
})
|
|
32
|
+
|
|
33
|
+
const client = new OrdersApiClient({
|
|
34
|
+
auth,
|
|
35
|
+
region: 'eu' // or 'eu-west-1'
|
|
36
|
+
})
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Handle Rate Limiting
|
|
40
|
+
|
|
41
|
+
If you want to let the SDK retry after each 429 responses, instanciate the client like this:
|
|
42
|
+
|
|
43
|
+
```javascript
|
|
44
|
+
const client = new OrdersApiClient({
|
|
45
|
+
auth,
|
|
46
|
+
region: 'eu',
|
|
47
|
+
rateLimiting: {
|
|
48
|
+
retry: true,
|
|
49
|
+
onRetry: (retryInfo) => console.log(retryInfo) // Optional
|
|
50
|
+
}
|
|
51
|
+
})
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
The SDK gets the rate limits for each routes from the API documentation
|
|
55
|
+
|
|
56
|
+
## API documentation
|
|
57
|
+
|
|
58
|
+
See [here](https://github.com/amzn/selling-partner-api-docs/tree/main/references/orders-api/ordersV0.md)
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
(0, tslib_1.__exportStar)(require("./src/client"), exports);
|
|
5
|
+
(0, tslib_1.__exportStar)(require("./src/error"), exports);
|
|
6
|
+
(0, tslib_1.__exportStar)(require("./src/api-model/models"), exports);
|
|
@@ -0,0 +1,513 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Selling Partner API for Orders
|
|
6
|
+
* The Selling Partner API for Orders helps you programmatically retrieve order information. These APIs let you develop fast, flexible, custom applications in areas like order synchronization, order research, and demand-based decision support tools.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: v0
|
|
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.OrdersV0Api = exports.OrdersV0ApiFactory = exports.OrdersV0ApiFp = exports.OrdersV0ApiAxiosParamCreator = void 0;
|
|
17
|
+
const tslib_1 = require("tslib");
|
|
18
|
+
const axios_1 = (0, tslib_1.__importDefault)(require("axios"));
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
const common_1 = require("../common");
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
const base_1 = require("../base");
|
|
24
|
+
/**
|
|
25
|
+
* OrdersV0Api - axios parameter creator
|
|
26
|
+
* @export
|
|
27
|
+
*/
|
|
28
|
+
const OrdersV0ApiAxiosParamCreator = function (configuration) {
|
|
29
|
+
return {
|
|
30
|
+
/**
|
|
31
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
32
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
getOrder: async (orderId, options = {}) => {
|
|
37
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
38
|
+
(0, common_1.assertParamExists)('getOrder', 'orderId', orderId);
|
|
39
|
+
const localVarPath = `/orders/v0/orders/{orderId}`
|
|
40
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
41
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
42
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
43
|
+
let baseOptions;
|
|
44
|
+
if (configuration) {
|
|
45
|
+
baseOptions = configuration.baseOptions;
|
|
46
|
+
}
|
|
47
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
48
|
+
const localVarHeaderParameter = {};
|
|
49
|
+
const localVarQueryParameter = {};
|
|
50
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
|
|
51
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
52
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
53
|
+
return {
|
|
54
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
55
|
+
options: localVarRequestOptions,
|
|
56
|
+
};
|
|
57
|
+
},
|
|
58
|
+
/**
|
|
59
|
+
* Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
60
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
61
|
+
* @param {*} [options] Override http request option.
|
|
62
|
+
* @throws {RequiredError}
|
|
63
|
+
*/
|
|
64
|
+
getOrderAddress: async (orderId, options = {}) => {
|
|
65
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
66
|
+
(0, common_1.assertParamExists)('getOrderAddress', 'orderId', orderId);
|
|
67
|
+
const localVarPath = `/orders/v0/orders/{orderId}/address`
|
|
68
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
69
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
70
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
71
|
+
let baseOptions;
|
|
72
|
+
if (configuration) {
|
|
73
|
+
baseOptions = configuration.baseOptions;
|
|
74
|
+
}
|
|
75
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
76
|
+
const localVarHeaderParameter = {};
|
|
77
|
+
const localVarQueryParameter = {};
|
|
78
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
|
|
79
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
80
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
81
|
+
return {
|
|
82
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
83
|
+
options: localVarRequestOptions,
|
|
84
|
+
};
|
|
85
|
+
},
|
|
86
|
+
/**
|
|
87
|
+
* Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
88
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
getOrderBuyerInfo: async (orderId, options = {}) => {
|
|
93
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
94
|
+
(0, common_1.assertParamExists)('getOrderBuyerInfo', 'orderId', orderId);
|
|
95
|
+
const localVarPath = `/orders/v0/orders/{orderId}/buyerInfo`
|
|
96
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
97
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
98
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
99
|
+
let baseOptions;
|
|
100
|
+
if (configuration) {
|
|
101
|
+
baseOptions = configuration.baseOptions;
|
|
102
|
+
}
|
|
103
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
104
|
+
const localVarHeaderParameter = {};
|
|
105
|
+
const localVarQueryParameter = {};
|
|
106
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
|
|
107
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
108
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
109
|
+
return {
|
|
110
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
111
|
+
options: localVarRequestOptions,
|
|
112
|
+
};
|
|
113
|
+
},
|
|
114
|
+
/**
|
|
115
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
116
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
117
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
118
|
+
* @param {*} [options] Override http request option.
|
|
119
|
+
* @throws {RequiredError}
|
|
120
|
+
*/
|
|
121
|
+
getOrderItems: async (orderId, nextToken, options = {}) => {
|
|
122
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
123
|
+
(0, common_1.assertParamExists)('getOrderItems', 'orderId', orderId);
|
|
124
|
+
const localVarPath = `/orders/v0/orders/{orderId}/orderItems`
|
|
125
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
126
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
127
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
128
|
+
let baseOptions;
|
|
129
|
+
if (configuration) {
|
|
130
|
+
baseOptions = configuration.baseOptions;
|
|
131
|
+
}
|
|
132
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
133
|
+
const localVarHeaderParameter = {};
|
|
134
|
+
const localVarQueryParameter = {};
|
|
135
|
+
if (nextToken !== undefined) {
|
|
136
|
+
localVarQueryParameter['NextToken'] = nextToken;
|
|
137
|
+
}
|
|
138
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
|
|
139
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
140
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
141
|
+
return {
|
|
142
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
143
|
+
options: localVarRequestOptions,
|
|
144
|
+
};
|
|
145
|
+
},
|
|
146
|
+
/**
|
|
147
|
+
* Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
148
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
149
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
150
|
+
* @param {*} [options] Override http request option.
|
|
151
|
+
* @throws {RequiredError}
|
|
152
|
+
*/
|
|
153
|
+
getOrderItemsBuyerInfo: async (orderId, nextToken, options = {}) => {
|
|
154
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
155
|
+
(0, common_1.assertParamExists)('getOrderItemsBuyerInfo', 'orderId', orderId);
|
|
156
|
+
const localVarPath = `/orders/v0/orders/{orderId}/orderItems/buyerInfo`
|
|
157
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
158
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
159
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
160
|
+
let baseOptions;
|
|
161
|
+
if (configuration) {
|
|
162
|
+
baseOptions = configuration.baseOptions;
|
|
163
|
+
}
|
|
164
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
165
|
+
const localVarHeaderParameter = {};
|
|
166
|
+
const localVarQueryParameter = {};
|
|
167
|
+
if (nextToken !== undefined) {
|
|
168
|
+
localVarQueryParameter['NextToken'] = nextToken;
|
|
169
|
+
}
|
|
170
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
|
|
171
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
172
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
173
|
+
return {
|
|
174
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
175
|
+
options: localVarRequestOptions,
|
|
176
|
+
};
|
|
177
|
+
},
|
|
178
|
+
/**
|
|
179
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
180
|
+
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
|
|
181
|
+
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
182
|
+
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
183
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
|
|
184
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
|
|
185
|
+
* @param {Array<string>} [orderStatuses] A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
|
|
186
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
|
|
187
|
+
* @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
|
|
188
|
+
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
189
|
+
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
|
190
|
+
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
191
|
+
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
|
|
192
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
193
|
+
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
194
|
+
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
195
|
+
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
196
|
+
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
getOrders: async (marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options = {}) => {
|
|
201
|
+
// verify required parameter 'marketplaceIds' is not null or undefined
|
|
202
|
+
(0, common_1.assertParamExists)('getOrders', 'marketplaceIds', marketplaceIds);
|
|
203
|
+
const localVarPath = `/orders/v0/orders`;
|
|
204
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
205
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
206
|
+
let baseOptions;
|
|
207
|
+
if (configuration) {
|
|
208
|
+
baseOptions = configuration.baseOptions;
|
|
209
|
+
}
|
|
210
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
211
|
+
const localVarHeaderParameter = {};
|
|
212
|
+
const localVarQueryParameter = {};
|
|
213
|
+
if (createdAfter !== undefined) {
|
|
214
|
+
localVarQueryParameter['CreatedAfter'] = createdAfter;
|
|
215
|
+
}
|
|
216
|
+
if (createdBefore !== undefined) {
|
|
217
|
+
localVarQueryParameter['CreatedBefore'] = createdBefore;
|
|
218
|
+
}
|
|
219
|
+
if (lastUpdatedAfter !== undefined) {
|
|
220
|
+
localVarQueryParameter['LastUpdatedAfter'] = lastUpdatedAfter;
|
|
221
|
+
}
|
|
222
|
+
if (lastUpdatedBefore !== undefined) {
|
|
223
|
+
localVarQueryParameter['LastUpdatedBefore'] = lastUpdatedBefore;
|
|
224
|
+
}
|
|
225
|
+
if (orderStatuses) {
|
|
226
|
+
localVarQueryParameter['OrderStatuses'] = orderStatuses.join(base_1.COLLECTION_FORMATS.csv);
|
|
227
|
+
}
|
|
228
|
+
if (marketplaceIds) {
|
|
229
|
+
localVarQueryParameter['MarketplaceIds'] = marketplaceIds.join(base_1.COLLECTION_FORMATS.csv);
|
|
230
|
+
}
|
|
231
|
+
if (fulfillmentChannels) {
|
|
232
|
+
localVarQueryParameter['FulfillmentChannels'] = fulfillmentChannels.join(base_1.COLLECTION_FORMATS.csv);
|
|
233
|
+
}
|
|
234
|
+
if (paymentMethods) {
|
|
235
|
+
localVarQueryParameter['PaymentMethods'] = paymentMethods.join(base_1.COLLECTION_FORMATS.csv);
|
|
236
|
+
}
|
|
237
|
+
if (buyerEmail !== undefined) {
|
|
238
|
+
localVarQueryParameter['BuyerEmail'] = buyerEmail;
|
|
239
|
+
}
|
|
240
|
+
if (sellerOrderId !== undefined) {
|
|
241
|
+
localVarQueryParameter['SellerOrderId'] = sellerOrderId;
|
|
242
|
+
}
|
|
243
|
+
if (maxResultsPerPage !== undefined) {
|
|
244
|
+
localVarQueryParameter['MaxResultsPerPage'] = maxResultsPerPage;
|
|
245
|
+
}
|
|
246
|
+
if (easyShipShipmentStatuses) {
|
|
247
|
+
localVarQueryParameter['EasyShipShipmentStatuses'] = easyShipShipmentStatuses.join(base_1.COLLECTION_FORMATS.csv);
|
|
248
|
+
}
|
|
249
|
+
if (nextToken !== undefined) {
|
|
250
|
+
localVarQueryParameter['NextToken'] = nextToken;
|
|
251
|
+
}
|
|
252
|
+
if (amazonOrderIds) {
|
|
253
|
+
localVarQueryParameter['AmazonOrderIds'] = amazonOrderIds.join(base_1.COLLECTION_FORMATS.csv);
|
|
254
|
+
}
|
|
255
|
+
if (actualFulfillmentSupplySourceId !== undefined) {
|
|
256
|
+
localVarQueryParameter['ActualFulfillmentSupplySourceId'] = actualFulfillmentSupplySourceId;
|
|
257
|
+
}
|
|
258
|
+
if (isISPU !== undefined) {
|
|
259
|
+
localVarQueryParameter['IsISPU'] = isISPU;
|
|
260
|
+
}
|
|
261
|
+
if (storeChainStoreId !== undefined) {
|
|
262
|
+
localVarQueryParameter['StoreChainStoreId'] = storeChainStoreId;
|
|
263
|
+
}
|
|
264
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter, options.query);
|
|
265
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
266
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
267
|
+
return {
|
|
268
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
269
|
+
options: localVarRequestOptions,
|
|
270
|
+
};
|
|
271
|
+
},
|
|
272
|
+
};
|
|
273
|
+
};
|
|
274
|
+
exports.OrdersV0ApiAxiosParamCreator = OrdersV0ApiAxiosParamCreator;
|
|
275
|
+
/**
|
|
276
|
+
* OrdersV0Api - functional programming interface
|
|
277
|
+
* @export
|
|
278
|
+
*/
|
|
279
|
+
const OrdersV0ApiFp = function (configuration) {
|
|
280
|
+
const localVarAxiosParamCreator = (0, exports.OrdersV0ApiAxiosParamCreator)(configuration);
|
|
281
|
+
return {
|
|
282
|
+
/**
|
|
283
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
284
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
285
|
+
* @param {*} [options] Override http request option.
|
|
286
|
+
* @throws {RequiredError}
|
|
287
|
+
*/
|
|
288
|
+
async getOrder(orderId, options) {
|
|
289
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(orderId, options);
|
|
290
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
291
|
+
},
|
|
292
|
+
/**
|
|
293
|
+
* Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
294
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
295
|
+
* @param {*} [options] Override http request option.
|
|
296
|
+
* @throws {RequiredError}
|
|
297
|
+
*/
|
|
298
|
+
async getOrderAddress(orderId, options) {
|
|
299
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderAddress(orderId, options);
|
|
300
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
301
|
+
},
|
|
302
|
+
/**
|
|
303
|
+
* Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
304
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
305
|
+
* @param {*} [options] Override http request option.
|
|
306
|
+
* @throws {RequiredError}
|
|
307
|
+
*/
|
|
308
|
+
async getOrderBuyerInfo(orderId, options) {
|
|
309
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderBuyerInfo(orderId, options);
|
|
310
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
311
|
+
},
|
|
312
|
+
/**
|
|
313
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
314
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
315
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
316
|
+
* @param {*} [options] Override http request option.
|
|
317
|
+
* @throws {RequiredError}
|
|
318
|
+
*/
|
|
319
|
+
async getOrderItems(orderId, nextToken, options) {
|
|
320
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItems(orderId, nextToken, options);
|
|
321
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
322
|
+
},
|
|
323
|
+
/**
|
|
324
|
+
* Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
325
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
326
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
327
|
+
* @param {*} [options] Override http request option.
|
|
328
|
+
* @throws {RequiredError}
|
|
329
|
+
*/
|
|
330
|
+
async getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
331
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderItemsBuyerInfo(orderId, nextToken, options);
|
|
332
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
333
|
+
},
|
|
334
|
+
/**
|
|
335
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
336
|
+
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
|
|
337
|
+
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
338
|
+
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
339
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
|
|
340
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
|
|
341
|
+
* @param {Array<string>} [orderStatuses] A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
|
|
342
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
|
|
343
|
+
* @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
|
|
344
|
+
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
345
|
+
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
|
346
|
+
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
347
|
+
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
|
|
348
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
349
|
+
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
350
|
+
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
351
|
+
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
352
|
+
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
353
|
+
* @param {*} [options] Override http request option.
|
|
354
|
+
* @throws {RequiredError}
|
|
355
|
+
*/
|
|
356
|
+
async getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
357
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options);
|
|
358
|
+
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
359
|
+
},
|
|
360
|
+
};
|
|
361
|
+
};
|
|
362
|
+
exports.OrdersV0ApiFp = OrdersV0ApiFp;
|
|
363
|
+
/**
|
|
364
|
+
* OrdersV0Api - factory interface
|
|
365
|
+
* @export
|
|
366
|
+
*/
|
|
367
|
+
const OrdersV0ApiFactory = function (configuration, basePath, axios) {
|
|
368
|
+
const localVarFp = (0, exports.OrdersV0ApiFp)(configuration);
|
|
369
|
+
return {
|
|
370
|
+
/**
|
|
371
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
372
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
373
|
+
* @param {*} [options] Override http request option.
|
|
374
|
+
* @throws {RequiredError}
|
|
375
|
+
*/
|
|
376
|
+
getOrder(orderId, options) {
|
|
377
|
+
return localVarFp.getOrder(orderId, options).then((request) => request(axios, basePath));
|
|
378
|
+
},
|
|
379
|
+
/**
|
|
380
|
+
* Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
381
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
382
|
+
* @param {*} [options] Override http request option.
|
|
383
|
+
* @throws {RequiredError}
|
|
384
|
+
*/
|
|
385
|
+
getOrderAddress(orderId, options) {
|
|
386
|
+
return localVarFp.getOrderAddress(orderId, options).then((request) => request(axios, basePath));
|
|
387
|
+
},
|
|
388
|
+
/**
|
|
389
|
+
* Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
390
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
391
|
+
* @param {*} [options] Override http request option.
|
|
392
|
+
* @throws {RequiredError}
|
|
393
|
+
*/
|
|
394
|
+
getOrderBuyerInfo(orderId, options) {
|
|
395
|
+
return localVarFp.getOrderBuyerInfo(orderId, options).then((request) => request(axios, basePath));
|
|
396
|
+
},
|
|
397
|
+
/**
|
|
398
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
399
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
400
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
getOrderItems(orderId, nextToken, options) {
|
|
405
|
+
return localVarFp.getOrderItems(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
406
|
+
},
|
|
407
|
+
/**
|
|
408
|
+
* Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
409
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
410
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
411
|
+
* @param {*} [options] Override http request option.
|
|
412
|
+
* @throws {RequiredError}
|
|
413
|
+
*/
|
|
414
|
+
getOrderItemsBuyerInfo(orderId, nextToken, options) {
|
|
415
|
+
return localVarFp.getOrderItemsBuyerInfo(orderId, nextToken, options).then((request) => request(axios, basePath));
|
|
416
|
+
},
|
|
417
|
+
/**
|
|
418
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
419
|
+
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces.
|
|
420
|
+
* @param {string} [createdAfter] A date used for selecting orders created after (or at) a specified time. Only orders placed after the specified time are returned. Either the CreatedAfter parameter or the LastUpdatedAfter parameter is required. Both cannot be empty. The date must be in ISO 8601 format.
|
|
421
|
+
* @param {string} [createdBefore] A date used for selecting orders created before (or at) a specified time. Only orders placed before the specified time are returned. The date must be in ISO 8601 format.
|
|
422
|
+
* @param {string} [lastUpdatedAfter] A date used for selecting orders that were last updated after (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
|
|
423
|
+
* @param {string} [lastUpdatedBefore] A date used for selecting orders that were last updated before (or at) a specified time. An update is defined as any change in order status, including the creation of a new order. Includes updates made by Amazon and by the seller. The date must be in ISO 8601 format.
|
|
424
|
+
* @param {Array<string>} [orderStatuses] A list of OrderStatus values used to filter the results. Possible values: PendingAvailability (This status is available for pre-orders only. The order has been placed, payment has not been authorized, and the release date of the item is in the future.); Pending (The order has been placed but payment has not been authorized); Unshipped (Payment has been authorized and the order is ready for shipment, but no items in the order have been shipped); PartiallyShipped (One or more, but not all, items in the order have been shipped); Shipped (All items in the order have been shipped); InvoiceUnconfirmed (All items in the order have been shipped. The seller has not yet given confirmation to Amazon that the invoice has been shipped to the buyer.); Canceled (The order has been canceled); and Unfulfillable (The order cannot be fulfilled. This state applies only to Multi-Channel Fulfillment orders.).
|
|
425
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: FBA (Fulfillment by Amazon); SellerFulfilled (Fulfilled by the seller).
|
|
426
|
+
* @param {Array<string>} [paymentMethods] A list of payment method values. Used to select orders paid using the specified payment methods. Possible values: COD (Cash on delivery); CVS (Convenience store payment); Other (Any payment method other than COD or CVS).
|
|
427
|
+
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
428
|
+
* @param {string} [sellerOrderId] An order identifier that is specified by the seller. Used to select only the orders that match the order identifier. If SellerOrderId is specified, then FulfillmentChannels, OrderStatuses, PaymentMethod, LastUpdatedAfter, LastUpdatedBefore, and BuyerEmail cannot be specified.
|
|
429
|
+
* @param {number} [maxResultsPerPage] A number that indicates the maximum number of orders that can be returned per page. Value must be 1 - 100. Default 100.
|
|
430
|
+
* @param {Array<string>} [easyShipShipmentStatuses] A list of EasyShipShipmentStatus values. Used to select Easy Ship orders with statuses that match the specified values. If EasyShipShipmentStatus is specified, only Amazon Easy Ship orders are returned.Possible values: PendingPickUp (Amazon has not yet picked up the package from the seller). LabelCanceled (The seller canceled the pickup). PickedUp (Amazon has picked up the package from the seller). AtOriginFC (The packaged is at the origin fulfillment center). AtDestinationFC (The package is at the destination fulfillment center). OutForDelivery (The package is out for delivery). Damaged (The package was damaged by the carrier). Delivered (The package has been delivered to the buyer). RejectedByBuyer (The package has been rejected by the buyer). Undeliverable (The package cannot be delivered). ReturnedToSeller (The package was not delivered to the buyer and was returned to the seller). ReturningToSeller (The package was not delivered to the buyer and is being returned to the seller).
|
|
431
|
+
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
432
|
+
* @param {Array<string>} [amazonOrderIds] A list of AmazonOrderId values. An AmazonOrderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
433
|
+
* @param {string} [actualFulfillmentSupplySourceId] Denotes the recommended sourceId where the order should be fulfilled from.
|
|
434
|
+
* @param {boolean} [isISPU] When true, this order is marked to be picked up from a store rather than delivered.
|
|
435
|
+
* @param {string} [storeChainStoreId] The store chain store identifier. Linked to a specific store in a store chain.
|
|
436
|
+
* @param {*} [options] Override http request option.
|
|
437
|
+
* @throws {RequiredError}
|
|
438
|
+
*/
|
|
439
|
+
getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options) {
|
|
440
|
+
return localVarFp.getOrders(marketplaceIds, createdAfter, createdBefore, lastUpdatedAfter, lastUpdatedBefore, orderStatuses, fulfillmentChannels, paymentMethods, buyerEmail, sellerOrderId, maxResultsPerPage, easyShipShipmentStatuses, nextToken, amazonOrderIds, actualFulfillmentSupplySourceId, isISPU, storeChainStoreId, options).then((request) => request(axios, basePath));
|
|
441
|
+
},
|
|
442
|
+
};
|
|
443
|
+
};
|
|
444
|
+
exports.OrdersV0ApiFactory = OrdersV0ApiFactory;
|
|
445
|
+
/**
|
|
446
|
+
* OrdersV0Api - object-oriented interface
|
|
447
|
+
* @export
|
|
448
|
+
* @class OrdersV0Api
|
|
449
|
+
* @extends {BaseAPI}
|
|
450
|
+
*/
|
|
451
|
+
class OrdersV0Api extends base_1.BaseAPI {
|
|
452
|
+
/**
|
|
453
|
+
* Returns the order indicated by the specified order ID. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
454
|
+
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
455
|
+
* @param {*} [options] Override http request option.
|
|
456
|
+
* @throws {RequiredError}
|
|
457
|
+
* @memberof OrdersV0Api
|
|
458
|
+
*/
|
|
459
|
+
getOrder(requestParameters, options) {
|
|
460
|
+
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrder(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* Returns the shipping address for the specified order. **Important.** We recommend using the getOrders operation to get shipping address information for an order, as the getOrderAddress operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
464
|
+
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
465
|
+
* @param {*} [options] Override http request option.
|
|
466
|
+
* @throws {RequiredError}
|
|
467
|
+
* @memberof OrdersV0Api
|
|
468
|
+
*/
|
|
469
|
+
getOrderAddress(requestParameters, options) {
|
|
470
|
+
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderAddress(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
471
|
+
}
|
|
472
|
+
/**
|
|
473
|
+
* Returns buyer information for the specified order. **Important.** We recommend using the getOrders operation to get buyer information for an order, as the getOrderBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
474
|
+
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
475
|
+
* @param {*} [options] Override http request option.
|
|
476
|
+
* @throws {RequiredError}
|
|
477
|
+
* @memberof OrdersV0Api
|
|
478
|
+
*/
|
|
479
|
+
getOrderBuyerInfo(requestParameters, options) {
|
|
480
|
+
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderBuyerInfo(requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* Returns detailed order item information for the order indicated by the specified order ID. If NextToken is provided, it\'s used to retrieve the next page of order items. Note: When an order is in the Pending state (the order has been placed but payment has not been authorized), the getOrderItems operation does not return information about pricing, taxes, shipping charges, gift status or promotions for the order items in the order. After an order leaves the Pending state (this occurs when payment has been authorized) and enters the Unshipped, Partially Shipped, or Shipped state, the getOrderItems operation returns information about pricing, taxes, shipping charges, gift status and promotions for the order items in the order. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
484
|
+
* @param {OrdersV0ApiGetOrderItemsRequest} requestParameters Request parameters.
|
|
485
|
+
* @param {*} [options] Override http request option.
|
|
486
|
+
* @throws {RequiredError}
|
|
487
|
+
* @memberof OrdersV0Api
|
|
488
|
+
*/
|
|
489
|
+
getOrderItems(requestParameters, options) {
|
|
490
|
+
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderItems(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
491
|
+
}
|
|
492
|
+
/**
|
|
493
|
+
* Returns buyer information for the order items in the specified order. **Important.** We recommend using the getOrderItems operation to get buyer information for the order items in an order, as the getOrderItemsBuyerInfo operation is scheduled for deprecation on January 12, 2022. For more information, see the [Tokens API Use Case Guide](https://github.com/amzn/selling-partner-api-docs/blob/main/guides/en-US/use-case-guides/tokens-api-use-case-guide/tokens-API-use-case-guide-2021-03-01.md). **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
494
|
+
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
495
|
+
* @param {*} [options] Override http request option.
|
|
496
|
+
* @throws {RequiredError}
|
|
497
|
+
* @memberof OrdersV0Api
|
|
498
|
+
*/
|
|
499
|
+
getOrderItemsBuyerInfo(requestParameters, options) {
|
|
500
|
+
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrderItemsBuyerInfo(requestParameters.orderId, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
501
|
+
}
|
|
502
|
+
/**
|
|
503
|
+
* Returns orders created or updated during the time frame indicated by the specified parameters. You can also apply a range of filtering criteria to narrow the list of orders returned. If NextToken is present, that will be used to retrieve the orders instead of other criteria. **Usage Plans:** | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 0.0055 | 20 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
504
|
+
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
505
|
+
* @param {*} [options] Override http request option.
|
|
506
|
+
* @throws {RequiredError}
|
|
507
|
+
* @memberof OrdersV0Api
|
|
508
|
+
*/
|
|
509
|
+
getOrders(requestParameters, options) {
|
|
510
|
+
return (0, exports.OrdersV0ApiFp)(this.configuration).getOrders(requestParameters.marketplaceIds, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.orderStatuses, requestParameters.fulfillmentChannels, requestParameters.paymentMethods, requestParameters.buyerEmail, requestParameters.sellerOrderId, requestParameters.maxResultsPerPage, requestParameters.easyShipShipmentStatuses, requestParameters.nextToken, requestParameters.amazonOrderIds, requestParameters.actualFulfillmentSupplySourceId, requestParameters.isISPU, requestParameters.storeChainStoreId, options).then((request) => request(this.axios, this.basePath));
|
|
511
|
+
}
|
|
512
|
+
}
|
|
513
|
+
exports.OrdersV0Api = OrdersV0Api;
|