@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 2.1.1 → 2.2.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/vendor-orders-api.js +278 -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/{submit-inventory-update-response.js → acknowledgement-status.js} +2 -2
  9. package/dist/cjs/src/api-model/models/{inventory-update.js → address.js} +2 -2
  10. package/dist/cjs/src/api-model/models/{item-details.js → get-order-response.js} +2 -2
  11. package/dist/cjs/src/api-model/models/{submit-inventory-update-request.js → get-orders-response.js} +2 -2
  12. package/dist/cjs/src/api-model/models/gift-details.js +15 -0
  13. package/dist/cjs/src/api-model/models/index.js +23 -5
  14. package/dist/cjs/src/api-model/models/item-quantity.js +6 -2
  15. package/dist/cjs/src/api-model/models/model-error.js +2 -2
  16. package/dist/cjs/src/api-model/models/money.js +15 -0
  17. package/dist/cjs/src/api-model/models/order-acknowledgement-item.js +15 -0
  18. package/dist/cjs/src/api-model/models/order-details-tax-total.js +15 -0
  19. package/dist/cjs/src/api-model/models/order-details.js +22 -0
  20. package/dist/cjs/src/api-model/models/order-item-acknowledgement.js +15 -0
  21. package/dist/cjs/src/api-model/models/order-item-tax-details.js +15 -0
  22. package/dist/cjs/src/api-model/models/order-item.js +15 -0
  23. package/dist/cjs/src/api-model/models/order-list.js +15 -0
  24. package/dist/cjs/src/api-model/models/order.js +15 -0
  25. package/dist/cjs/src/api-model/models/pagination.js +15 -0
  26. package/dist/cjs/src/api-model/models/party-identification.js +2 -2
  27. package/dist/cjs/src/api-model/models/scheduled-delivery-shipment.js +15 -0
  28. package/dist/cjs/src/api-model/models/shipment-dates.js +15 -0
  29. package/dist/cjs/src/api-model/models/shipment-details.js +15 -0
  30. package/dist/cjs/src/api-model/models/submit-acknowledgement-request.js +15 -0
  31. package/dist/cjs/src/api-model/models/submit-acknowledgement-response.js +15 -0
  32. package/dist/cjs/src/api-model/models/tax-details.js +25 -0
  33. package/dist/cjs/src/api-model/models/tax-registration-details.js +20 -0
  34. package/dist/cjs/src/api-model/models/transaction-id.js +15 -0
  35. package/dist/cjs/src/client.js +16 -2
  36. package/dist/es/src/api-model/api/vendor-orders-api.js +268 -0
  37. package/dist/es/src/api-model/api.js +3 -3
  38. package/dist/es/src/api-model/base.js +2 -2
  39. package/dist/es/src/api-model/common.js +2 -2
  40. package/dist/es/src/api-model/configuration.js +2 -2
  41. package/dist/es/src/api-model/index.js +2 -2
  42. package/dist/es/src/api-model/models/{inventory-update.js → acknowledgement-status.js} +2 -2
  43. package/dist/es/src/api-model/models/{item-details.js → address.js} +2 -2
  44. package/dist/es/src/api-model/models/{submit-inventory-update-request.js → get-order-response.js} +2 -2
  45. package/dist/es/src/api-model/models/{submit-inventory-update-response.js → get-orders-response.js} +2 -2
  46. package/dist/es/src/api-model/models/gift-details.js +14 -0
  47. package/dist/es/src/api-model/models/index.js +23 -5
  48. package/dist/es/src/api-model/models/item-quantity.js +5 -3
  49. package/dist/es/src/api-model/models/model-error.js +2 -2
  50. package/dist/es/src/api-model/models/money.js +14 -0
  51. package/dist/es/src/api-model/models/order-acknowledgement-item.js +14 -0
  52. package/dist/es/src/api-model/models/order-details-tax-total.js +14 -0
  53. package/dist/es/src/api-model/models/order-details.js +19 -0
  54. package/dist/es/src/api-model/models/order-item-acknowledgement.js +14 -0
  55. package/dist/es/src/api-model/models/order-item-tax-details.js +14 -0
  56. package/dist/es/src/api-model/models/order-item.js +14 -0
  57. package/dist/es/src/api-model/models/order-list.js +14 -0
  58. package/dist/es/src/api-model/models/order.js +14 -0
  59. package/dist/es/src/api-model/models/pagination.js +14 -0
  60. package/dist/es/src/api-model/models/party-identification.js +2 -2
  61. package/dist/es/src/api-model/models/scheduled-delivery-shipment.js +14 -0
  62. package/dist/es/src/api-model/models/shipment-dates.js +14 -0
  63. package/dist/es/src/api-model/models/shipment-details.js +14 -0
  64. package/dist/es/src/api-model/models/submit-acknowledgement-request.js +14 -0
  65. package/dist/es/src/api-model/models/submit-acknowledgement-response.js +14 -0
  66. package/dist/es/src/api-model/models/tax-details.js +22 -0
  67. package/dist/es/src/api-model/models/tax-registration-details.js +17 -0
  68. package/dist/es/src/api-model/models/transaction-id.js +14 -0
  69. package/dist/es/src/client.js +17 -3
  70. package/dist/types/src/api-model/api/vendor-orders-api.d.ts +227 -0
  71. package/dist/types/src/api-model/api.d.ts +3 -3
  72. package/dist/types/src/api-model/base.d.ts +2 -2
  73. package/dist/types/src/api-model/common.d.ts +2 -2
  74. package/dist/types/src/api-model/configuration.d.ts +2 -2
  75. package/dist/types/src/api-model/index.d.ts +2 -2
  76. package/dist/types/src/api-model/models/acknowledgement-status.d.ts +30 -0
  77. package/dist/types/src/api-model/models/address.d.ts +90 -0
  78. package/dist/types/src/api-model/models/get-order-response.d.ts +31 -0
  79. package/dist/types/src/api-model/models/get-orders-response.d.ts +31 -0
  80. package/dist/types/src/api-model/models/gift-details.d.ts +30 -0
  81. package/dist/types/src/api-model/models/index.d.ts +23 -5
  82. package/dist/types/src/api-model/models/item-quantity.d.ts +10 -6
  83. package/dist/types/src/api-model/models/model-error.d.ts +2 -2
  84. package/dist/types/src/api-model/models/money.d.ts +30 -0
  85. package/dist/types/src/api-model/models/order-acknowledgement-item.d.ts +63 -0
  86. package/dist/types/src/api-model/models/order-details-tax-total.d.ts +25 -0
  87. package/dist/types/src/api-model/models/order-details.d.ts +90 -0
  88. package/dist/types/src/api-model/models/order-item-acknowledgement.d.ts +43 -0
  89. package/dist/types/src/api-model/models/order-item-tax-details.d.ts +25 -0
  90. package/dist/types/src/api-model/models/order-item.d.ts +83 -0
  91. package/dist/types/src/api-model/models/order-list.d.ts +32 -0
  92. package/dist/types/src/api-model/models/order.d.ts +31 -0
  93. package/dist/types/src/api-model/models/pagination.d.ts +24 -0
  94. package/dist/types/src/api-model/models/party-identification.d.ts +17 -3
  95. package/dist/types/src/api-model/models/scheduled-delivery-shipment.d.ts +36 -0
  96. package/dist/types/src/api-model/models/shipment-dates.d.ts +30 -0
  97. package/dist/types/src/api-model/models/shipment-details.d.ts +61 -0
  98. package/dist/types/src/api-model/models/submit-acknowledgement-request.d.ts +25 -0
  99. package/dist/types/src/api-model/models/submit-acknowledgement-response.d.ts +31 -0
  100. package/dist/types/src/api-model/models/tax-details.d.ts +53 -0
  101. package/dist/types/src/api-model/models/tax-registration-details.d.ts +48 -0
  102. package/dist/types/src/api-model/models/transaction-id.d.ts +24 -0
  103. package/dist/types/src/client.d.ts +2 -2
  104. package/package.json +5 -5
  105. package/dist/cjs/src/api-model/api/update-inventory-api.js +0 -126
  106. package/dist/cjs/src/api-model/models/transaction-reference.js +0 -15
  107. package/dist/es/src/api-model/api/update-inventory-api.js +0 -116
  108. package/dist/es/src/api-model/models/transaction-reference.js +0 -14
  109. package/dist/types/src/api-model/api/update-inventory-api.d.ts +0 -93
  110. package/dist/types/src/api-model/models/inventory-update.d.ts +0 -38
  111. package/dist/types/src/api-model/models/item-details.d.ts +0 -43
  112. package/dist/types/src/api-model/models/submit-inventory-update-request.d.ts +0 -25
  113. package/dist/types/src/api-model/models/submit-inventory-update-response.d.ts +0 -31
  114. package/dist/types/src/api-model/models/transaction-reference.d.ts +0 -24
@@ -0,0 +1,227 @@
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 globalAxios from 'axios';
15
+ import { RequestArgs, BaseAPI } from '../base';
16
+ import { GetOrderResponse } from '../models';
17
+ import { GetOrdersResponse } from '../models';
18
+ import { SubmitAcknowledgementRequest } from '../models';
19
+ import { SubmitAcknowledgementResponse } from '../models';
20
+ /**
21
+ * VendorOrdersApi - axios parameter creator
22
+ * @export
23
+ */
24
+ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configuration) => {
25
+ /**
26
+ * 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).
27
+ * @param {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
28
+ * @param {*} [options] Override http request option.
29
+ * @throws {RequiredError}
30
+ */
31
+ getOrder: (purchaseOrderNumber: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * 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).
34
+ * @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.
35
+ * @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.
36
+ * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
37
+ * @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.
38
+ * @param {number} [limit] The limit to the number of purchase orders returned.
39
+ * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
40
+ * @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.
41
+ * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ 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>;
46
+ /**
47
+ * 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).
48
+ * @param {SubmitAcknowledgementRequest} body
49
+ * @param {*} [options] Override http request option.
50
+ * @throws {RequiredError}
51
+ */
52
+ submitAcknowledgement: (body: SubmitAcknowledgementRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53
+ };
54
+ /**
55
+ * VendorOrdersApi - functional programming interface
56
+ * @export
57
+ */
58
+ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
59
+ /**
60
+ * 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).
61
+ * @param {string} purchaseOrderNumber The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ getOrder(purchaseOrderNumber: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrderResponse>>;
66
+ /**
67
+ * 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).
68
+ * @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.
69
+ * @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.
70
+ * @param {string} [shipFromPartyId] The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
71
+ * @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.
72
+ * @param {number} [limit] The limit to the number of purchase orders returned.
73
+ * @param {'ASC' | 'DESC'} [sortOrder] Sort the list in ascending or descending order by order creation date.
74
+ * @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.
75
+ * @param {boolean} [includeDetails] When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ 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>>;
80
+ /**
81
+ * 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).
82
+ * @param {SubmitAcknowledgementRequest} body
83
+ * @param {*} [options] Override http request option.
84
+ * @throws {RequiredError}
85
+ */
86
+ submitAcknowledgement(body: SubmitAcknowledgementRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubmitAcknowledgementResponse>>;
87
+ };
88
+ /**
89
+ * VendorOrdersApi - factory interface
90
+ * @export
91
+ */
92
+ export declare const VendorOrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
93
+ /**
94
+ * 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).
95
+ * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ */
99
+ getOrder(requestParameters: VendorOrdersApiGetOrderRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrderResponse>;
100
+ /**
101
+ * 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).
102
+ * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ getOrders(requestParameters: VendorOrdersApiGetOrdersRequest, options?: AxiosRequestConfig): AxiosPromise<GetOrdersResponse>;
107
+ /**
108
+ * 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).
109
+ * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: AxiosRequestConfig): AxiosPromise<SubmitAcknowledgementResponse>;
114
+ };
115
+ /**
116
+ * Request parameters for getOrder operation in VendorOrdersApi.
117
+ * @export
118
+ * @interface VendorOrdersApiGetOrderRequest
119
+ */
120
+ export interface VendorOrdersApiGetOrderRequest {
121
+ /**
122
+ * The order identifier for the purchase order that you want. Formatting Notes: alpha-numeric code.
123
+ * @type {string}
124
+ * @memberof VendorOrdersApiGetOrder
125
+ */
126
+ readonly purchaseOrderNumber: string;
127
+ }
128
+ /**
129
+ * Request parameters for getOrders operation in VendorOrdersApi.
130
+ * @export
131
+ * @interface VendorOrdersApiGetOrdersRequest
132
+ */
133
+ export interface VendorOrdersApiGetOrdersRequest {
134
+ /**
135
+ * Purchase orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
136
+ * @type {string}
137
+ * @memberof VendorOrdersApiGetOrders
138
+ */
139
+ readonly createdAfter: string;
140
+ /**
141
+ * Purchase orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
142
+ * @type {string}
143
+ * @memberof VendorOrdersApiGetOrders
144
+ */
145
+ readonly createdBefore: string;
146
+ /**
147
+ * The vendor warehouse identifier for the fulfillment warehouse. If not specified, the result will contain orders for all warehouses.
148
+ * @type {string}
149
+ * @memberof VendorOrdersApiGetOrders
150
+ */
151
+ readonly shipFromPartyId?: string;
152
+ /**
153
+ * Returns only the purchase orders that match the specified status. If not specified, the result will contain orders that match any status.
154
+ * @type {'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED'}
155
+ * @memberof VendorOrdersApiGetOrders
156
+ */
157
+ readonly status?: 'NEW' | 'SHIPPED' | 'ACCEPTED' | 'CANCELLED';
158
+ /**
159
+ * The limit to the number of purchase orders returned.
160
+ * @type {number}
161
+ * @memberof VendorOrdersApiGetOrders
162
+ */
163
+ readonly limit?: number;
164
+ /**
165
+ * Sort the list in ascending or descending order by order creation date.
166
+ * @type {'ASC' | 'DESC'}
167
+ * @memberof VendorOrdersApiGetOrders
168
+ */
169
+ readonly sortOrder?: 'ASC' | 'DESC';
170
+ /**
171
+ * Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.
172
+ * @type {string}
173
+ * @memberof VendorOrdersApiGetOrders
174
+ */
175
+ readonly nextToken?: string;
176
+ /**
177
+ * When true, returns the complete purchase order details. Otherwise, only purchase order numbers are returned.
178
+ * @type {boolean}
179
+ * @memberof VendorOrdersApiGetOrders
180
+ */
181
+ readonly includeDetails?: boolean;
182
+ }
183
+ /**
184
+ * Request parameters for submitAcknowledgement operation in VendorOrdersApi.
185
+ * @export
186
+ * @interface VendorOrdersApiSubmitAcknowledgementRequest
187
+ */
188
+ export interface VendorOrdersApiSubmitAcknowledgementRequest {
189
+ /**
190
+ *
191
+ * @type {SubmitAcknowledgementRequest}
192
+ * @memberof VendorOrdersApiSubmitAcknowledgement
193
+ */
194
+ readonly body: SubmitAcknowledgementRequest;
195
+ }
196
+ /**
197
+ * VendorOrdersApi - object-oriented interface
198
+ * @export
199
+ * @class VendorOrdersApi
200
+ * @extends {BaseAPI}
201
+ */
202
+ export declare class VendorOrdersApi extends BaseAPI {
203
+ /**
204
+ * 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).
205
+ * @param {VendorOrdersApiGetOrderRequest} requestParameters Request parameters.
206
+ * @param {*} [options] Override http request option.
207
+ * @throws {RequiredError}
208
+ * @memberof VendorOrdersApi
209
+ */
210
+ getOrder(requestParameters: VendorOrdersApiGetOrderRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrderResponse, any>>;
211
+ /**
212
+ * 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).
213
+ * @param {VendorOrdersApiGetOrdersRequest} requestParameters Request parameters.
214
+ * @param {*} [options] Override http request option.
215
+ * @throws {RequiredError}
216
+ * @memberof VendorOrdersApi
217
+ */
218
+ getOrders(requestParameters: VendorOrdersApiGetOrdersRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetOrdersResponse, any>>;
219
+ /**
220
+ * 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).
221
+ * @param {VendorOrdersApiSubmitAcknowledgementRequest} requestParameters Request parameters.
222
+ * @param {*} [options] Override http request option.
223
+ * @throws {RequiredError}
224
+ * @memberof VendorOrdersApi
225
+ */
226
+ submitAcknowledgement(requestParameters: VendorOrdersApiSubmitAcknowledgementRequest, options?: AxiosRequestConfig): Promise<globalAxios.AxiosResponse<SubmitAcknowledgementResponse, any>>;
227
+ }
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -9,4 +9,4 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- export * from './api/update-inventory-api';
12
+ export * from './api/vendor-orders-api';
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -0,0 +1,30 @@
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
+ }
@@ -0,0 +1,90 @@
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. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
20
+ * @type {string}
21
+ * @memberof Address
22
+ */
23
+ 'name': string;
24
+ /**
25
+ * The attention name of the person at that address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
26
+ * @type {string}
27
+ * @memberof Address
28
+ */
29
+ 'attention'?: string;
30
+ /**
31
+ * First line of the address. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
32
+ * @type {string}
33
+ * @memberof Address
34
+ */
35
+ 'addressLine1': string;
36
+ /**
37
+ * Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
38
+ * @type {string}
39
+ * @memberof Address
40
+ */
41
+ 'addressLine2'?: string;
42
+ /**
43
+ * Additional address information, if required. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
44
+ * @type {string}
45
+ * @memberof Address
46
+ */
47
+ 'addressLine3'?: string;
48
+ /**
49
+ * The city where the person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
50
+ * @type {string}
51
+ * @memberof Address
52
+ */
53
+ 'city'?: string;
54
+ /**
55
+ * The county where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
56
+ * @type {string}
57
+ * @memberof Address
58
+ */
59
+ 'county'?: string;
60
+ /**
61
+ * The district where person, business or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
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. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
86
+ * @type {string}
87
+ * @memberof Address
88
+ */
89
+ 'phone'?: string;
90
+ }
@@ -0,0 +1,31 @@
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
+ }
@@ -0,0 +1,31 @@
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
+ }
@@ -0,0 +1,30 @@
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,8 +1,26 @@
1
- export * from './inventory-update';
2
- export * from './item-details';
1
+ export * from './acknowledgement-status';
2
+ export * from './address';
3
+ export * from './get-order-response';
4
+ export * from './get-orders-response';
5
+ export * from './gift-details';
3
6
  export * from './item-quantity';
4
7
  export * from './model-error';
8
+ export * from './money';
9
+ export * from './order';
10
+ export * from './order-acknowledgement-item';
11
+ export * from './order-details';
12
+ export * from './order-details-tax-total';
13
+ export * from './order-item';
14
+ export * from './order-item-acknowledgement';
15
+ export * from './order-item-tax-details';
16
+ export * from './order-list';
17
+ export * from './pagination';
5
18
  export * from './party-identification';
6
- export * from './submit-inventory-update-request';
7
- export * from './submit-inventory-update-response';
8
- export * from './transaction-reference';
19
+ export * from './scheduled-delivery-shipment';
20
+ export * from './shipment-dates';
21
+ export * from './shipment-details';
22
+ export * from './submit-acknowledgement-request';
23
+ export * from './submit-acknowledgement-response';
24
+ export * from './tax-details';
25
+ export * from './tax-registration-details';
26
+ export * from './transaction-id';
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -10,21 +10,25 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Details of item quantity.
13
+ * Details of quantity ordered.
14
14
  * @export
15
15
  * @interface ItemQuantity
16
16
  */
17
17
  export interface ItemQuantity {
18
18
  /**
19
- * Quantity of units available for a specific item.
19
+ * Acknowledged quantity. This value should not be zero.
20
20
  * @type {number}
21
21
  * @memberof ItemQuantity
22
22
  */
23
23
  'amount'?: number;
24
24
  /**
25
- * Unit of measure for the available quantity.
25
+ * Unit of measure for the acknowledged quantity.
26
26
  * @type {string}
27
27
  * @memberof ItemQuantity
28
28
  */
29
- 'unitOfMeasure': string;
29
+ 'unitOfMeasure'?: ItemQuantityUnitOfMeasureEnum;
30
30
  }
31
+ export declare const ItemQuantityUnitOfMeasureEnum: {
32
+ readonly Each: "Each";
33
+ };
34
+ export type ItemQuantityUnitOfMeasureEnum = typeof ItemQuantityUnitOfMeasureEnum[keyof typeof ItemQuantityUnitOfMeasureEnum];
@@ -1,6 +1,6 @@
1
1
  /**
2
- * Selling Partner API for Direct Fulfillment Inventory Updates
3
- * The Selling Partner API for Direct Fulfillment Inventory Updates provides programmatic access to a direct fulfillment vendor\'s inventory updates.
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
4
  *
5
5
  * The version of the OpenAPI document: v1
6
6
  *
@@ -0,0 +1,30 @@
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
+ }