@sp-api-sdk/orders-api-v0 2.0.1 → 2.1.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/dist/cjs/src/api-model/api/orders-v0-api.js +63 -0
- package/dist/cjs/src/api-model/models/business-hours.js +25 -0
- package/dist/cjs/src/api-model/models/confirm-shipment-error-response.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-shipment-order-item.js +15 -0
- package/dist/cjs/src/api-model/models/confirm-shipment-request.js +19 -0
- package/dist/cjs/src/api-model/models/delivery-preferences.js +15 -0
- package/dist/cjs/src/api-model/models/exception-dates.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +11 -0
- package/dist/cjs/src/api-model/models/open-interval.js +15 -0
- package/dist/cjs/src/api-model/models/open-time-interval.js +15 -0
- package/dist/cjs/src/api-model/models/other-delivery-attributes.js +26 -0
- package/dist/cjs/src/api-model/models/package-detail.js +15 -0
- package/dist/cjs/src/api-model/models/preferred-delivery-time.js +15 -0
- package/dist/cjs/src/client.js +7 -0
- package/dist/es/src/api-model/api/orders-v0-api.js +63 -0
- package/dist/es/src/api-model/models/business-hours.js +22 -0
- package/dist/es/src/api-model/models/confirm-shipment-error-response.js +14 -0
- package/dist/es/src/api-model/models/confirm-shipment-order-item.js +14 -0
- package/dist/es/src/api-model/models/confirm-shipment-request.js +16 -0
- package/dist/es/src/api-model/models/delivery-preferences.js +14 -0
- package/dist/es/src/api-model/models/exception-dates.js +14 -0
- package/dist/es/src/api-model/models/index.js +11 -0
- package/dist/es/src/api-model/models/open-interval.js +14 -0
- package/dist/es/src/api-model/models/open-time-interval.js +14 -0
- package/dist/es/src/api-model/models/other-delivery-attributes.js +23 -0
- package/dist/es/src/api-model/models/package-detail.js +14 -0
- package/dist/es/src/api-model/models/preferred-delivery-time.js +14 -0
- package/dist/es/src/client.js +7 -0
- package/dist/types/src/api-model/api/orders-v0-api.d.ts +51 -0
- package/dist/types/src/api-model/models/business-hours.d.ts +41 -0
- package/dist/types/src/api-model/models/confirm-shipment-error-response.d.ts +24 -0
- package/dist/types/src/api-model/models/confirm-shipment-order-item.d.ts +36 -0
- package/dist/types/src/api-model/models/confirm-shipment-request.d.ts +41 -0
- package/dist/types/src/api-model/models/delivery-preferences.d.ts +44 -0
- package/dist/types/src/api-model/models/exception-dates.d.ts +37 -0
- package/dist/types/src/api-model/models/index.d.ts +11 -0
- package/dist/types/src/api-model/models/open-interval.d.ts +31 -0
- package/dist/types/src/api-model/models/open-time-interval.d.ts +30 -0
- package/dist/types/src/api-model/models/order-address.d.ts +13 -0
- package/dist/types/src/api-model/models/other-delivery-attributes.d.ts +22 -0
- package/dist/types/src/api-model/models/package-detail.d.ts +67 -0
- package/dist/types/src/api-model/models/preferred-delivery-time.d.ts +32 -0
- package/package.json +3 -3
|
@@ -0,0 +1,23 @@
|
|
|
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
|
+
* Miscellaneous delivery attributes associated with the shipping address.
|
|
16
|
+
* @export
|
|
17
|
+
* @enum {string}
|
|
18
|
+
*/
|
|
19
|
+
export const OtherDeliveryAttributes = {
|
|
20
|
+
HasAccessPoint: 'HAS_ACCESS_POINT',
|
|
21
|
+
PalletEnabled: 'PALLET_ENABLED',
|
|
22
|
+
PalletDisabled: 'PALLET_DISABLED'
|
|
23
|
+
};
|
|
@@ -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 {};
|
package/dist/es/src/client.js
CHANGED
|
@@ -78,6 +78,13 @@ export const clientRateLimits = [
|
|
|
78
78
|
rate: 5,
|
|
79
79
|
burst: 15,
|
|
80
80
|
},
|
|
81
|
+
{
|
|
82
|
+
method: 'post',
|
|
83
|
+
// eslint-disable-next-line prefer-regex-literals
|
|
84
|
+
urlRegex: new RegExp('^/orders/v0/orders/[^/]*/shipmentConfirmation$'),
|
|
85
|
+
rate: 2,
|
|
86
|
+
burst: 10,
|
|
87
|
+
},
|
|
81
88
|
];
|
|
82
89
|
export class OrdersApiClient extends OrdersV0Api {
|
|
83
90
|
constructor(configuration) {
|
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { ConfirmShipmentRequest } from '../models';
|
|
15
16
|
import { GetOrderAddressResponse } from '../models';
|
|
16
17
|
import { GetOrderApprovalsResponse } from '../models';
|
|
17
18
|
import { GetOrderBuyerInfoResponse } from '../models';
|
|
@@ -30,6 +31,14 @@ import { UpdateVerificationStatusRequest } from '../models';
|
|
|
30
31
|
* @export
|
|
31
32
|
*/
|
|
32
33
|
export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34
|
+
/**
|
|
35
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
36
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
37
|
+
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
38
|
+
* @param {*} [options] Override http request option.
|
|
39
|
+
* @throws {RequiredError}
|
|
40
|
+
*/
|
|
41
|
+
confirmShipment: (orderId: string, payload: ConfirmShipmentRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
42
|
/**
|
|
34
43
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
35
44
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -140,6 +149,14 @@ export declare const OrdersV0ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
140
149
|
* @export
|
|
141
150
|
*/
|
|
142
151
|
export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
152
|
+
/**
|
|
153
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
154
|
+
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
155
|
+
* @param {ConfirmShipmentRequest} payload Request body of confirmShipment.
|
|
156
|
+
* @param {*} [options] Override http request option.
|
|
157
|
+
* @throws {RequiredError}
|
|
158
|
+
*/
|
|
159
|
+
confirmShipment(orderId: string, payload: ConfirmShipmentRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
143
160
|
/**
|
|
144
161
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
145
162
|
* @param {string} orderId An Amazon-defined order identifier, in 3-7-7 format.
|
|
@@ -250,6 +267,13 @@ export declare const OrdersV0ApiFp: (configuration?: Configuration) => {
|
|
|
250
267
|
* @export
|
|
251
268
|
*/
|
|
252
269
|
export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
270
|
+
/**
|
|
271
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
272
|
+
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
273
|
+
* @param {*} [options] Override http request option.
|
|
274
|
+
* @throws {RequiredError}
|
|
275
|
+
*/
|
|
276
|
+
confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
253
277
|
/**
|
|
254
278
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
255
279
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
@@ -328,6 +352,25 @@ export declare const OrdersV0ApiFactory: (configuration?: Configuration, basePat
|
|
|
328
352
|
*/
|
|
329
353
|
updateVerificationStatus(requestParameters: OrdersV0ApiUpdateVerificationStatusRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
330
354
|
};
|
|
355
|
+
/**
|
|
356
|
+
* Request parameters for confirmShipment operation in OrdersV0Api.
|
|
357
|
+
* @export
|
|
358
|
+
* @interface OrdersV0ApiConfirmShipmentRequest
|
|
359
|
+
*/
|
|
360
|
+
export interface OrdersV0ApiConfirmShipmentRequest {
|
|
361
|
+
/**
|
|
362
|
+
* An Amazon-defined order identifier, in 3-7-7 format.
|
|
363
|
+
* @type {string}
|
|
364
|
+
* @memberof OrdersV0ApiConfirmShipment
|
|
365
|
+
*/
|
|
366
|
+
readonly orderId: string;
|
|
367
|
+
/**
|
|
368
|
+
* Request body of confirmShipment.
|
|
369
|
+
* @type {ConfirmShipmentRequest}
|
|
370
|
+
* @memberof OrdersV0ApiConfirmShipment
|
|
371
|
+
*/
|
|
372
|
+
readonly payload: ConfirmShipmentRequest;
|
|
373
|
+
}
|
|
331
374
|
/**
|
|
332
375
|
* Request parameters for getOrder operation in OrdersV0Api.
|
|
333
376
|
* @export
|
|
@@ -640,6 +683,14 @@ export interface OrdersV0ApiUpdateVerificationStatusRequest {
|
|
|
640
683
|
* @extends {BaseAPI}
|
|
641
684
|
*/
|
|
642
685
|
export declare class OrdersV0Api extends BaseAPI {
|
|
686
|
+
/**
|
|
687
|
+
* Updates the shipment confirmation status for a specified order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
688
|
+
* @param {OrdersV0ApiConfirmShipmentRequest} requestParameters Request parameters.
|
|
689
|
+
* @param {*} [options] Override http request option.
|
|
690
|
+
* @throws {RequiredError}
|
|
691
|
+
* @memberof OrdersV0Api
|
|
692
|
+
*/
|
|
693
|
+
confirmShipment(requestParameters: OrdersV0ApiConfirmShipmentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
643
694
|
/**
|
|
644
695
|
* Returns the order that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 0.0167 | 20 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values then those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
645
696
|
* @param {OrdersV0ApiGetOrderRequest} requestParameters Request parameters.
|
|
@@ -0,0 +1,41 @@
|
|
|
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 { OpenInterval } from './open-interval';
|
|
13
|
+
/**
|
|
14
|
+
* Business days and hours when the destination is open for deliveries.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface BusinessHours
|
|
17
|
+
*/
|
|
18
|
+
export interface BusinessHours {
|
|
19
|
+
/**
|
|
20
|
+
* Day of the week.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof BusinessHours
|
|
23
|
+
*/
|
|
24
|
+
'DayOfWeek'?: BusinessHoursDayOfWeekEnum;
|
|
25
|
+
/**
|
|
26
|
+
* Time window during the day when the business is open.
|
|
27
|
+
* @type {Array<OpenInterval>}
|
|
28
|
+
* @memberof BusinessHours
|
|
29
|
+
*/
|
|
30
|
+
'OpenIntervals'?: Array<OpenInterval>;
|
|
31
|
+
}
|
|
32
|
+
export declare const BusinessHoursDayOfWeekEnum: {
|
|
33
|
+
readonly Sun: "SUN";
|
|
34
|
+
readonly Mon: "MON";
|
|
35
|
+
readonly Tue: "TUE";
|
|
36
|
+
readonly Wed: "WED";
|
|
37
|
+
readonly Thu: "THU";
|
|
38
|
+
readonly Fri: "FRI";
|
|
39
|
+
readonly Sat: "SAT";
|
|
40
|
+
};
|
|
41
|
+
export type BusinessHoursDayOfWeekEnum = typeof BusinessHoursDayOfWeekEnum[keyof typeof BusinessHoursDayOfWeekEnum];
|
|
@@ -0,0 +1,24 @@
|
|
|
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
|
+
* The error response schema for an shipment confirmation.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ConfirmShipmentErrorResponse
|
|
16
|
+
*/
|
|
17
|
+
export interface ConfirmShipmentErrorResponse {
|
|
18
|
+
/**
|
|
19
|
+
* A list of error responses returned when a request is unsuccessful.
|
|
20
|
+
* @type {Array<Error>}
|
|
21
|
+
* @memberof ConfirmShipmentErrorResponse
|
|
22
|
+
*/
|
|
23
|
+
'errors'?: Array<Error>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
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
|
+
* A single order item.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ConfirmShipmentOrderItem
|
|
16
|
+
*/
|
|
17
|
+
export interface ConfirmShipmentOrderItem {
|
|
18
|
+
/**
|
|
19
|
+
* The unique identifier of the order item.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof ConfirmShipmentOrderItem
|
|
22
|
+
*/
|
|
23
|
+
'orderItemId': string;
|
|
24
|
+
/**
|
|
25
|
+
* The quantity of the item.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof ConfirmShipmentOrderItem
|
|
28
|
+
*/
|
|
29
|
+
'quantity': number;
|
|
30
|
+
/**
|
|
31
|
+
* A list of order items.
|
|
32
|
+
* @type {Array<string>}
|
|
33
|
+
* @memberof ConfirmShipmentOrderItem
|
|
34
|
+
*/
|
|
35
|
+
'transparencyCodes'?: Array<string>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
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 { PackageDetail } from './package-detail';
|
|
13
|
+
/**
|
|
14
|
+
* The request schema for an shipment confirmation.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ConfirmShipmentRequest
|
|
17
|
+
*/
|
|
18
|
+
export interface ConfirmShipmentRequest {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {PackageDetail}
|
|
22
|
+
* @memberof ConfirmShipmentRequest
|
|
23
|
+
*/
|
|
24
|
+
'packageDetail': PackageDetail;
|
|
25
|
+
/**
|
|
26
|
+
* The cod collection method, support in JP only.
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof ConfirmShipmentRequest
|
|
29
|
+
*/
|
|
30
|
+
'codCollectionMethod'?: ConfirmShipmentRequestCodCollectionMethodEnum;
|
|
31
|
+
/**
|
|
32
|
+
* The unobfuscated marketplace identifier.
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof ConfirmShipmentRequest
|
|
35
|
+
*/
|
|
36
|
+
'marketplaceId': string;
|
|
37
|
+
}
|
|
38
|
+
export declare const ConfirmShipmentRequestCodCollectionMethodEnum: {
|
|
39
|
+
readonly DirectPayment: "DirectPayment";
|
|
40
|
+
};
|
|
41
|
+
export type ConfirmShipmentRequestCodCollectionMethodEnum = typeof ConfirmShipmentRequestCodCollectionMethodEnum[keyof typeof ConfirmShipmentRequestCodCollectionMethodEnum];
|
|
@@ -0,0 +1,44 @@
|
|
|
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 { OtherDeliveryAttributes } from './other-delivery-attributes';
|
|
13
|
+
import { PreferredDeliveryTime } from './preferred-delivery-time';
|
|
14
|
+
/**
|
|
15
|
+
* Contains all of the delivery instructions provided by the customer for the shipping address.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface DeliveryPreferences
|
|
18
|
+
*/
|
|
19
|
+
export interface DeliveryPreferences {
|
|
20
|
+
/**
|
|
21
|
+
* Drop-off location selected by the customer.
|
|
22
|
+
* @type {string}
|
|
23
|
+
* @memberof DeliveryPreferences
|
|
24
|
+
*/
|
|
25
|
+
'DropOffLocation'?: string;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {PreferredDeliveryTime}
|
|
29
|
+
* @memberof DeliveryPreferences
|
|
30
|
+
*/
|
|
31
|
+
'PreferredDeliveryTime'?: PreferredDeliveryTime;
|
|
32
|
+
/**
|
|
33
|
+
* Enumerated list of miscellaneous delivery attributes associated with the shipping address.
|
|
34
|
+
* @type {Array<OtherDeliveryAttributes>}
|
|
35
|
+
* @memberof DeliveryPreferences
|
|
36
|
+
*/
|
|
37
|
+
'OtherAttributes'?: Array<OtherDeliveryAttributes>;
|
|
38
|
+
/**
|
|
39
|
+
* Building instructions, nearby landmark or navigation instructions.
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof DeliveryPreferences
|
|
42
|
+
*/
|
|
43
|
+
'AddressInstructions'?: string;
|
|
44
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
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 { OpenInterval } from './open-interval';
|
|
13
|
+
/**
|
|
14
|
+
* Dates when the business is closed or open with a different time window.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ExceptionDates
|
|
17
|
+
*/
|
|
18
|
+
export interface ExceptionDates {
|
|
19
|
+
/**
|
|
20
|
+
* Date when the business is closed, in ISO-8601 date format.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof ExceptionDates
|
|
23
|
+
*/
|
|
24
|
+
'ExceptionDate'?: string;
|
|
25
|
+
/**
|
|
26
|
+
* Boolean indicating if the business is closed or open on that date.
|
|
27
|
+
* @type {boolean}
|
|
28
|
+
* @memberof ExceptionDates
|
|
29
|
+
*/
|
|
30
|
+
'IsOpen'?: boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Time window during the day when the business is open.
|
|
33
|
+
* @type {Array<OpenInterval>}
|
|
34
|
+
* @memberof ExceptionDates
|
|
35
|
+
*/
|
|
36
|
+
'OpenIntervals'?: Array<OpenInterval>;
|
|
37
|
+
}
|
|
@@ -1,13 +1,19 @@
|
|
|
1
1
|
export * from './address';
|
|
2
2
|
export * from './approval-support-data-element';
|
|
3
3
|
export * from './automated-shipping-settings';
|
|
4
|
+
export * from './business-hours';
|
|
4
5
|
export * from './buyer-customized-info-detail';
|
|
5
6
|
export * from './buyer-info';
|
|
6
7
|
export * from './buyer-requested-cancel';
|
|
7
8
|
export * from './buyer-tax-info';
|
|
8
9
|
export * from './buyer-tax-information';
|
|
10
|
+
export * from './confirm-shipment-error-response';
|
|
11
|
+
export * from './confirm-shipment-order-item';
|
|
12
|
+
export * from './confirm-shipment-request';
|
|
13
|
+
export * from './delivery-preferences';
|
|
9
14
|
export * from './easy-ship-shipment-status';
|
|
10
15
|
export * from './electronic-invoice-status';
|
|
16
|
+
export * from './exception-dates';
|
|
11
17
|
export * from './fulfillment-instruction';
|
|
12
18
|
export * from './get-order-address-response';
|
|
13
19
|
export * from './get-order-approvals-response';
|
|
@@ -28,6 +34,8 @@ export * from './item-identifier';
|
|
|
28
34
|
export * from './marketplace-tax-info';
|
|
29
35
|
export * from './model-error';
|
|
30
36
|
export * from './money';
|
|
37
|
+
export * from './open-interval';
|
|
38
|
+
export * from './open-time-interval';
|
|
31
39
|
export * from './order';
|
|
32
40
|
export * from './order-address';
|
|
33
41
|
export * from './order-approvals-response';
|
|
@@ -41,8 +49,11 @@ export * from './order-items-inner';
|
|
|
41
49
|
export * from './order-items-list';
|
|
42
50
|
export * from './order-regulated-info';
|
|
43
51
|
export * from './orders-list';
|
|
52
|
+
export * from './other-delivery-attributes';
|
|
53
|
+
export * from './package-detail';
|
|
44
54
|
export * from './payment-execution-detail-item';
|
|
45
55
|
export * from './points-granted-detail';
|
|
56
|
+
export * from './preferred-delivery-time';
|
|
46
57
|
export * from './product-info-detail';
|
|
47
58
|
export * from './regulated-information';
|
|
48
59
|
export * from './regulated-information-field';
|
|
@@ -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 { OpenTimeInterval } from './open-time-interval';
|
|
13
|
+
/**
|
|
14
|
+
* The time interval for which the business is open.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface OpenInterval
|
|
17
|
+
*/
|
|
18
|
+
export interface OpenInterval {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {OpenTimeInterval}
|
|
22
|
+
* @memberof OpenInterval
|
|
23
|
+
*/
|
|
24
|
+
'StartTime'?: OpenTimeInterval;
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
* @type {OpenTimeInterval}
|
|
28
|
+
* @memberof OpenInterval
|
|
29
|
+
*/
|
|
30
|
+
'EndTime'?: OpenTimeInterval;
|
|
31
|
+
}
|
|
@@ -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
|
+
* The time when the business opens or closes.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface OpenTimeInterval
|
|
16
|
+
*/
|
|
17
|
+
export interface OpenTimeInterval {
|
|
18
|
+
/**
|
|
19
|
+
* The hour when the business opens or closes.
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof OpenTimeInterval
|
|
22
|
+
*/
|
|
23
|
+
'Hour'?: number;
|
|
24
|
+
/**
|
|
25
|
+
* The minute when the business opens or closes.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof OpenTimeInterval
|
|
28
|
+
*/
|
|
29
|
+
'Minute'?: number;
|
|
30
|
+
}
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import { Address } from './address';
|
|
13
|
+
import { DeliveryPreferences } from './delivery-preferences';
|
|
13
14
|
/**
|
|
14
15
|
* The shipping address for the order.
|
|
15
16
|
* @export
|
|
@@ -22,10 +23,22 @@ export interface OrderAddress {
|
|
|
22
23
|
* @memberof OrderAddress
|
|
23
24
|
*/
|
|
24
25
|
'AmazonOrderId': string;
|
|
26
|
+
/**
|
|
27
|
+
* Company name of the destination address.
|
|
28
|
+
* @type {string}
|
|
29
|
+
* @memberof OrderAddress
|
|
30
|
+
*/
|
|
31
|
+
'BuyerCompanyName'?: string;
|
|
25
32
|
/**
|
|
26
33
|
*
|
|
27
34
|
* @type {Address}
|
|
28
35
|
* @memberof OrderAddress
|
|
29
36
|
*/
|
|
30
37
|
'ShippingAddress'?: Address;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {DeliveryPreferences}
|
|
41
|
+
* @memberof OrderAddress
|
|
42
|
+
*/
|
|
43
|
+
'DeliveryPreferences'?: DeliveryPreferences;
|
|
31
44
|
}
|
|
@@ -0,0 +1,22 @@
|
|
|
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
|
+
* Miscellaneous delivery attributes associated with the shipping address.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const OtherDeliveryAttributes: {
|
|
18
|
+
readonly HasAccessPoint: "HAS_ACCESS_POINT";
|
|
19
|
+
readonly PalletEnabled: "PALLET_ENABLED";
|
|
20
|
+
readonly PalletDisabled: "PALLET_DISABLED";
|
|
21
|
+
};
|
|
22
|
+
export type OtherDeliveryAttributes = typeof OtherDeliveryAttributes[keyof typeof OtherDeliveryAttributes];
|
|
@@ -0,0 +1,67 @@
|
|
|
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 { ConfirmShipmentOrderItem } from './confirm-shipment-order-item';
|
|
13
|
+
/**
|
|
14
|
+
* Properties of packages
|
|
15
|
+
* @export
|
|
16
|
+
* @interface PackageDetail
|
|
17
|
+
*/
|
|
18
|
+
export interface PackageDetail {
|
|
19
|
+
/**
|
|
20
|
+
* A seller-supplied identifier that uniquely identifies a package within the scope of an order. Only positive numeric values are supported.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof PackageDetail
|
|
23
|
+
*/
|
|
24
|
+
'packageReferenceId': string;
|
|
25
|
+
/**
|
|
26
|
+
* Identifies the carrier that will deliver the package. This field is required for all marketplaces, see [reference](https://developer-docs.amazon.com/sp-api/changelog/carriercode-value-required-in-shipment-confirmations-for-br-mx-ca-sg-au-in-jp-marketplaces).
|
|
27
|
+
* @type {string}
|
|
28
|
+
* @memberof PackageDetail
|
|
29
|
+
*/
|
|
30
|
+
'carrierCode': string;
|
|
31
|
+
/**
|
|
32
|
+
* Carrier Name that will deliver the package. Required when carrierCode is \"Others\"
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof PackageDetail
|
|
35
|
+
*/
|
|
36
|
+
'carrierName'?: string;
|
|
37
|
+
/**
|
|
38
|
+
* Ship method to be used for shipping the order.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof PackageDetail
|
|
41
|
+
*/
|
|
42
|
+
'shippingMethod'?: string;
|
|
43
|
+
/**
|
|
44
|
+
* The tracking number used to obtain tracking and delivery information.
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof PackageDetail
|
|
47
|
+
*/
|
|
48
|
+
'trackingNumber': string;
|
|
49
|
+
/**
|
|
50
|
+
* The shipping date for the package. Must be in ISO-8601 date/time format.
|
|
51
|
+
* @type {string}
|
|
52
|
+
* @memberof PackageDetail
|
|
53
|
+
*/
|
|
54
|
+
'shipDate': string;
|
|
55
|
+
/**
|
|
56
|
+
* The unique identifier of the supply source.
|
|
57
|
+
* @type {string}
|
|
58
|
+
* @memberof PackageDetail
|
|
59
|
+
*/
|
|
60
|
+
'shipFromSupplySourceId'?: string;
|
|
61
|
+
/**
|
|
62
|
+
* A list of order items.
|
|
63
|
+
* @type {Array<ConfirmShipmentOrderItem>}
|
|
64
|
+
* @memberof PackageDetail
|
|
65
|
+
*/
|
|
66
|
+
'orderItems': Array<ConfirmShipmentOrderItem>;
|
|
67
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
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 { BusinessHours } from './business-hours';
|
|
13
|
+
import { ExceptionDates } from './exception-dates';
|
|
14
|
+
/**
|
|
15
|
+
* The time window when the delivery is preferred.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface PreferredDeliveryTime
|
|
18
|
+
*/
|
|
19
|
+
export interface PreferredDeliveryTime {
|
|
20
|
+
/**
|
|
21
|
+
* Business hours when the business is open for deliveries.
|
|
22
|
+
* @type {Array<BusinessHours>}
|
|
23
|
+
* @memberof PreferredDeliveryTime
|
|
24
|
+
*/
|
|
25
|
+
'BusinessHours'?: Array<BusinessHours>;
|
|
26
|
+
/**
|
|
27
|
+
* Dates when the business is closed in the next 30 days.
|
|
28
|
+
* @type {Array<ExceptionDates>}
|
|
29
|
+
* @memberof PreferredDeliveryTime
|
|
30
|
+
*/
|
|
31
|
+
'ExceptionDates'?: Array<ExceptionDates>;
|
|
32
|
+
}
|