@sp-api-sdk/vendor-orders-api-v1 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.js +1 -0
- package/dist/cjs/src/api-model/api/vendor-orders-api.js +40 -40
- package/dist/cjs/src/api-model/models/money.js +7 -0
- package/dist/es/index.js +1 -0
- package/dist/es/src/api-model/api/vendor-orders-api.js +40 -40
- package/dist/es/src/api-model/models/money.js +6 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/src/api-model/api/vendor-orders-api.d.ts +52 -52
- package/dist/types/src/api-model/models/acknowledgement-status-details.d.ts +2 -2
- package/dist/types/src/api-model/models/address.d.ts +1 -1
- package/dist/types/src/api-model/models/get-purchase-order-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-purchase-orders-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-purchase-orders-status-response.d.ts +1 -1
- package/dist/types/src/api-model/models/import-details.d.ts +2 -2
- package/dist/types/src/api-model/models/money.d.ts +14 -1
- package/dist/types/src/api-model/models/order-acknowledgement.d.ts +2 -2
- package/dist/types/src/api-model/models/order-details.d.ts +5 -5
- package/dist/types/src/api-model/models/order-item-acknowledgement.d.ts +3 -3
- package/dist/types/src/api-model/models/order-item-status-receiving-status.d.ts +1 -1
- package/dist/types/src/api-model/models/order-item-status.d.ts +1 -1
- package/dist/types/src/api-model/models/order-item.d.ts +1 -1
- package/dist/types/src/api-model/models/order-list-status.d.ts +2 -2
- package/dist/types/src/api-model/models/order-list.d.ts +2 -2
- package/dist/types/src/api-model/models/order-status.d.ts +2 -2
- package/dist/types/src/api-model/models/order.d.ts +1 -1
- package/dist/types/src/api-model/models/ordered-quantity-details.d.ts +2 -2
- package/dist/types/src/api-model/models/pagination.d.ts +2 -2
- package/dist/types/src/api-model/models/party-identification.d.ts +1 -1
- package/dist/types/src/api-model/models/submit-acknowledgement-request.d.ts +2 -2
- package/dist/types/src/api-model/models/submit-acknowledgement-response.d.ts +1 -1
- package/dist/types/src/api-model/models/tax-registration-details.d.ts +1 -1
- package/dist/types/src/api-model/models/transaction-id.d.ts +1 -1
- package/package.json +4 -4
|
@@ -24,24 +24,24 @@ import type { SubmitAcknowledgementResponse } from '../models';
|
|
|
24
24
|
*/
|
|
25
25
|
export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
|
-
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
27
|
+
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
28
28
|
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
31
31
|
*/
|
|
32
32
|
getPurchaseOrder: (purchaseOrderNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
33
|
/**
|
|
34
|
-
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
34
|
+
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
35
35
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
36
|
-
* @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in
|
|
37
|
-
* @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in
|
|
36
|
+
* @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
37
|
+
* @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
38
38
|
* @param {GetPurchaseOrdersSortOrderEnum} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
39
39
|
* @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call
|
|
40
|
-
* @param {boolean} [includeDetails] When
|
|
41
|
-
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in
|
|
42
|
-
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in
|
|
43
|
-
* @param {GetPurchaseOrdersPoItemStateEnum} [poItemState] Current state of the purchase order item. If this value is
|
|
44
|
-
* @param {boolean} [isPOChanged] When
|
|
40
|
+
* @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
41
|
+
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
42
|
+
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
43
|
+
* @param {GetPurchaseOrdersPoItemStateEnum} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
|
|
44
|
+
* @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
|
|
45
45
|
* @param {GetPurchaseOrdersPurchaseOrderStateEnum} [purchaseOrderState] Filters purchase orders based on the purchase order state.
|
|
46
46
|
* @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
|
|
47
47
|
* @param {*} [options] Override http request option.
|
|
@@ -49,14 +49,14 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
49
49
|
*/
|
|
50
50
|
getPurchaseOrders: (limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: GetPurchaseOrdersSortOrderEnum, nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: GetPurchaseOrdersPoItemStateEnum, isPOChanged?: boolean, purchaseOrderState?: GetPurchaseOrdersPurchaseOrderStateEnum, orderingVendorCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
51
|
/**
|
|
52
|
-
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
52
|
+
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
53
53
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
54
54
|
* @param {GetPurchaseOrdersStatusSortOrderEnum} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
55
55
|
* @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit.
|
|
56
|
-
* @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in
|
|
57
|
-
* @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in
|
|
58
|
-
* @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in
|
|
59
|
-
* @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in
|
|
56
|
+
* @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
57
|
+
* @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
58
|
+
* @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
59
|
+
* @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
60
60
|
* @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number.
|
|
61
61
|
* @param {GetPurchaseOrdersStatusPurchaseOrderStatusEnum} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
|
|
62
62
|
* @param {GetPurchaseOrdersStatusItemConfirmationStatusEnum} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.
|
|
@@ -68,8 +68,8 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
68
68
|
*/
|
|
69
69
|
getPurchaseOrdersStatus: (limit?: number, sortOrder?: GetPurchaseOrdersStatusSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum, itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum, itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum, orderingVendorCode?: string, shipToPartyId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
70
70
|
/**
|
|
71
|
-
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
72
|
-
* @param {SubmitAcknowledgementRequest} body
|
|
71
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
72
|
+
* @param {SubmitAcknowledgementRequest} body
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
@@ -81,24 +81,24 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
|
|
|
81
81
|
*/
|
|
82
82
|
export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
83
83
|
/**
|
|
84
|
-
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
84
|
+
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
85
85
|
* @param {string} purchaseOrderNumber The purchase order identifier for the order that you want. Formatting Notes: 8-character alpha-numeric code.
|
|
86
86
|
* @param {*} [options] Override http request option.
|
|
87
87
|
* @throws {RequiredError}
|
|
88
88
|
*/
|
|
89
89
|
getPurchaseOrder(purchaseOrderNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrderResponse>>;
|
|
90
90
|
/**
|
|
91
|
-
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
91
|
+
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
92
92
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
93
|
-
* @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in
|
|
94
|
-
* @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in
|
|
93
|
+
* @param {string} [createdAfter] Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
94
|
+
* @param {string} [createdBefore] Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
95
95
|
* @param {GetPurchaseOrdersSortOrderEnum} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
96
96
|
* @param {string} [nextToken] Used for pagination when there is more purchase orders than the specified result size limit. The token value is returned in the previous API call
|
|
97
|
-
* @param {boolean} [includeDetails] When
|
|
98
|
-
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in
|
|
99
|
-
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in
|
|
100
|
-
* @param {GetPurchaseOrdersPoItemStateEnum} [poItemState] Current state of the purchase order item. If this value is
|
|
101
|
-
* @param {boolean} [isPOChanged] When
|
|
97
|
+
* @param {boolean} [includeDetails] When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
98
|
+
* @param {string} [changedAfter] Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
99
|
+
* @param {string} [changedBefore] Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
100
|
+
* @param {GetPurchaseOrdersPoItemStateEnum} [poItemState] Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
|
|
101
|
+
* @param {boolean} [isPOChanged] When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
|
|
102
102
|
* @param {GetPurchaseOrdersPurchaseOrderStateEnum} [purchaseOrderState] Filters purchase orders based on the purchase order state.
|
|
103
103
|
* @param {string} [orderingVendorCode] Filters purchase orders based on the specified ordering vendor code. This value should be same as \'sellingParty.partyId\' in the purchase order. If not included in the filter, all purchase orders for all of the vendor codes that exist in the vendor group used to authorize the API client application are returned.
|
|
104
104
|
* @param {*} [options] Override http request option.
|
|
@@ -106,14 +106,14 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
|
106
106
|
*/
|
|
107
107
|
getPurchaseOrders(limit?: number, createdAfter?: string, createdBefore?: string, sortOrder?: GetPurchaseOrdersSortOrderEnum, nextToken?: string, includeDetails?: boolean, changedAfter?: string, changedBefore?: string, poItemState?: GetPurchaseOrdersPoItemStateEnum, isPOChanged?: boolean, purchaseOrderState?: GetPurchaseOrdersPurchaseOrderStateEnum, orderingVendorCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrdersResponse>>;
|
|
108
108
|
/**
|
|
109
|
-
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
109
|
+
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
110
110
|
* @param {number} [limit] The limit to the number of records returned. Default value is 100 records.
|
|
111
111
|
* @param {GetPurchaseOrdersStatusSortOrderEnum} [sortOrder] Sort in ascending or descending order by purchase order creation date.
|
|
112
112
|
* @param {string} [nextToken] Used for pagination when there are more purchase orders than the specified result size limit.
|
|
113
|
-
* @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in
|
|
114
|
-
* @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in
|
|
115
|
-
* @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in
|
|
116
|
-
* @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in
|
|
113
|
+
* @param {string} [createdAfter] Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
114
|
+
* @param {string} [createdBefore] Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
115
|
+
* @param {string} [updatedAfter] Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
116
|
+
* @param {string} [updatedBefore] Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
117
117
|
* @param {string} [purchaseOrderNumber] Provides purchase order status for the specified purchase order number.
|
|
118
118
|
* @param {GetPurchaseOrdersStatusPurchaseOrderStatusEnum} [purchaseOrderStatus] Filters purchase orders based on the specified purchase order status. If not included in filter, this will return purchase orders for all statuses.
|
|
119
119
|
* @param {GetPurchaseOrdersStatusItemConfirmationStatusEnum} [itemConfirmationStatus] Filters purchase orders based on their item confirmation status. If the item confirmation status is not included in the filter, purchase orders for all confirmation statuses are included.
|
|
@@ -125,8 +125,8 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
|
125
125
|
*/
|
|
126
126
|
getPurchaseOrdersStatus(limit?: number, sortOrder?: GetPurchaseOrdersStatusSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, updatedAfter?: string, updatedBefore?: string, purchaseOrderNumber?: string, purchaseOrderStatus?: GetPurchaseOrdersStatusPurchaseOrderStatusEnum, itemConfirmationStatus?: GetPurchaseOrdersStatusItemConfirmationStatusEnum, itemReceiveStatus?: GetPurchaseOrdersStatusItemReceiveStatusEnum, orderingVendorCode?: string, shipToPartyId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPurchaseOrdersStatusResponse>>;
|
|
127
127
|
/**
|
|
128
|
-
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
129
|
-
* @param {SubmitAcknowledgementRequest} body
|
|
128
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
129
|
+
* @param {SubmitAcknowledgementRequest} body
|
|
130
130
|
* @param {*} [options] Override http request option.
|
|
131
131
|
* @throws {RequiredError}
|
|
132
132
|
*/
|
|
@@ -138,28 +138,28 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
|
|
|
138
138
|
*/
|
|
139
139
|
export declare const VendorOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
140
|
/**
|
|
141
|
-
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
141
|
+
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
142
142
|
* @param {VendorOrdersApiGetPurchaseOrderRequest} requestParameters Request parameters.
|
|
143
143
|
* @param {*} [options] Override http request option.
|
|
144
144
|
* @throws {RequiredError}
|
|
145
145
|
*/
|
|
146
146
|
getPurchaseOrder(requestParameters: VendorOrdersApiGetPurchaseOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPurchaseOrderResponse>;
|
|
147
147
|
/**
|
|
148
|
-
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
148
|
+
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
149
149
|
* @param {VendorOrdersApiGetPurchaseOrdersRequest} requestParameters Request parameters.
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
151
151
|
* @throws {RequiredError}
|
|
152
152
|
*/
|
|
153
153
|
getPurchaseOrders(requestParameters?: VendorOrdersApiGetPurchaseOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPurchaseOrdersResponse>;
|
|
154
154
|
/**
|
|
155
|
-
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
155
|
+
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
156
156
|
* @param {VendorOrdersApiGetPurchaseOrdersStatusRequest} requestParameters Request parameters.
|
|
157
157
|
* @param {*} [options] Override http request option.
|
|
158
158
|
* @throws {RequiredError}
|
|
159
159
|
*/
|
|
160
160
|
getPurchaseOrdersStatus(requestParameters?: VendorOrdersApiGetPurchaseOrdersStatusRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPurchaseOrdersStatusResponse>;
|
|
161
161
|
/**
|
|
162
|
-
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
162
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
163
163
|
* @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
|
|
164
164
|
* @param {*} [options] Override http request option.
|
|
165
165
|
* @throws {RequiredError}
|
|
@@ -192,13 +192,13 @@ export interface VendorOrdersApiGetPurchaseOrdersRequest {
|
|
|
192
192
|
*/
|
|
193
193
|
readonly limit?: number;
|
|
194
194
|
/**
|
|
195
|
-
* Purchase orders that became available after this time will be included in the result. Must be in
|
|
195
|
+
* Purchase orders that became available after this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
196
196
|
* @type {string}
|
|
197
197
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
198
198
|
*/
|
|
199
199
|
readonly createdAfter?: string;
|
|
200
200
|
/**
|
|
201
|
-
* Purchase orders that became available before this time will be included in the result. Must be in
|
|
201
|
+
* Purchase orders that became available before this time will be included in the result. Must be in ISO-8601 date/time format.
|
|
202
202
|
* @type {string}
|
|
203
203
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
204
204
|
*/
|
|
@@ -216,31 +216,31 @@ export interface VendorOrdersApiGetPurchaseOrdersRequest {
|
|
|
216
216
|
*/
|
|
217
217
|
readonly nextToken?: string;
|
|
218
218
|
/**
|
|
219
|
-
* When
|
|
219
|
+
* When true, returns purchase orders with complete details. Otherwise, only purchase order numbers are returned. Default value is true.
|
|
220
220
|
* @type {boolean}
|
|
221
221
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
222
222
|
*/
|
|
223
223
|
readonly includeDetails?: boolean;
|
|
224
224
|
/**
|
|
225
|
-
* Purchase orders that changed after this timestamp will be included in the result. Must be in
|
|
225
|
+
* Purchase orders that changed after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
226
226
|
* @type {string}
|
|
227
227
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
228
228
|
*/
|
|
229
229
|
readonly changedAfter?: string;
|
|
230
230
|
/**
|
|
231
|
-
* Purchase orders that changed before this timestamp will be included in the result. Must be in
|
|
231
|
+
* Purchase orders that changed before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
232
232
|
* @type {string}
|
|
233
233
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
234
234
|
*/
|
|
235
235
|
readonly changedBefore?: string;
|
|
236
236
|
/**
|
|
237
|
-
* Current state of the purchase order item. If this value is
|
|
237
|
+
* Current state of the purchase order item. If this value is Cancelled, this API will return purchase orders which have one or more items cancelled by Amazon with updated item quantity as zero.
|
|
238
238
|
* @type {'Cancelled'}
|
|
239
239
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
240
240
|
*/
|
|
241
241
|
readonly poItemState?: GetPurchaseOrdersPoItemStateEnum;
|
|
242
242
|
/**
|
|
243
|
-
* When
|
|
243
|
+
* When true, returns purchase orders which were modified after the order was placed. Vendors are required to pull the changed purchase order and fulfill the updated purchase order and not the original one. Default value is false.
|
|
244
244
|
* @type {boolean}
|
|
245
245
|
* @memberof VendorOrdersApiGetPurchaseOrders
|
|
246
246
|
*/
|
|
@@ -283,25 +283,25 @@ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest {
|
|
|
283
283
|
*/
|
|
284
284
|
readonly nextToken?: string;
|
|
285
285
|
/**
|
|
286
|
-
* Purchase orders that became available after this timestamp will be included in the result. Must be in
|
|
286
|
+
* Purchase orders that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
287
287
|
* @type {string}
|
|
288
288
|
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
289
289
|
*/
|
|
290
290
|
readonly createdAfter?: string;
|
|
291
291
|
/**
|
|
292
|
-
* Purchase orders that became available before this timestamp will be included in the result. Must be in
|
|
292
|
+
* Purchase orders that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
293
293
|
* @type {string}
|
|
294
294
|
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
295
295
|
*/
|
|
296
296
|
readonly createdBefore?: string;
|
|
297
297
|
/**
|
|
298
|
-
* Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in
|
|
298
|
+
* Purchase orders for which the last purchase order update happened after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
299
299
|
* @type {string}
|
|
300
300
|
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
301
301
|
*/
|
|
302
302
|
readonly updatedAfter?: string;
|
|
303
303
|
/**
|
|
304
|
-
* Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in
|
|
304
|
+
* Purchase orders for which the last purchase order update happened before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
305
305
|
* @type {string}
|
|
306
306
|
* @memberof VendorOrdersApiGetPurchaseOrdersStatus
|
|
307
307
|
*/
|
|
@@ -350,7 +350,7 @@ export interface VendorOrdersApiGetPurchaseOrdersStatusRequest {
|
|
|
350
350
|
*/
|
|
351
351
|
export interface VendorOrdersApiSubmitAcknowledgementRequest {
|
|
352
352
|
/**
|
|
353
|
-
*
|
|
353
|
+
*
|
|
354
354
|
* @type {SubmitAcknowledgementRequest}
|
|
355
355
|
* @memberof VendorOrdersApiSubmitAcknowledgement
|
|
356
356
|
*/
|
|
@@ -364,7 +364,7 @@ export interface VendorOrdersApiSubmitAcknowledgementRequest {
|
|
|
364
364
|
*/
|
|
365
365
|
export declare class VendorOrdersApi extends BaseAPI {
|
|
366
366
|
/**
|
|
367
|
-
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
367
|
+
* Returns a purchase order based on the `purchaseOrderNumber` value that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
368
368
|
* @param {VendorOrdersApiGetPurchaseOrderRequest} requestParameters Request parameters.
|
|
369
369
|
* @param {*} [options] Override http request option.
|
|
370
370
|
* @throws {RequiredError}
|
|
@@ -372,7 +372,7 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
372
372
|
*/
|
|
373
373
|
getPurchaseOrder(requestParameters: VendorOrdersApiGetPurchaseOrderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPurchaseOrderResponse, any>>;
|
|
374
374
|
/**
|
|
375
|
-
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
375
|
+
* Returns a list of purchase orders created or changed during the time frame that you specify. You define the time frame using the `createdAfter`, `createdBefore`, `changedAfter` and `changedBefore` parameters. The date range to search must not be more than 7 days. You can choose to get only the purchase order numbers by setting `includeDetails` to false. You can then use the `getPurchaseOrder` operation to receive details for a specific purchase order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
376
376
|
* @param {VendorOrdersApiGetPurchaseOrdersRequest} requestParameters Request parameters.
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
@@ -380,7 +380,7 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
380
380
|
*/
|
|
381
381
|
getPurchaseOrders(requestParameters?: VendorOrdersApiGetPurchaseOrdersRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPurchaseOrdersResponse, any>>;
|
|
382
382
|
/**
|
|
383
|
-
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
383
|
+
* Returns purchase order statuses based on the filters that you specify. Date range to search must not be more than 7 days. You can return a list of purchase order statuses using the available filters, or a single purchase order status by providing the purchase order number. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
384
384
|
* @param {VendorOrdersApiGetPurchaseOrdersStatusRequest} requestParameters Request parameters.
|
|
385
385
|
* @param {*} [options] Override http request option.
|
|
386
386
|
* @throws {RequiredError}
|
|
@@ -388,7 +388,7 @@ export declare class VendorOrdersApi extends BaseAPI {
|
|
|
388
388
|
*/
|
|
389
389
|
getPurchaseOrdersStatus(requestParameters?: VendorOrdersApiGetPurchaseOrdersStatusRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPurchaseOrdersStatusResponse, any>>;
|
|
390
390
|
/**
|
|
391
|
-
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 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
|
|
391
|
+
* Submits acknowledgements for one or more purchase orders. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
392
392
|
* @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
|
|
393
393
|
* @param {*} [options] Override http request option.
|
|
394
394
|
* @throws {RequiredError}
|
|
@@ -11,13 +11,13 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { ItemQuantity } from './item-quantity';
|
|
13
13
|
/**
|
|
14
|
-
* Details of
|
|
14
|
+
* Details of item quantity ordered
|
|
15
15
|
* @export
|
|
16
16
|
* @interface AcknowledgementStatusDetails
|
|
17
17
|
*/
|
|
18
18
|
export interface AcknowledgementStatusDetails {
|
|
19
19
|
/**
|
|
20
|
-
* The date when the line item was confirmed by
|
|
20
|
+
* The date when the line item was confirmed by vendor. Must be in ISO-8601 date/time format.
|
|
21
21
|
* @type {string}
|
|
22
22
|
* @memberof AcknowledgementStatusDetails
|
|
23
23
|
*/
|
|
@@ -64,7 +64,7 @@ export interface Address {
|
|
|
64
64
|
*/
|
|
65
65
|
'stateOrRegion'?: string;
|
|
66
66
|
/**
|
|
67
|
-
* The postal code of that address. It
|
|
67
|
+
* The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
|
|
68
68
|
* @type {string}
|
|
69
69
|
* @memberof Address
|
|
70
70
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { OrderListStatus } from './order-list-status';
|
|
13
13
|
/**
|
|
14
|
-
* The response schema for the
|
|
14
|
+
* The response schema for the getPurchaseOrdersStatus operation.
|
|
15
15
|
* @export
|
|
16
16
|
* @interface GetPurchaseOrdersStatusResponse
|
|
17
17
|
*/
|
|
@@ -28,13 +28,13 @@ export interface ImportDetails {
|
|
|
28
28
|
*/
|
|
29
29
|
'internationalCommercialTerms'?: ImportDetailsInternationalCommercialTermsEnum;
|
|
30
30
|
/**
|
|
31
|
-
* The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the
|
|
31
|
+
* The port where goods on an import purchase order must be delivered by the vendor. This should only be specified when the internationalCommercialTerms is FOB.
|
|
32
32
|
* @type {string}
|
|
33
33
|
* @memberof ImportDetails
|
|
34
34
|
*/
|
|
35
35
|
'portOfDelivery'?: string;
|
|
36
36
|
/**
|
|
37
|
-
* Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type:
|
|
37
|
+
* Types and numbers of container(s) for import purchase orders. Can be a comma-separated list if the shipment has multiple containers. HC signifies a high-capacity container. Free-text field, limited to 64 characters. The format will be a comma-delimited list containing values of the type: $NUMBER_OF_CONTAINERS_OF_THIS_TYPE-$CONTAINER_TYPE. The list of values for the container type is: 40\'(40-foot container), 40\'HC (40-foot high-capacity container), 45\', 45\'HC, 30\', 30\'HC, 20\', 20\'HC.
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof ImportDetails
|
|
40
40
|
*/
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* An amount of money
|
|
13
|
+
* An amount of money. Includes the currency code and an optional unit of measure for items priced by weight.
|
|
14
14
|
* @export
|
|
15
15
|
* @interface Money
|
|
16
16
|
*/
|
|
@@ -27,4 +27,17 @@ export interface Money {
|
|
|
27
27
|
* @memberof Money
|
|
28
28
|
*/
|
|
29
29
|
'amount'?: string;
|
|
30
|
+
/**
|
|
31
|
+
* The unit of measure for prices of items sold by weight. If this field is absent, the item is sold by eaches.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof Money
|
|
34
|
+
*/
|
|
35
|
+
'unitOfMeasure'?: MoneyUnitOfMeasureEnum;
|
|
30
36
|
}
|
|
37
|
+
export declare const MoneyUnitOfMeasureEnum: {
|
|
38
|
+
readonly Pounds: "POUNDS";
|
|
39
|
+
readonly Ounces: "OUNCES";
|
|
40
|
+
readonly Grams: "GRAMS";
|
|
41
|
+
readonly Kilograms: "KILOGRAMS";
|
|
42
|
+
};
|
|
43
|
+
export type MoneyUnitOfMeasureEnum = typeof MoneyUnitOfMeasureEnum[keyof typeof MoneyUnitOfMeasureEnum];
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { OrderAcknowledgementItem } from './order-acknowledgement-item';
|
|
13
13
|
import type { PartyIdentification } from './party-identification';
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
*
|
|
16
16
|
* @export
|
|
17
17
|
* @interface OrderAcknowledgement
|
|
18
18
|
*/
|
|
@@ -30,7 +30,7 @@ export interface OrderAcknowledgement {
|
|
|
30
30
|
*/
|
|
31
31
|
'sellingParty': PartyIdentification;
|
|
32
32
|
/**
|
|
33
|
-
* The date and time when the purchase order is acknowledged, in
|
|
33
|
+
* The date and time when the purchase order is acknowledged, in ISO-8601 date/time format.
|
|
34
34
|
* @type {string}
|
|
35
35
|
* @memberof OrderAcknowledgement
|
|
36
36
|
*/
|
|
@@ -19,19 +19,19 @@ import type { PartyIdentification } from './party-identification';
|
|
|
19
19
|
*/
|
|
20
20
|
export interface OrderDetails {
|
|
21
21
|
/**
|
|
22
|
-
* The date the purchase order was placed. Must be in
|
|
22
|
+
* The date the purchase order was placed. Must be in ISO-8601 date/time format.
|
|
23
23
|
* @type {string}
|
|
24
24
|
* @memberof OrderDetails
|
|
25
25
|
*/
|
|
26
26
|
'purchaseOrderDate': string;
|
|
27
27
|
/**
|
|
28
|
-
* The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than \'purchaseOrderDate\'. This means the PO data was changed on that date and vendors are required to fulfill the
|
|
28
|
+
* The date when purchase order was last changed by Amazon after the order was placed. This date will be greater than \'purchaseOrderDate\'. This means the PO data was changed on that date and vendors are required to fulfill the updated PO. The PO changes can be related to Item Quantity, Ship to Location, Ship Window etc. This field will not be present in orders that have not changed after creation. Must be in ISO-8601 date/time format.
|
|
29
29
|
* @type {string}
|
|
30
30
|
* @memberof OrderDetails
|
|
31
31
|
*/
|
|
32
32
|
'purchaseOrderChangedDate'?: string;
|
|
33
33
|
/**
|
|
34
|
-
* The date when current purchase order state was changed. Current purchase order state is available in the field \'purchaseOrderState\'. Must be in
|
|
34
|
+
* The date when current purchase order state was changed. Current purchase order state is available in the field \'purchaseOrderState\'. Must be in ISO-8601 date/time format.
|
|
35
35
|
* @type {string}
|
|
36
36
|
* @memberof OrderDetails
|
|
37
37
|
*/
|
|
@@ -85,13 +85,13 @@ export interface OrderDetails {
|
|
|
85
85
|
*/
|
|
86
86
|
'billToParty'?: PartyIdentification;
|
|
87
87
|
/**
|
|
88
|
-
* Defines a date time interval according to
|
|
88
|
+
* Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--).
|
|
89
89
|
* @type {string}
|
|
90
90
|
* @memberof OrderDetails
|
|
91
91
|
*/
|
|
92
92
|
'shipWindow'?: string;
|
|
93
93
|
/**
|
|
94
|
-
* Defines a date time interval according to
|
|
94
|
+
* Defines a date time interval according to ISO8601. Interval is separated by double hyphen (--).
|
|
95
95
|
* @type {string}
|
|
96
96
|
* @memberof OrderDetails
|
|
97
97
|
*/
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { ItemQuantity } from './item-quantity';
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
*
|
|
15
15
|
* @export
|
|
16
16
|
* @interface OrderItemAcknowledgement
|
|
17
17
|
*/
|
|
@@ -29,13 +29,13 @@ export interface OrderItemAcknowledgement {
|
|
|
29
29
|
*/
|
|
30
30
|
'acknowledgedQuantity': ItemQuantity;
|
|
31
31
|
/**
|
|
32
|
-
* Estimated ship date per line item. Must be in
|
|
32
|
+
* Estimated ship date per line item. Must be in ISO-8601 date/time format.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof OrderItemAcknowledgement
|
|
35
35
|
*/
|
|
36
36
|
'scheduledShipDate'?: string;
|
|
37
37
|
/**
|
|
38
|
-
* Estimated delivery date per line item. Must be in
|
|
38
|
+
* Estimated delivery date per line item. Must be in ISO-8601 date/time format.
|
|
39
39
|
* @type {string}
|
|
40
40
|
* @memberof OrderItemAcknowledgement
|
|
41
41
|
*/
|
|
@@ -29,7 +29,7 @@ export interface OrderItemStatusReceivingStatus {
|
|
|
29
29
|
*/
|
|
30
30
|
'receivedQuantity'?: ItemQuantity;
|
|
31
31
|
/**
|
|
32
|
-
* The date when the most recent item was received at the buyer\'s warehouse. Must be in
|
|
32
|
+
* The date when the most recent item was received at the buyer\'s warehouse. Must be in ISO-8601 date/time format.
|
|
33
33
|
* @type {string}
|
|
34
34
|
* @memberof OrderItemStatusReceivingStatus
|
|
35
35
|
*/
|
|
@@ -14,7 +14,7 @@ import type { OrderItemStatusAcknowledgementStatus } from './order-item-status-a
|
|
|
14
14
|
import type { OrderItemStatusOrderedQuantity } from './order-item-status-ordered-quantity';
|
|
15
15
|
import type { OrderItemStatusReceivingStatus } from './order-item-status-receiving-status';
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
*
|
|
18
18
|
* @export
|
|
19
19
|
* @interface OrderItemStatus
|
|
20
20
|
*/
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { ItemQuantity } from './item-quantity';
|
|
13
13
|
import type { Money } from './money';
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
*
|
|
16
16
|
* @export
|
|
17
17
|
* @interface OrderItem
|
|
18
18
|
*/
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
import type { OrderStatus } from './order-status';
|
|
13
13
|
import type { Pagination } from './pagination';
|
|
14
14
|
/**
|
|
15
|
-
*
|
|
15
|
+
*
|
|
16
16
|
* @export
|
|
17
17
|
* @interface OrderListStatus
|
|
18
18
|
*/
|
|
@@ -24,7 +24,7 @@ export interface OrderListStatus {
|
|
|
24
24
|
*/
|
|
25
25
|
'pagination'?: Pagination;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
*
|
|
28
28
|
* @type {Array<OrderStatus>}
|
|
29
29
|
* @memberof OrderListStatus
|
|
30
30
|
*/
|