@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1 2.6.2 → 2.7.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.
@@ -123,7 +123,7 @@ const VendorOrdersApiAxiosParamCreator = function (configuration) {
123
123
  },
124
124
  /**
125
125
  * 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).
126
- * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
126
+ * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order.
127
127
  * @param {*} [options] Override http request option.
128
128
  * @throws {RequiredError}
129
129
  */
@@ -193,7 +193,7 @@ const VendorOrdersApiFp = function (configuration) {
193
193
  },
194
194
  /**
195
195
  * 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).
196
- * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
196
+ * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order.
197
197
  * @param {*} [options] Override http request option.
198
198
  * @throws {RequiredError}
199
199
  */
@@ -117,7 +117,7 @@ export const VendorOrdersApiAxiosParamCreator = function (configuration) {
117
117
  },
118
118
  /**
119
119
  * 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).
120
- * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
120
+ * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order.
121
121
  * @param {*} [options] Override http request option.
122
122
  * @throws {RequiredError}
123
123
  */
@@ -186,7 +186,7 @@ export const VendorOrdersApiFp = function (configuration) {
186
186
  },
187
187
  /**
188
188
  * 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).
189
- * @param {SubmitAcknowledgementRequest} body The request body that contains the order acknowledgement.
189
+ * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order.
190
190
  * @param {*} [options] Override http request option.
191
191
  * @throws {RequiredError}
192
192
  */
@@ -45,7 +45,7 @@ export declare const VendorOrdersApiAxiosParamCreator: (configuration?: Configur
45
45
  getOrders: (createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: GetOrdersStatusEnum, limit?: number, sortOrder?: GetOrdersSortOrderEnum, nextToken?: string, includeDetails?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
46
  /**
47
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 The request body that contains the order acknowledgement.
48
+ * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order.
49
49
  * @param {*} [options] Override http request option.
50
50
  * @throws {RequiredError}
51
51
  */
@@ -79,7 +79,7 @@ export declare const VendorOrdersApiFp: (configuration?: Configuration) => {
79
79
  getOrders(createdAfter: string, createdBefore: string, shipFromPartyId?: string, status?: GetOrdersStatusEnum, limit?: number, sortOrder?: GetOrdersSortOrderEnum, nextToken?: string, includeDetails?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrdersResponse>>;
80
80
  /**
81
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 The request body that contains the order acknowledgement.
82
+ * @param {SubmitAcknowledgementRequest} body The request body containing the acknowledgement to an order.
83
83
  * @param {*} [options] Override http request option.
84
84
  * @throws {RequiredError}
85
85
  */
@@ -187,7 +187,7 @@ export interface VendorOrdersApiGetOrdersRequest {
187
187
  */
188
188
  export interface VendorOrdersApiSubmitAcknowledgementRequest {
189
189
  /**
190
- * The request body that contains the order acknowledgement.
190
+ * The request body containing the acknowledgement to an order.
191
191
  * @type {SubmitAcknowledgementRequest}
192
192
  * @memberof VendorOrdersApiSubmitAcknowledgement
193
193
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface Address {
18
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`.
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
20
  * @type {string}
21
21
  * @memberof Address
22
22
  */
@@ -46,19 +46,19 @@ export interface Address {
46
46
  */
47
47
  'addressLine3'?: string;
48
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`.
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
50
  * @type {string}
51
51
  * @memberof Address
52
52
  */
53
53
  'city'?: string;
54
54
  /**
55
- * The county where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
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
56
  * @type {string}
57
57
  * @memberof Address
58
58
  */
59
59
  'county'?: string;
60
60
  /**
61
- * The district where the person, business, or institution is located. For Amazon label only vendors, this field will have the value `xxxxx` within the object `shipToParty`.
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
62
  * @type {string}
63
63
  * @memberof Address
64
64
  */
@@ -82,7 +82,7 @@ export interface Address {
82
82
  */
83
83
  'countryCode': string;
84
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`.
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
86
  * @type {string}
87
87
  * @memberof Address
88
88
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { TaxDetails } from './tax-details';
13
13
  /**
14
- * The total tax object within the shipment that relates to the order.
14
+ * The total Tax object within shipment that relates to the order.
15
15
  * @export
16
16
  * @interface OrderDetailsTaxTotal
17
17
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { ItemQuantity } from './item-quantity';
13
13
  /**
14
- * Individual item details within the acknowledged order.
14
+ * Details of an individual item within the order being acknowledged.
15
15
  * @export
16
16
  * @interface OrderItemAcknowledgement
17
17
  */
@@ -15,7 +15,7 @@ import type { Money } from './money';
15
15
  import type { OrderItemTaxDetails } from './order-item-tax-details';
16
16
  import type { ScheduledDeliveryShipment } from './scheduled-delivery-shipment';
17
17
  /**
18
- * An order item.
18
+ * An item within an order
19
19
  * @export
20
20
  * @interface OrderItem
21
21
  */
@@ -12,7 +12,7 @@
12
12
  import type { Order } from './order';
13
13
  import type { Pagination } from './pagination';
14
14
  /**
15
- * A purchase orders list returned as a response.
15
+ * A list of purchase orders returned as response.
16
16
  * @export
17
17
  * @interface OrderList
18
18
  */
@@ -24,7 +24,7 @@ export interface OrderList {
24
24
  */
25
25
  'pagination'?: Pagination;
26
26
  /**
27
- * Represents a purchase order within the `OrderList`.
27
+ * Represents a purchase order within the OrderList.
28
28
  * @type {Array<Order>}
29
29
  * @memberof OrderList
30
30
  */
@@ -12,7 +12,7 @@
12
12
  import type { Address } from './address';
13
13
  import type { TaxRegistrationDetails } from './tax-registration-details';
14
14
  /**
15
- * Name, address, and tax details of a party.
15
+ * Name, address and tax details of a party.
16
16
  * @export
17
17
  * @interface PartyIdentification
18
18
  */
@@ -11,7 +11,7 @@
11
11
  */
12
12
  import type { Money } from './money';
13
13
  /**
14
- * The order\'s tax details.
14
+ * The tax details related to the order.
15
15
  * @export
16
16
  * @interface TaxDetails
17
17
  */
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  /**
13
- * Response that contains the transaction ID.
13
+ * Response containing the transaction ID.
14
14
  * @export
15
15
  * @interface TransactionId
16
16
  */
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "@sp-api-sdk/vendor-direct-fulfillment-orders-api-v1",
3
3
  "author": "Bertrand Marron <bertrand@bizon.solutions>",
4
4
  "description": "The Selling Partner API for Direct Fulfillment Orders provides programmatic access to a direct fulfillment vendor's order data.",
5
- "version": "2.6.2",
5
+ "version": "2.7.0",
6
6
  "main": "dist/cjs/index.js",
7
7
  "module": "dist/es/index.js",
8
8
  "types": "dist/types/index.d.ts",
@@ -40,5 +40,5 @@
40
40
  "sp sdk",
41
41
  "vendor direct fulfillment orders api"
42
42
  ],
43
- "gitHead": "cde6991012a79a8483a72ecb1c71d92087f390a6"
43
+ "gitHead": "709bf500f3a6a5851b204903c5a0ea2afff80d9a"
44
44
  }