@sp-api-sdk/orders-api-v0 1.9.2 → 1.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/index.js +3 -3
- package/dist/cjs/src/api-model/api/orders-v0-api.js +140 -19
- package/dist/cjs/src/api-model/api.js +1 -1
- package/dist/cjs/src/api-model/base.js +1 -1
- package/dist/cjs/src/api-model/index.js +3 -3
- package/dist/cjs/src/api-model/models/buyer-requested-cancel.js +15 -0
- package/dist/cjs/src/api-model/models/get-order-regulated-info-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +43 -33
- package/dist/cjs/src/api-model/models/order-regulated-info.js +15 -0
- package/dist/cjs/src/api-model/models/regulated-information-field.js +25 -0
- package/dist/cjs/src/api-model/models/regulated-information.js +15 -0
- package/dist/cjs/src/api-model/models/regulated-order-verification-status.js +28 -0
- package/dist/cjs/src/api-model/models/rejection-reason.js +15 -0
- package/dist/cjs/src/api-model/models/update-verification-status-error-response.js +15 -0
- package/dist/cjs/src/api-model/models/update-verification-status-request-body.js +25 -0
- package/dist/cjs/src/api-model/models/update-verification-status-request.js +15 -0
- package/dist/cjs/src/client.js +12 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +139 -18
- package/dist/es/src/api-model/models/buyer-requested-cancel.js +14 -0
- package/dist/es/src/api-model/models/get-order-regulated-info-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +10 -0
- package/dist/es/src/api-model/models/order-regulated-info.js +14 -0
- package/dist/es/src/api-model/models/regulated-information-field.js +22 -0
- package/dist/es/src/api-model/models/regulated-information.js +14 -0
- package/dist/es/src/api-model/models/regulated-order-verification-status.js +25 -0
- package/dist/es/src/api-model/models/rejection-reason.js +14 -0
- package/dist/es/src/api-model/models/update-verification-status-error-response.js +14 -0
- package/dist/es/src/api-model/models/update-verification-status-request-body.js +22 -0
- package/dist/es/src/api-model/models/update-verification-status-request.js +14 -0
- package/dist/es/src/client.js +12 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +115 -20
- package/dist/types/src/api-model/models/buyer-requested-cancel.d.ts +30 -0
- package/dist/types/src/api-model/models/buyer-tax-information.d.ts +1 -1
- package/dist/types/src/api-model/models/get-order-regulated-info-response.d.ts +31 -0
- package/dist/types/src/api-model/models/index.d.ts +10 -0
- package/dist/types/src/api-model/models/order-item.d.ts +7 -0
- package/dist/types/src/api-model/models/order-regulated-info.d.ts +44 -0
- package/dist/types/src/api-model/models/order.d.ts +13 -1
- package/dist/types/src/api-model/models/regulated-information-field.d.ts +50 -0
- package/dist/types/src/api-model/models/regulated-information.d.ts +25 -0
- package/dist/types/src/api-model/models/regulated-order-verification-status.d.ts +66 -0
- package/dist/types/src/api-model/models/rejection-reason.d.ts +30 -0
- package/dist/types/src/api-model/models/update-verification-status-error-response.d.ts +24 -0
- package/dist/types/src/api-model/models/update-verification-status-request-body.d.ts +44 -0
- package/dist/types/src/api-model/models/update-verification-status-request.d.ts +25 -0
- package/package.json +5 -5
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
* @enum {string}
|
|
17
|
+
*/
|
|
18
|
+
export var RegulatedOrderVerificationStatusStatusEnum;
|
|
19
|
+
(function (RegulatedOrderVerificationStatusStatusEnum) {
|
|
20
|
+
RegulatedOrderVerificationStatusStatusEnum["Pending"] = "Pending";
|
|
21
|
+
RegulatedOrderVerificationStatusStatusEnum["Approved"] = "Approved";
|
|
22
|
+
RegulatedOrderVerificationStatusStatusEnum["Rejected"] = "Rejected";
|
|
23
|
+
RegulatedOrderVerificationStatusStatusEnum["Expired"] = "Expired";
|
|
24
|
+
RegulatedOrderVerificationStatusStatusEnum["Cancelled"] = "Cancelled";
|
|
25
|
+
})(RegulatedOrderVerificationStatusStatusEnum || (RegulatedOrderVerificationStatusStatusEnum = {}));
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @export
|
|
16
|
+
* @enum {string}
|
|
17
|
+
*/
|
|
18
|
+
export var UpdateVerificationStatusRequestBodyStatusEnum;
|
|
19
|
+
(function (UpdateVerificationStatusRequestBodyStatusEnum) {
|
|
20
|
+
UpdateVerificationStatusRequestBodyStatusEnum["Approved"] = "Approved";
|
|
21
|
+
UpdateVerificationStatusRequestBodyStatusEnum["Rejected"] = "Rejected";
|
|
22
|
+
})(UpdateVerificationStatusRequestBodyStatusEnum || (UpdateVerificationStatusRequestBodyStatusEnum = {}));
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Selling Partner API for Orders
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: v0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
package/dist/es/src/client.js
CHANGED
|
@@ -39,6 +39,18 @@ export const clientRateLimits = [
|
|
|
39
39
|
rate: 0.0055,
|
|
40
40
|
burst: 20,
|
|
41
41
|
},
|
|
42
|
+
{
|
|
43
|
+
method: 'get',
|
|
44
|
+
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/regulatedInfo$'),
|
|
45
|
+
rate: 0.0055,
|
|
46
|
+
burst: 20,
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
method: 'patch',
|
|
50
|
+
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/regulatedInfo$'),
|
|
51
|
+
rate: 0.0055,
|
|
52
|
+
burst: 20,
|
|
53
|
+
},
|
|
42
54
|
];
|
|
43
55
|
export class OrdersApiClient extends OrdersV0Api {
|
|
44
56
|
constructor(parameters) {
|
|
@@ -16,9 +16,11 @@ import { GetOrderAddressResponse } from '../models';
|
|
|
16
16
|
import { GetOrderBuyerInfoResponse } from '../models';
|
|
17
17
|
import { GetOrderItemsBuyerInfoResponse } from '../models';
|
|
18
18
|
import { GetOrderItemsResponse } from '../models';
|
|
19
|
+
import { GetOrderRegulatedInfoResponse } from '../models';
|
|
19
20
|
import { GetOrderResponse } from '../models';
|
|
20
21
|
import { GetOrdersResponse } from '../models';
|
|
21
22
|
import { UpdateShipmentStatusRequest } from '../models';
|
|
23
|
+
import { UpdateVerificationStatusRequest } from '../models';
|
|
22
24
|
/**
|
|
23
25
|
* OrdersV0Api - axios parameter creator
|
|
24
26
|
* @export
|
|
@@ -32,14 +34,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32
34
|
*/
|
|
33
35
|
getOrder: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
34
36
|
/**
|
|
35
|
-
* Returns the shipping address for the specified order. **
|
|
37
|
+
* Returns the shipping address for the specified 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.
|
|
36
38
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
37
39
|
* @param {*} [options] Override http request option.
|
|
38
40
|
* @throws {RequiredError}
|
|
39
41
|
*/
|
|
40
42
|
getOrderAddress: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
41
43
|
/**
|
|
42
|
-
* Returns buyer information for the specified order. **
|
|
44
|
+
* Returns buyer information for the specified 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.
|
|
43
45
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
44
46
|
* @param {*} [options] Override http request option.
|
|
45
47
|
* @throws {RequiredError}
|
|
@@ -54,22 +56,29 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
54
56
|
*/
|
|
55
57
|
getOrderItems: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
56
58
|
/**
|
|
57
|
-
* Returns buyer information for the order items in the specified order. **
|
|
59
|
+
* Returns buyer information for the order items in the specified 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.
|
|
58
60
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
59
61
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
60
62
|
* @param {*} [options] Override http request option.
|
|
61
63
|
* @throws {RequiredError}
|
|
62
64
|
*/
|
|
63
65
|
getOrderItemsBuyerInfo: (orderId: string, nextToken?: string | undefined, options?: any) => Promise<RequestArgs>;
|
|
66
|
+
/**
|
|
67
|
+
* Returns regulated information for 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.
|
|
68
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
69
|
+
* @param {*} [options] Override http request option.
|
|
70
|
+
* @throws {RequiredError}
|
|
71
|
+
*/
|
|
72
|
+
getOrderRegulatedInfo: (orderId: string, options?: any) => Promise<RequestArgs>;
|
|
64
73
|
/**
|
|
65
74
|
* 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.
|
|
66
|
-
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://
|
|
75
|
+
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
67
76
|
* @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.
|
|
68
77
|
* @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.
|
|
69
78
|
* @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.
|
|
70
79
|
* @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.
|
|
71
80
|
* @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.).
|
|
72
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values:
|
|
81
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
73
82
|
* @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).
|
|
74
83
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
75
84
|
* @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.
|
|
@@ -92,6 +101,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
92
101
|
* @throws {RequiredError}
|
|
93
102
|
*/
|
|
94
103
|
updateShipmentStatus: (orderId: string, payload: UpdateShipmentStatusRequest, options?: any) => Promise<RequestArgs>;
|
|
104
|
+
/**
|
|
105
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **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.
|
|
106
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
107
|
+
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
updateVerificationStatus: (orderId: string, payload: UpdateVerificationStatusRequest, options?: any) => Promise<RequestArgs>;
|
|
95
112
|
};
|
|
96
113
|
/**
|
|
97
114
|
* OrdersV0Api - functional programming interface
|
|
@@ -106,14 +123,14 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
106
123
|
*/
|
|
107
124
|
getOrder(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderResponse>>;
|
|
108
125
|
/**
|
|
109
|
-
* Returns the shipping address for the specified order. **
|
|
126
|
+
* Returns the shipping address for the specified 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.
|
|
110
127
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
111
128
|
* @param {*} [options] Override http request option.
|
|
112
129
|
* @throws {RequiredError}
|
|
113
130
|
*/
|
|
114
131
|
getOrderAddress(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderAddressResponse>>;
|
|
115
132
|
/**
|
|
116
|
-
* Returns buyer information for the specified order. **
|
|
133
|
+
* Returns buyer information for the specified 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.
|
|
117
134
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
118
135
|
* @param {*} [options] Override http request option.
|
|
119
136
|
* @throws {RequiredError}
|
|
@@ -128,22 +145,29 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
128
145
|
*/
|
|
129
146
|
getOrderItems(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsResponse>>;
|
|
130
147
|
/**
|
|
131
|
-
* Returns buyer information for the order items in the specified order. **
|
|
148
|
+
* Returns buyer information for the order items in the specified 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.
|
|
132
149
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
133
150
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
134
151
|
* @param {*} [options] Override http request option.
|
|
135
152
|
* @throws {RequiredError}
|
|
136
153
|
*/
|
|
137
154
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderItemsBuyerInfoResponse>>;
|
|
155
|
+
/**
|
|
156
|
+
* Returns regulated information for 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.
|
|
157
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
getOrderRegulatedInfo(orderId: string, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<GetOrderRegulatedInfoResponse>>;
|
|
138
162
|
/**
|
|
139
163
|
* 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.
|
|
140
|
-
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://
|
|
164
|
+
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
141
165
|
* @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.
|
|
142
166
|
* @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.
|
|
143
167
|
* @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.
|
|
144
168
|
* @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.
|
|
145
169
|
* @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.).
|
|
146
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values:
|
|
170
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
147
171
|
* @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).
|
|
148
172
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
149
173
|
* @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.
|
|
@@ -166,6 +190,14 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration | undefined)
|
|
|
166
190
|
* @throws {RequiredError}
|
|
167
191
|
*/
|
|
168
192
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
193
|
+
/**
|
|
194
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **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.
|
|
195
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
196
|
+
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
197
|
+
* @param {*} [options] Override http request option.
|
|
198
|
+
* @throws {RequiredError}
|
|
199
|
+
*/
|
|
200
|
+
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?: any): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<void>>;
|
|
169
201
|
};
|
|
170
202
|
/**
|
|
171
203
|
* OrdersV0Api - factory interface
|
|
@@ -180,14 +212,14 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
180
212
|
*/
|
|
181
213
|
getOrder(orderId: string, options?: any): AxiosPromise<GetOrderResponse>;
|
|
182
214
|
/**
|
|
183
|
-
* Returns the shipping address for the specified order. **
|
|
215
|
+
* Returns the shipping address for the specified 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.
|
|
184
216
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
185
217
|
* @param {*} [options] Override http request option.
|
|
186
218
|
* @throws {RequiredError}
|
|
187
219
|
*/
|
|
188
220
|
getOrderAddress(orderId: string, options?: any): AxiosPromise<GetOrderAddressResponse>;
|
|
189
221
|
/**
|
|
190
|
-
* Returns buyer information for the specified order. **
|
|
222
|
+
* Returns buyer information for the specified 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.
|
|
191
223
|
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
192
224
|
* @param {*} [options] Override http request option.
|
|
193
225
|
* @throws {RequiredError}
|
|
@@ -202,22 +234,29 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
202
234
|
*/
|
|
203
235
|
getOrderItems(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsResponse>;
|
|
204
236
|
/**
|
|
205
|
-
* Returns buyer information for the order items in the specified order. **
|
|
237
|
+
* Returns buyer information for the order items in the specified 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.
|
|
206
238
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
207
239
|
* @param {string} [nextToken] A string token returned in the response of your previous request.
|
|
208
240
|
* @param {*} [options] Override http request option.
|
|
209
241
|
* @throws {RequiredError}
|
|
210
242
|
*/
|
|
211
243
|
getOrderItemsBuyerInfo(orderId: string, nextToken?: string | undefined, options?: any): AxiosPromise<GetOrderItemsBuyerInfoResponse>;
|
|
244
|
+
/**
|
|
245
|
+
* Returns regulated information for 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.
|
|
246
|
+
* @param {string} orderId An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
247
|
+
* @param {*} [options] Override http request option.
|
|
248
|
+
* @throws {RequiredError}
|
|
249
|
+
*/
|
|
250
|
+
getOrderRegulatedInfo(orderId: string, options?: any): AxiosPromise<GetOrderRegulatedInfoResponse>;
|
|
212
251
|
/**
|
|
213
252
|
* 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.
|
|
214
|
-
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://
|
|
253
|
+
* @param {Array<string>} marketplaceIds A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
215
254
|
* @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.
|
|
216
255
|
* @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.
|
|
217
256
|
* @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.
|
|
218
257
|
* @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.
|
|
219
258
|
* @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.).
|
|
220
|
-
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values:
|
|
259
|
+
* @param {Array<string>} [fulfillmentChannels] A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
221
260
|
* @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).
|
|
222
261
|
* @param {string} [buyerEmail] The email address of a buyer. Used to select orders that contain the specified email address.
|
|
223
262
|
* @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.
|
|
@@ -240,6 +279,14 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration | undefi
|
|
|
240
279
|
* @throws {RequiredError}
|
|
241
280
|
*/
|
|
242
281
|
updateShipmentStatus(orderId: string, payload: UpdateShipmentStatusRequest, options?: any): AxiosPromise<void>;
|
|
282
|
+
/**
|
|
283
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **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 orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
285
|
+
* @param {UpdateVerificationStatusRequest} payload Request to update the verification status of an order containing regulated products.
|
|
286
|
+
* @param {*} [options] Override http request option.
|
|
287
|
+
* @throws {RequiredError}
|
|
288
|
+
*/
|
|
289
|
+
updateVerificationStatus(orderId: string, payload: UpdateVerificationStatusRequest, options?: any): AxiosPromise<void>;
|
|
243
290
|
};
|
|
244
291
|
/**
|
|
245
292
|
* Request parameters for getOrder operation in OrdersV0Api.
|
|
@@ -318,6 +365,19 @@ export interface OrdersV0ApiGetOrderItemsBuyerInfoRequest {
|
|
|
318
365
|
*/
|
|
319
366
|
readonly nextToken?: string;
|
|
320
367
|
}
|
|
368
|
+
/**
|
|
369
|
+
* Request parameters for getOrderRegulatedInfo operation in OrdersV0Api.
|
|
370
|
+
* @export
|
|
371
|
+
* @interface OrdersV0ApiGetOrderRegulatedInfoRequest
|
|
372
|
+
*/
|
|
373
|
+
export interface OrdersV0ApiGetOrderRegulatedInfoRequest {
|
|
374
|
+
/**
|
|
375
|
+
* An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
376
|
+
* @type {string}
|
|
377
|
+
* @memberof OrdersV0ApiGetOrderRegulatedInfo
|
|
378
|
+
*/
|
|
379
|
+
readonly orderId: string;
|
|
380
|
+
}
|
|
321
381
|
/**
|
|
322
382
|
* Request parameters for getOrders operation in OrdersV0Api.
|
|
323
383
|
* @export
|
|
@@ -325,7 +385,7 @@ export interface OrdersV0ApiGetOrderItemsBuyerInfoRequest {
|
|
|
325
385
|
*/
|
|
326
386
|
export interface OrdersV0ApiGetOrdersRequest {
|
|
327
387
|
/**
|
|
328
|
-
* A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://
|
|
388
|
+
* A list of MarketplaceId values. Used to select orders that were placed in the specified marketplaces. See the [Selling Partner API Developer Guide](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a complete list of marketplaceId values.
|
|
329
389
|
* @type {Array<string>}
|
|
330
390
|
* @memberof OrdersV0ApiGetOrders
|
|
331
391
|
*/
|
|
@@ -361,7 +421,7 @@ export interface OrdersV0ApiGetOrdersRequest {
|
|
|
361
421
|
*/
|
|
362
422
|
readonly orderStatuses?: Array<string>;
|
|
363
423
|
/**
|
|
364
|
-
* A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values:
|
|
424
|
+
* A list that indicates how an order was fulfilled. Filters the results by fulfillment channel. Possible values: AFN (Fulfillment by Amazon); MFN (Fulfilled by the seller).
|
|
365
425
|
* @type {Array<string>}
|
|
366
426
|
* @memberof OrdersV0ApiGetOrders
|
|
367
427
|
*/
|
|
@@ -446,6 +506,25 @@ export interface OrdersV0ApiUpdateShipmentStatusRequest {
|
|
|
446
506
|
*/
|
|
447
507
|
readonly payload: UpdateShipmentStatusRequest;
|
|
448
508
|
}
|
|
509
|
+
/**
|
|
510
|
+
* Request parameters for updateVerificationStatus operation in OrdersV0Api.
|
|
511
|
+
* @export
|
|
512
|
+
* @interface OrdersV0ApiUpdateVerificationStatusRequest
|
|
513
|
+
*/
|
|
514
|
+
export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
515
|
+
/**
|
|
516
|
+
* An orderId is an Amazon-defined order identifier, in 3-7-7 format.
|
|
517
|
+
* @type {string}
|
|
518
|
+
* @memberof OrdersV0ApiUpdateVerificationStatus
|
|
519
|
+
*/
|
|
520
|
+
readonly orderId: string;
|
|
521
|
+
/**
|
|
522
|
+
* Request to update the verification status of an order containing regulated products.
|
|
523
|
+
* @type {UpdateVerificationStatusRequest}
|
|
524
|
+
* @memberof OrdersV0ApiUpdateVerificationStatus
|
|
525
|
+
*/
|
|
526
|
+
readonly payload: UpdateVerificationStatusRequest;
|
|
527
|
+
}
|
|
449
528
|
/**
|
|
450
529
|
* OrdersV0Api - object-oriented interface
|
|
451
530
|
* @export
|
|
@@ -462,7 +541,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
462
541
|
*/
|
|
463
542
|
getOrder(requestParameters: OrdersV0ApiGetOrderRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
|
|
464
543
|
/**
|
|
465
|
-
* Returns the shipping address for the specified order. **
|
|
544
|
+
* Returns the shipping address for the specified 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.
|
|
466
545
|
* @param {OrdersV0ApiGetOrderAddressRequest} requestParameters Request parameters.
|
|
467
546
|
* @param {*} [options] Override http request option.
|
|
468
547
|
* @throws {RequiredError}
|
|
@@ -470,7 +549,7 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
470
549
|
*/
|
|
471
550
|
getOrderAddress(requestParameters: OrdersV0ApiGetOrderAddressRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderAddressResponse, any>>;
|
|
472
551
|
/**
|
|
473
|
-
* Returns buyer information for the specified order. **
|
|
552
|
+
* Returns buyer information for the specified 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.
|
|
474
553
|
* @param {OrdersV0ApiGetOrderBuyerInfoRequest} requestParameters Request parameters.
|
|
475
554
|
* @param {*} [options] Override http request option.
|
|
476
555
|
* @throws {RequiredError}
|
|
@@ -486,13 +565,21 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
486
565
|
*/
|
|
487
566
|
getOrderItems(requestParameters: OrdersV0ApiGetOrderItemsRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderItemsResponse, any>>;
|
|
488
567
|
/**
|
|
489
|
-
* Returns buyer information for the order items in the specified order. **
|
|
568
|
+
* Returns buyer information for the order items in the specified 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.
|
|
490
569
|
* @param {OrdersV0ApiGetOrderItemsBuyerInfoRequest} requestParameters Request parameters.
|
|
491
570
|
* @param {*} [options] Override http request option.
|
|
492
571
|
* @throws {RequiredError}
|
|
493
572
|
* @memberof OrdersV0Api
|
|
494
573
|
*/
|
|
495
574
|
getOrderItemsBuyerInfo(requestParameters: OrdersV0ApiGetOrderItemsBuyerInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderItemsBuyerInfoResponse, any>>;
|
|
575
|
+
/**
|
|
576
|
+
* Returns regulated information for 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.
|
|
577
|
+
* @param {OrdersV0ApiGetOrderRegulatedInfoRequest} requestParameters Request parameters.
|
|
578
|
+
* @param {*} [options] Override http request option.
|
|
579
|
+
* @throws {RequiredError}
|
|
580
|
+
* @memberof OrdersV0Api
|
|
581
|
+
*/
|
|
582
|
+
getOrderRegulatedInfo(requestParameters: OrdersV0ApiGetOrderRegulatedInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetOrderRegulatedInfoResponse, any>>;
|
|
496
583
|
/**
|
|
497
584
|
* 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.
|
|
498
585
|
* @param {OrdersV0ApiGetOrdersRequest} requestParameters Request parameters.
|
|
@@ -509,4 +596,12 @@ export declare class OrdersV0Api extends BaseAPI {
|
|
|
509
596
|
* @memberof OrdersV0Api
|
|
510
597
|
*/
|
|
511
598
|
updateShipmentStatus(requestParameters: OrdersV0ApiUpdateShipmentStatusRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
599
|
+
/**
|
|
600
|
+
* Updates (approves or rejects) the verification status of an order containing regulated products. **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.
|
|
601
|
+
* @param {OrdersV0ApiUpdateVerificationStatusRequest} requestParameters Request parameters.
|
|
602
|
+
* @param {*} [options] Override http request option.
|
|
603
|
+
* @throws {RequiredError}
|
|
604
|
+
* @memberof OrdersV0Api
|
|
605
|
+
*/
|
|
606
|
+
updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?: any): Promise<import("axios").AxiosResponse<void, any>>;
|
|
512
607
|
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
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
|
+
* The version of the OpenAPI document: v0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* Information about whether or not a buyer requested cancellation.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface BuyerRequestedCancel
|
|
16
|
+
*/
|
|
17
|
+
export interface BuyerRequestedCancel {
|
|
18
|
+
/**
|
|
19
|
+
* When true, the buyer has requested cancellation.
|
|
20
|
+
* @type {boolean}
|
|
21
|
+
* @memberof BuyerRequestedCancel
|
|
22
|
+
*/
|
|
23
|
+
IsBuyerRequestedCancel?: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* Reason for buyer requesting cancel
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof BuyerRequestedCancel
|
|
28
|
+
*/
|
|
29
|
+
BuyerCancelReason?: string;
|
|
30
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Selling Partner API for Orders
|
|
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
|
+
* The version of the OpenAPI document: v0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { OrderRegulatedInfo } from './order-regulated-info';
|
|
13
|
+
/**
|
|
14
|
+
* The response schema for the getOrderRegulatedInfo operation.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GetOrderRegulatedInfoResponse
|
|
17
|
+
*/
|
|
18
|
+
export interface GetOrderRegulatedInfoResponse {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {OrderRegulatedInfo}
|
|
22
|
+
* @memberof GetOrderRegulatedInfoResponse
|
|
23
|
+
*/
|
|
24
|
+
payload?: OrderRegulatedInfo;
|
|
25
|
+
/**
|
|
26
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
27
|
+
* @type {Array<Error>}
|
|
28
|
+
* @memberof GetOrderRegulatedInfoResponse
|
|
29
|
+
*/
|
|
30
|
+
errors?: Array<Error>;
|
|
31
|
+
}
|
|
@@ -2,6 +2,7 @@ export * from './address';
|
|
|
2
2
|
export * from './automated-shipping-settings';
|
|
3
3
|
export * from './buyer-customized-info-detail';
|
|
4
4
|
export * from './buyer-info';
|
|
5
|
+
export * from './buyer-requested-cancel';
|
|
5
6
|
export * from './buyer-tax-info';
|
|
6
7
|
export * from './buyer-tax-information';
|
|
7
8
|
export * from './fulfillment-instruction';
|
|
@@ -9,6 +10,7 @@ export * from './get-order-address-response';
|
|
|
9
10
|
export * from './get-order-buyer-info-response';
|
|
10
11
|
export * from './get-order-items-buyer-info-response';
|
|
11
12
|
export * from './get-order-items-response';
|
|
13
|
+
export * from './get-order-regulated-info-response';
|
|
12
14
|
export * from './get-order-response';
|
|
13
15
|
export * from './get-orders-response';
|
|
14
16
|
export * from './item-buyer-info';
|
|
@@ -22,12 +24,20 @@ export * from './order-item';
|
|
|
22
24
|
export * from './order-item-buyer-info';
|
|
23
25
|
export * from './order-items-buyer-info-list';
|
|
24
26
|
export * from './order-items-list';
|
|
27
|
+
export * from './order-regulated-info';
|
|
25
28
|
export * from './orders-list';
|
|
26
29
|
export * from './payment-execution-detail-item';
|
|
27
30
|
export * from './points-granted-detail';
|
|
28
31
|
export * from './product-info-detail';
|
|
32
|
+
export * from './regulated-information';
|
|
33
|
+
export * from './regulated-information-field';
|
|
34
|
+
export * from './regulated-order-verification-status';
|
|
35
|
+
export * from './rejection-reason';
|
|
29
36
|
export * from './shipment-status';
|
|
30
37
|
export * from './tax-classification';
|
|
31
38
|
export * from './tax-collection';
|
|
32
39
|
export * from './update-shipment-status-error-response';
|
|
33
40
|
export * from './update-shipment-status-request';
|
|
41
|
+
export * from './update-verification-status-error-response';
|
|
42
|
+
export * from './update-verification-status-request';
|
|
43
|
+
export * from './update-verification-status-request-body';
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import { BuyerRequestedCancel } from './buyer-requested-cancel';
|
|
12
13
|
import { ItemBuyerInfo } from './item-buyer-info';
|
|
13
14
|
import { Money } from './money';
|
|
14
15
|
import { PointsGrantedDetail } from './points-granted-detail';
|
|
@@ -218,6 +219,12 @@ export interface OrderItem {
|
|
|
218
219
|
* @memberof OrderItem
|
|
219
220
|
*/
|
|
220
221
|
BuyerInfo?: ItemBuyerInfo;
|
|
222
|
+
/**
|
|
223
|
+
*
|
|
224
|
+
* @type {BuyerRequestedCancel}
|
|
225
|
+
* @memberof OrderItem
|
|
226
|
+
*/
|
|
227
|
+
BuyerRequestedCancel?: BuyerRequestedCancel;
|
|
221
228
|
}
|
|
222
229
|
/**
|
|
223
230
|
* @export
|