@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 2.0.2 → 2.1.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.
Files changed (114) hide show
  1. package/README.md +1 -1
  2. package/dist/cjs/src/api-model/api/update-inventory-api.js +126 -0
  3. package/dist/cjs/src/api-model/api.js +3 -3
  4. package/dist/cjs/src/api-model/base.js +2 -2
  5. package/dist/cjs/src/api-model/common.js +2 -2
  6. package/dist/cjs/src/api-model/configuration.js +2 -2
  7. package/dist/cjs/src/api-model/index.js +2 -2
  8. package/dist/cjs/src/api-model/models/index.js +5 -23
  9. package/dist/cjs/src/api-model/models/{get-orders-response.js → inventory-update.js} +2 -2
  10. package/dist/cjs/src/api-model/models/{acknowledgement-status.js → item-details.js} +2 -2
  11. package/dist/cjs/src/api-model/models/item-quantity.js +2 -6
  12. package/dist/cjs/src/api-model/models/model-error.js +2 -2
  13. package/dist/cjs/src/api-model/models/party-identification.js +2 -2
  14. package/dist/cjs/src/api-model/models/{address.js → submit-inventory-update-request.js} +2 -2
  15. package/dist/cjs/src/api-model/models/{get-order-response.js → submit-inventory-update-response.js} +2 -2
  16. package/dist/cjs/src/api-model/models/transaction-reference.js +15 -0
  17. package/dist/cjs/src/client.js +2 -16
  18. package/dist/es/src/api-model/api/update-inventory-api.js +116 -0
  19. package/dist/es/src/api-model/api.js +3 -3
  20. package/dist/es/src/api-model/base.js +2 -2
  21. package/dist/es/src/api-model/common.js +2 -2
  22. package/dist/es/src/api-model/configuration.js +2 -2
  23. package/dist/es/src/api-model/index.js +2 -2
  24. package/dist/es/src/api-model/models/index.js +5 -23
  25. package/dist/es/src/api-model/models/{acknowledgement-status.js → inventory-update.js} +2 -2
  26. package/dist/es/src/api-model/models/{address.js → item-details.js} +2 -2
  27. package/dist/es/src/api-model/models/item-quantity.js +3 -5
  28. package/dist/es/src/api-model/models/model-error.js +2 -2
  29. package/dist/es/src/api-model/models/party-identification.js +2 -2
  30. package/dist/es/src/api-model/models/{get-order-response.js → submit-inventory-update-request.js} +2 -2
  31. package/dist/es/src/api-model/models/{get-orders-response.js → submit-inventory-update-response.js} +2 -2
  32. package/dist/es/src/api-model/models/transaction-reference.js +14 -0
  33. package/dist/es/src/client.js +3 -17
  34. package/dist/types/src/api-model/api/update-inventory-api.d.ts +93 -0
  35. package/dist/types/src/api-model/api.d.ts +3 -3
  36. package/dist/types/src/api-model/base.d.ts +2 -2
  37. package/dist/types/src/api-model/common.d.ts +2 -2
  38. package/dist/types/src/api-model/configuration.d.ts +2 -2
  39. package/dist/types/src/api-model/index.d.ts +2 -2
  40. package/dist/types/src/api-model/models/index.d.ts +5 -23
  41. package/dist/types/src/api-model/models/inventory-update.d.ts +38 -0
  42. package/dist/types/src/api-model/models/item-details.d.ts +43 -0
  43. package/dist/types/src/api-model/models/item-quantity.d.ts +6 -10
  44. package/dist/types/src/api-model/models/model-error.d.ts +2 -2
  45. package/dist/types/src/api-model/models/party-identification.d.ts +3 -17
  46. package/dist/types/src/api-model/models/submit-inventory-update-request.d.ts +25 -0
  47. package/dist/types/src/api-model/models/submit-inventory-update-response.d.ts +31 -0
  48. package/dist/types/src/api-model/models/transaction-reference.d.ts +24 -0
  49. package/dist/types/src/client.d.ts +2 -2
  50. package/package.json +5 -5
  51. package/dist/cjs/src/api-model/api/vendor-orders-api.js +0 -278
  52. package/dist/cjs/src/api-model/models/gift-details.js +0 -15
  53. package/dist/cjs/src/api-model/models/money.js +0 -15
  54. package/dist/cjs/src/api-model/models/order-acknowledgement-item.js +0 -15
  55. package/dist/cjs/src/api-model/models/order-details-tax-total.js +0 -15
  56. package/dist/cjs/src/api-model/models/order-details.js +0 -22
  57. package/dist/cjs/src/api-model/models/order-item-acknowledgement.js +0 -15
  58. package/dist/cjs/src/api-model/models/order-item-tax-details.js +0 -15
  59. package/dist/cjs/src/api-model/models/order-item.js +0 -15
  60. package/dist/cjs/src/api-model/models/order-list.js +0 -15
  61. package/dist/cjs/src/api-model/models/order.js +0 -15
  62. package/dist/cjs/src/api-model/models/pagination.js +0 -15
  63. package/dist/cjs/src/api-model/models/scheduled-delivery-shipment.js +0 -15
  64. package/dist/cjs/src/api-model/models/shipment-dates.js +0 -15
  65. package/dist/cjs/src/api-model/models/shipment-details.js +0 -15
  66. package/dist/cjs/src/api-model/models/submit-acknowledgement-request.js +0 -15
  67. package/dist/cjs/src/api-model/models/submit-acknowledgement-response.js +0 -15
  68. package/dist/cjs/src/api-model/models/tax-details.js +0 -25
  69. package/dist/cjs/src/api-model/models/tax-registration-details.js +0 -20
  70. package/dist/cjs/src/api-model/models/transaction-id.js +0 -15
  71. package/dist/es/src/api-model/api/vendor-orders-api.js +0 -268
  72. package/dist/es/src/api-model/models/gift-details.js +0 -14
  73. package/dist/es/src/api-model/models/money.js +0 -14
  74. package/dist/es/src/api-model/models/order-acknowledgement-item.js +0 -14
  75. package/dist/es/src/api-model/models/order-details-tax-total.js +0 -14
  76. package/dist/es/src/api-model/models/order-details.js +0 -19
  77. package/dist/es/src/api-model/models/order-item-acknowledgement.js +0 -14
  78. package/dist/es/src/api-model/models/order-item-tax-details.js +0 -14
  79. package/dist/es/src/api-model/models/order-item.js +0 -14
  80. package/dist/es/src/api-model/models/order-list.js +0 -14
  81. package/dist/es/src/api-model/models/order.js +0 -14
  82. package/dist/es/src/api-model/models/pagination.js +0 -14
  83. package/dist/es/src/api-model/models/scheduled-delivery-shipment.js +0 -14
  84. package/dist/es/src/api-model/models/shipment-dates.js +0 -14
  85. package/dist/es/src/api-model/models/shipment-details.js +0 -14
  86. package/dist/es/src/api-model/models/submit-acknowledgement-request.js +0 -14
  87. package/dist/es/src/api-model/models/submit-acknowledgement-response.js +0 -14
  88. package/dist/es/src/api-model/models/tax-details.js +0 -22
  89. package/dist/es/src/api-model/models/tax-registration-details.js +0 -17
  90. package/dist/es/src/api-model/models/transaction-id.js +0 -14
  91. package/dist/types/src/api-model/api/vendor-orders-api.d.ts +0 -226
  92. package/dist/types/src/api-model/models/acknowledgement-status.d.ts +0 -30
  93. package/dist/types/src/api-model/models/address.d.ts +0 -90
  94. package/dist/types/src/api-model/models/get-order-response.d.ts +0 -31
  95. package/dist/types/src/api-model/models/get-orders-response.d.ts +0 -31
  96. package/dist/types/src/api-model/models/gift-details.d.ts +0 -30
  97. package/dist/types/src/api-model/models/money.d.ts +0 -30
  98. package/dist/types/src/api-model/models/order-acknowledgement-item.d.ts +0 -63
  99. package/dist/types/src/api-model/models/order-details-tax-total.d.ts +0 -25
  100. package/dist/types/src/api-model/models/order-details.d.ts +0 -90
  101. package/dist/types/src/api-model/models/order-item-acknowledgement.d.ts +0 -43
  102. package/dist/types/src/api-model/models/order-item-tax-details.d.ts +0 -25
  103. package/dist/types/src/api-model/models/order-item.d.ts +0 -83
  104. package/dist/types/src/api-model/models/order-list.d.ts +0 -32
  105. package/dist/types/src/api-model/models/order.d.ts +0 -31
  106. package/dist/types/src/api-model/models/pagination.d.ts +0 -24
  107. package/dist/types/src/api-model/models/scheduled-delivery-shipment.d.ts +0 -36
  108. package/dist/types/src/api-model/models/shipment-dates.d.ts +0 -30
  109. package/dist/types/src/api-model/models/shipment-details.d.ts +0 -61
  110. package/dist/types/src/api-model/models/submit-acknowledgement-request.d.ts +0 -25
  111. package/dist/types/src/api-model/models/submit-acknowledgement-response.d.ts +0 -31
  112. package/dist/types/src/api-model/models/tax-details.d.ts +0 -53
  113. package/dist/types/src/api-model/models/tax-registration-details.d.ts +0 -48
  114. package/dist/types/src/api-model/models/transaction-id.d.ts +0 -24
@@ -1,226 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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 type { Configuration } from '../configuration';
13
- import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
14
- import { RequestArgs, BaseAPI } from '../base';
15
- import { GetOrderResponse } from '../models';
16
- import { GetOrdersResponse } from '../models';
17
- import { SubmitAcknowledgementRequest } from '../models';
18
- import { SubmitAcknowledgementResponse } from '../models';
19
- /**
20
- * VendorOrdersApi - axios parameter creator
21
- * @export
22
- */
23
- export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
24
- /**
25
- * Returns purchase order information for the purchaseOrderNumber 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 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 than 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).
26
- * @param {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
27
- * @param {*} [options] Override http request option.
28
- * @throws {RequiredError}
29
- */
30
- getOrder: (purchaseOrderNumber: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
- /**
32
- * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific 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 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 than 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).
33
- * @param {string} createdAfter Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
34
- * @param {string} createdBefore Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
35
- * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
36
- * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
37
- * @param {number} [limit] The limit to the number of purchase orders returned.
38
- * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
39
- * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
40
- * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
41
- * @param {*} [options] Override http request option.
42
- * @throws {RequiredError}
43
- */
44
- getOrders: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED', limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, includeDetails?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
- /**
46
- * 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 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 than 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).
47
- * @param {SubmitAcknowledgementRequest} body
48
- * @param {*} [options] Override http request option.
49
- * @throws {RequiredError}
50
- */
51
- submitAcknowledgement: (body: SubmitAcknowledgementRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
- };
53
- /**
54
- * VendorOrdersApi - functional programming interface
55
- * @export
56
- */
57
- export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
58
- /**
59
- * Returns purchase order information for the purchaseOrderNumber 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 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 than 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).
60
- * @param {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
61
- * @param {*} [options] Override http request option.
62
- * @throws {RequiredError}
63
- */
64
- getOrder(purchaseOrderNumber: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
65
- /**
66
- * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific 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 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 than 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).
67
- * @param {string} createdAfter Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
68
- * @param {string} createdBefore Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
69
- * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
70
- * @param {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'} [status] Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
71
- * @param {number} [limit] The limit to the number of purchase orders returned.
72
- * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
73
- * @param {string} [nextToken] Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
74
- * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
75
- * @param {*} [options] Override http request option.
76
- * @throws {RequiredError}
77
- */
78
- getOrders(createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED', limit?: number, sortOrder?: 'ASC' | 'DESC', nextToken?: string, includeDetails?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
79
- /**
80
- * 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 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 than 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).
81
- * @param {SubmitAcknowledgementRequest} body
82
- * @param {*} [options] Override http request option.
83
- * @throws {RequiredError}
84
- */
85
- submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitAcknowledgementResponse>>;
86
- };
87
- /**
88
- * VendorOrdersApi - factory interface
89
- * @export
90
- */
91
- export declare const VendorOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
92
- /**
93
- * Returns purchase order information for the purchaseOrderNumber 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 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 than 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).
94
- * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
95
- * @param {*} [options] Override http request option.
96
- * @throws {RequiredError}
97
- */
98
- getOrder(requestParameters: VendorOrdersApiGetOrderRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderResponse>;
99
- /**
100
- * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific 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 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 than 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).
101
- * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
102
- * @param {*} [options] Override http request option.
103
- * @throws {RequiredError}
104
- */
105
- getOrders(requestParameters: VendorOrdersApiGetOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
106
- /**
107
- * 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 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 than 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).
108
- * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
109
- * @param {*} [options] Override http request option.
110
- * @throws {RequiredError}
111
- */
112
- submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: AxiosRequestConfig): AxiosPromise<SubmitAcknowledgementResponse>;
113
- };
114
- /**
115
- * Request parameters for getOrder operation in VendorOrdersApi.
116
- * @export
117
- * @interface VendorOrdersApiGetOrderRequest
118
- */
119
- export interface VendorOrdersApiGetOrderRequest {
120
- /**
121
- * The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
122
- * @type {string}
123
- * @memberof VendorOrdersApiGetOrder
124
- */
125
- readonly purchaseOrderNumber: string;
126
- }
127
- /**
128
- * Request parameters for getOrders operation in VendorOrdersApi.
129
- * @export
130
- * @interface VendorOrdersApiGetOrdersRequest
131
- */
132
- export interface VendorOrdersApiGetOrdersRequest {
133
- /**
134
- * Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
135
- * @type {string}
136
- * @memberof VendorOrdersApiGetOrders
137
- */
138
- readonly createdAfter: string;
139
- /**
140
- * Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
141
- * @type {string}
142
- * @memberof VendorOrdersApiGetOrders
143
- */
144
- readonly createdBefore: string;
145
- /**
146
- * The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
147
- * @type {string}
148
- * @memberof VendorOrdersApiGetOrders
149
- */
150
- readonly shipFromPartyId?: string;
151
- /**
152
- * Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
153
- * @type {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'}
154
- * @memberof VendorOrdersApiGetOrders
155
- */
156
- readonly status?: 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED';
157
- /**
158
- * The limit to the number of purchase orders returned.
159
- * @type {number}
160
- * @memberof VendorOrdersApiGetOrders
161
- */
162
- readonly limit?: number;
163
- /**
164
- * Sort the list in ascending or descending order by order creation date.
165
- * @type {'ASC' | 'DESC'}
166
- * @memberof VendorOrdersApiGetOrders
167
- */
168
- readonly sortOrder?: 'ASC' | 'DESC';
169
- /**
170
- * Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
171
- * @type {string}
172
- * @memberof VendorOrdersApiGetOrders
173
- */
174
- readonly nextToken?: string;
175
- /**
176
- * When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
177
- * @type {boolean}
178
- * @memberof VendorOrdersApiGetOrders
179
- */
180
- readonly includeDetails?: boolean;
181
- }
182
- /**
183
- * Request parameters for submitAcknowledgement operation in VendorOrdersApi.
184
- * @export
185
- * @interface VendorOrdersApiSubmitAcknowledgementRequest
186
- */
187
- export interface VendorOrdersApiSubmitAcknowledgementRequest {
188
- /**
189
- *
190
- * @type {SubmitAcknowledgementRequest}
191
- * @memberof VendorOrdersApiSubmitAcknowledgement
192
- */
193
- readonly body: SubmitAcknowledgementRequest;
194
- }
195
- /**
196
- * VendorOrdersApi - object-oriented interface
197
- * @export
198
- * @class VendorOrdersApi
199
- * @extends {BaseAPI}
200
- */
201
- export declare class VendorOrdersApi extends BaseAPI {
202
- /**
203
- * Returns purchase order information for the purchaseOrderNumber 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 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 than 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).
204
- * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
205
- * @param {*} [options] Override http request option.
206
- * @throws {RequiredError}
207
- * @memberof VendorOrdersApi
208
- */
209
- getOrder(requestParameters: VendorOrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrderResponse, any>>;
210
- /**
211
- * Returns a list of purchase orders created during the time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both parameters. You can choose to get only the purchase order numbers by setting the includeDetails parameter to false. In that case, the operation returns a list of purchase order numbers. You can then call the getOrder operation to return the details of a specific 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 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 than 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).
212
- * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
213
- * @param {*} [options] Override http request option.
214
- * @throws {RequiredError}
215
- * @memberof VendorOrdersApi
216
- */
217
- getOrders(requestParameters: VendorOrdersApiGetOrdersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetOrdersResponse, any>>;
218
- /**
219
- * 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 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 than 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).
220
- * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
221
- * @param {*} [options] Override http request option.
222
- * @throws {RequiredError}
223
- * @memberof VendorOrdersApi
224
- */
225
- submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SubmitAcknowledgementResponse, any>>;
226
- }
@@ -1,30 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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
- * Status of acknowledgement.
14
- * @export
15
- * @interface AcknowledgementStatus
16
- */
17
- export interface AcknowledgementStatus {
18
- /**
19
- * Acknowledgement code is a unique two digit value which indicates the status of the acknowledgement. For a list of acknowledgement codes that Amazon supports, see the Vendor Direct Fulfillment APIs Use Case Guide.
20
- * @type {string}
21
- * @memberof AcknowledgementStatus
22
- */
23
- 'code'?: string;
24
- /**
25
- * Reason for the acknowledgement code.
26
- * @type {string}
27
- * @memberof AcknowledgementStatus
28
- */
29
- 'description'?: string;
30
- }
@@ -1,90 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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
- * Address of the party.
14
- * @export
15
- * @interface Address
16
- */
17
- export interface Address {
18
- /**
19
- * The name of the person, business or institution at that address.
20
- * @type {string}
21
- * @memberof Address
22
- */
23
- 'name': string;
24
- /**
25
- * The attention name of the person at that address.
26
- * @type {string}
27
- * @memberof Address
28
- */
29
- 'attention'?: string;
30
- /**
31
- * First line of the address.
32
- * @type {string}
33
- * @memberof Address
34
- */
35
- 'addressLine1': string;
36
- /**
37
- * Additional address information, if required.
38
- * @type {string}
39
- * @memberof Address
40
- */
41
- 'addressLine2'?: string;
42
- /**
43
- * Additional address information, if required.
44
- * @type {string}
45
- * @memberof Address
46
- */
47
- 'addressLine3'?: string;
48
- /**
49
- * The city where the person, business or institution is located.
50
- * @type {string}
51
- * @memberof Address
52
- */
53
- 'city'?: string;
54
- /**
55
- * The county where person, business or institution is located.
56
- * @type {string}
57
- * @memberof Address
58
- */
59
- 'county'?: string;
60
- /**
61
- * The district where person, business or institution is located.
62
- * @type {string}
63
- * @memberof Address
64
- */
65
- 'district'?: string;
66
- /**
67
- * The state or region where person, business or institution is located.
68
- * @type {string}
69
- * @memberof Address
70
- */
71
- 'stateOrRegion': string;
72
- /**
73
- * The postal code of that address. It conatins a series of letters or digits or both, sometimes including spaces or punctuation.
74
- * @type {string}
75
- * @memberof Address
76
- */
77
- 'postalCode'?: string;
78
- /**
79
- * The two digit country code. In ISO 3166-1 alpha-2 format.
80
- * @type {string}
81
- * @memberof Address
82
- */
83
- 'countryCode': string;
84
- /**
85
- * The phone number of the person, business or institution located at that address.
86
- * @type {string}
87
- * @memberof Address
88
- */
89
- 'phone'?: string;
90
- }
@@ -1,31 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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 { Order } from './order';
13
- /**
14
- * The response schema for the getOrder operation.
15
- * @export
16
- * @interface GetOrderResponse
17
- */
18
- export interface GetOrderResponse {
19
- /**
20
- *
21
- * @type {Order}
22
- * @memberof GetOrderResponse
23
- */
24
- 'payload'?: Order;
25
- /**
26
- * A list of error responses returned when a request is unsuccessful.
27
- * @type {Array<Error>}
28
- * @memberof GetOrderResponse
29
- */
30
- 'errors'?: Array<Error>;
31
- }
@@ -1,31 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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 { OrderList } from './order-list';
13
- /**
14
- * The response schema for the getOrders operation.
15
- * @export
16
- * @interface GetOrdersResponse
17
- */
18
- export interface GetOrdersResponse {
19
- /**
20
- *
21
- * @type {OrderList}
22
- * @memberof GetOrdersResponse
23
- */
24
- 'payload'?: OrderList;
25
- /**
26
- * A list of error responses returned when a request is unsuccessful.
27
- * @type {Array<Error>}
28
- * @memberof GetOrdersResponse
29
- */
30
- 'errors'?: Array<Error>;
31
- }
@@ -1,30 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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
- * Gift details for the item.
14
- * @export
15
- * @interface GiftDetails
16
- */
17
- export interface GiftDetails {
18
- /**
19
- * Gift message to be printed in shipment.
20
- * @type {string}
21
- * @memberof GiftDetails
22
- */
23
- 'giftMessage'?: string;
24
- /**
25
- * Gift wrap identifier for the gift wrapping, if any.
26
- * @type {string}
27
- * @memberof GiftDetails
28
- */
29
- 'giftWrapId'?: string;
30
- }
@@ -1,30 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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
- * An amount of money, including units in the form of currency.
14
- * @export
15
- * @interface Money
16
- */
17
- export interface Money {
18
- /**
19
- * Three digit currency code in ISO 4217 format. String of length 3.
20
- * @type {string}
21
- * @memberof Money
22
- */
23
- 'currencyCode'?: string;
24
- /**
25
- * A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation.
26
- * @type {string}
27
- * @memberof Money
28
- */
29
- 'amount'?: string;
30
- }
@@ -1,63 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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 { AcknowledgementStatus } from './acknowledgement-status';
13
- import { OrderItemAcknowledgement } from './order-item-acknowledgement';
14
- import { PartyIdentification } from './party-identification';
15
- /**
16
- * Details of an individual order being acknowledged.
17
- * @export
18
- * @interface OrderAcknowledgementItem
19
- */
20
- export interface OrderAcknowledgementItem {
21
- /**
22
- * The purchase order number for this order. Formatting Notes: alpha-numeric code.
23
- * @type {string}
24
- * @memberof OrderAcknowledgementItem
25
- */
26
- 'purchaseOrderNumber': string;
27
- /**
28
- * The vendor\'s order number for this order.
29
- * @type {string}
30
- * @memberof OrderAcknowledgementItem
31
- */
32
- 'vendorOrderNumber': string;
33
- /**
34
- * The date and time when the order is acknowledged, in ISO-8601 date/time format. For example: 2018-07-16T23:00:00Z / 2018-07-16T23:00:00-05:00 / 2018-07-16T23:00:00-08:00.
35
- * @type {string}
36
- * @memberof OrderAcknowledgementItem
37
- */
38
- 'acknowledgementDate': string;
39
- /**
40
- *
41
- * @type {AcknowledgementStatus}
42
- * @memberof OrderAcknowledgementItem
43
- */
44
- 'acknowledgementStatus': AcknowledgementStatus;
45
- /**
46
- *
47
- * @type {PartyIdentification}
48
- * @memberof OrderAcknowledgementItem
49
- */
50
- 'sellingParty': PartyIdentification;
51
- /**
52
- *
53
- * @type {PartyIdentification}
54
- * @memberof OrderAcknowledgementItem
55
- */
56
- 'shipFromParty': PartyIdentification;
57
- /**
58
- * Item details including acknowledged quantity.
59
- * @type {Array<OrderItemAcknowledgement>}
60
- * @memberof OrderAcknowledgementItem
61
- */
62
- 'itemAcknowledgements': Array<OrderItemAcknowledgement>;
63
- }
@@ -1,25 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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 { TaxDetails } from './tax-details';
13
- /**
14
- *
15
- * @export
16
- * @interface OrderDetailsTaxTotal
17
- */
18
- export interface OrderDetailsTaxTotal {
19
- /**
20
- * A list of tax line items.
21
- * @type {Array<TaxDetails>}
22
- * @memberof OrderDetailsTaxTotal
23
- */
24
- 'taxLineItem'?: Array<TaxDetails>;
25
- }
@@ -1,90 +0,0 @@
1
- /**
2
- * Selling Partner API for Direct Fulfillment Orders
3
- * The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor\'s order data.
4
- *
5
- * The version of the OpenAPI document: v1
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 { Address } from './address';
13
- import { OrderDetailsTaxTotal } from './order-details-tax-total';
14
- import { OrderItem } from './order-item';
15
- import { PartyIdentification } from './party-identification';
16
- import { ShipmentDetails } from './shipment-details';
17
- /**
18
- * Details of an order.
19
- * @export
20
- * @interface OrderDetails
21
- */
22
- export interface OrderDetails {
23
- /**
24
- * The customer order number.
25
- * @type {string}
26
- * @memberof OrderDetails
27
- */
28
- 'customerOrderNumber': string;
29
- /**
30
- * The date the order was placed. This field is expected to be in ISO-8601 date/time format, for example:2018-07-16T23:00:00Z/ 2018-07-16T23:00:00-05:00 /2018-07-16T23:00:00-08:00. If no time zone is specified, UTC should be assumed.
31
- * @type {string}
32
- * @memberof OrderDetails
33
- */
34
- 'orderDate': string;
35
- /**
36
- * Current status of the order.
37
- * @type {string}
38
- * @memberof OrderDetails
39
- */
40
- 'orderStatus'?: OrderDetailsOrderStatusEnum;
41
- /**
42
- *
43
- * @type {ShipmentDetails}
44
- * @memberof OrderDetails
45
- */
46
- 'shipmentDetails': ShipmentDetails;
47
- /**
48
- *
49
- * @type {OrderDetailsTaxTotal}
50
- * @memberof OrderDetails
51
- */
52
- 'taxTotal'?: OrderDetailsTaxTotal;
53
- /**
54
- *
55
- * @type {PartyIdentification}
56
- * @memberof OrderDetails
57
- */
58
- 'sellingParty': PartyIdentification;
59
- /**
60
- *
61
- * @type {PartyIdentification}
62
- * @memberof OrderDetails
63
- */
64
- 'shipFromParty': PartyIdentification;
65
- /**
66
- *
67
- * @type {Address}
68
- * @memberof OrderDetails
69
- */
70
- 'shipToParty': Address;
71
- /**
72
- *
73
- * @type {PartyIdentification}
74
- * @memberof OrderDetails
75
- */
76
- 'billToParty': PartyIdentification;
77
- /**
78
- * A list of items in this purchase order.
79
- * @type {Array<OrderItem>}
80
- * @memberof OrderDetails
81
- */
82
- 'items': Array<OrderItem>;
83
- }
84
- export declare const OrderDetailsOrderStatusEnum: {
85
- readonly New: "NEW";
86
- readonly Shipped: "SHIPPED";
87
- readonly Accepted: "ACCEPTED";
88
- readonly Cancelled: "CANCELLED";
89
- };
90
- export type OrderDetailsOrderStatusEnum = typeof OrderDetailsOrderStatusEnum[keyof typeof OrderDetailsOrderStatusEnum];