@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 2.5.1 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/vendor-shipping-api.js +58 -58
- package/dist/es/api-model/api/vendor-shipping-api.js +58 -58
- package/dist/types/api-model/api/vendor-shipping-api.d.ts +69 -69
- package/dist/types/api-model/models/customer-invoice-list.d.ts +1 -1
- package/dist/types/api-model/models/customer-invoice.d.ts +1 -1
- package/dist/types/api-model/models/get-customer-invoice-response.d.ts +1 -1
- package/dist/types/api-model/models/get-customer-invoices-response.d.ts +1 -1
- package/dist/types/api-model/models/get-packing-slip-list-response.d.ts +1 -1
- package/dist/types/api-model/models/get-shipping-label-list-response.d.ts +1 -1
- package/dist/types/api-model/models/get-shipping-label-response.d.ts +1 -1
- package/dist/types/api-model/models/item.d.ts +1 -1
- package/dist/types/api-model/models/label-data.d.ts +1 -1
- package/dist/types/api-model/models/packed-item.d.ts +1 -1
- package/dist/types/api-model/models/pagination.d.ts +1 -1
- package/dist/types/api-model/models/status-update-details-shipment-schedule.d.ts +3 -3
- package/dist/types/api-model/models/status-update-details.d.ts +4 -4
- package/dist/types/api-model/models/submit-shipment-confirmations-request.d.ts +2 -2
- package/dist/types/api-model/models/submit-shipment-confirmations-response.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipment-status-updates-request.d.ts +2 -2
- package/dist/types/api-model/models/submit-shipment-status-updates-response.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipping-labels-request.d.ts +1 -1
- package/dist/types/api-model/models/submit-shipping-labels-response.d.ts +1 -1
- package/package.json +3 -3
|
@@ -24,7 +24,7 @@ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
|
|
|
24
24
|
export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
|
-
* Returns a customer invoice based on the
|
|
27
|
+
* Returns a customer invoice based on 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).
|
|
28
28
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
29
29
|
* @param {*} [options] Override http request option.
|
|
30
30
|
* @throws {RequiredError}
|
|
@@ -52,10 +52,10 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
52
52
|
};
|
|
53
53
|
},
|
|
54
54
|
/**
|
|
55
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
56
|
-
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in
|
|
57
|
-
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in
|
|
58
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
55
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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).
|
|
56
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
57
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
58
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
59
59
|
* @param {number} [limit] The limit to the number of records returned
|
|
60
60
|
* @param {GetCustomerInvoicesSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
61
61
|
* @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.
|
|
@@ -108,8 +108,8 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
108
108
|
};
|
|
109
109
|
},
|
|
110
110
|
/**
|
|
111
|
-
* Returns a packing slip based on the
|
|
112
|
-
* @param {string} purchaseOrderNumber The
|
|
111
|
+
* Returns a packing slip based on 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).
|
|
112
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
@@ -136,10 +136,10 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
136
136
|
};
|
|
137
137
|
},
|
|
138
138
|
/**
|
|
139
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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,
|
|
140
|
-
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in
|
|
141
|
-
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in
|
|
142
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
139
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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).
|
|
140
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
141
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
142
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
143
143
|
* @param {number} [limit] The limit to the number of records returned
|
|
144
144
|
* @param {GetPackingSlipsSortOrderEnum} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
145
145
|
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -192,8 +192,8 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
192
192
|
};
|
|
193
193
|
},
|
|
194
194
|
/**
|
|
195
|
-
* Returns a shipping label for the
|
|
196
|
-
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same
|
|
195
|
+
* Returns a shipping label 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).
|
|
196
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
197
197
|
* @param {*} [options] Override http request option.
|
|
198
198
|
* @throws {RequiredError}
|
|
199
199
|
*/
|
|
@@ -220,10 +220,10 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
220
220
|
};
|
|
221
221
|
},
|
|
222
222
|
/**
|
|
223
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
224
|
-
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
225
|
-
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
226
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
223
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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).
|
|
224
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
225
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
226
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
227
227
|
* @param {number} [limit] The limit to the number of records returned.
|
|
228
228
|
* @param {GetShippingLabelsSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
229
229
|
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -276,7 +276,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
276
276
|
};
|
|
277
277
|
},
|
|
278
278
|
/**
|
|
279
|
-
* Submits one or more shipment confirmations for vendor 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,
|
|
279
|
+
* Submits one or more shipment confirmations for vendor 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).
|
|
280
280
|
* @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data.
|
|
281
281
|
* @param {*} [options] Override http request option.
|
|
282
282
|
* @throws {RequiredError}
|
|
@@ -305,7 +305,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
305
305
|
};
|
|
306
306
|
},
|
|
307
307
|
/**
|
|
308
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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,
|
|
308
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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).
|
|
309
309
|
* @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data.
|
|
310
310
|
* @param {*} [options] Override http request option.
|
|
311
311
|
* @throws {RequiredError}
|
|
@@ -334,7 +334,7 @@ export const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
334
334
|
};
|
|
335
335
|
},
|
|
336
336
|
/**
|
|
337
|
-
* Creates a shipping label for a purchase order and returns a
|
|
337
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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).
|
|
338
338
|
* @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data.
|
|
339
339
|
* @param {*} [options] Override http request option.
|
|
340
340
|
* @throws {RequiredError}
|
|
@@ -372,7 +372,7 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
372
372
|
const localVarAxiosParamCreator = VendorShippingApiAxiosParamCreator(configuration);
|
|
373
373
|
return {
|
|
374
374
|
/**
|
|
375
|
-
* Returns a customer invoice based on the
|
|
375
|
+
* Returns a customer invoice based on 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).
|
|
376
376
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
377
377
|
* @param {*} [options] Override http request option.
|
|
378
378
|
* @throws {RequiredError}
|
|
@@ -384,10 +384,10 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
384
384
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
385
385
|
},
|
|
386
386
|
/**
|
|
387
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
388
|
-
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in
|
|
389
|
-
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in
|
|
390
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
387
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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).
|
|
388
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
389
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
390
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
391
391
|
* @param {number} [limit] The limit to the number of records returned
|
|
392
392
|
* @param {GetCustomerInvoicesSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
393
393
|
* @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.
|
|
@@ -401,8 +401,8 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
401
401
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
402
402
|
},
|
|
403
403
|
/**
|
|
404
|
-
* Returns a packing slip based on the
|
|
405
|
-
* @param {string} purchaseOrderNumber The
|
|
404
|
+
* Returns a packing slip based on 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).
|
|
405
|
+
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
406
406
|
* @param {*} [options] Override http request option.
|
|
407
407
|
* @throws {RequiredError}
|
|
408
408
|
*/
|
|
@@ -413,10 +413,10 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
413
413
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
414
414
|
},
|
|
415
415
|
/**
|
|
416
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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,
|
|
417
|
-
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in
|
|
418
|
-
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in
|
|
419
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
416
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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).
|
|
417
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
418
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
419
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
420
420
|
* @param {number} [limit] The limit to the number of records returned
|
|
421
421
|
* @param {GetPackingSlipsSortOrderEnum} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
422
422
|
* @param {string} [nextToken] Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -430,8 +430,8 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
430
430
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
|
-
* Returns a shipping label for the
|
|
434
|
-
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same
|
|
433
|
+
* Returns a shipping label 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).
|
|
434
|
+
* @param {string} purchaseOrderNumber The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
436
436
|
* @throws {RequiredError}
|
|
437
437
|
*/
|
|
@@ -442,10 +442,10 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
442
442
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
443
443
|
},
|
|
444
444
|
/**
|
|
445
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
446
|
-
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
447
|
-
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
448
|
-
* @param {string} [shipFromPartyId] The vendor
|
|
445
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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).
|
|
446
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
447
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.
|
|
448
|
+
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
449
449
|
* @param {number} [limit] The limit to the number of records returned.
|
|
450
450
|
* @param {GetShippingLabelsSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
451
451
|
* @param {string} [nextToken] Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.
|
|
@@ -459,7 +459,7 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
459
459
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
460
460
|
},
|
|
461
461
|
/**
|
|
462
|
-
* Submits one or more shipment confirmations for vendor 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,
|
|
462
|
+
* Submits one or more shipment confirmations for vendor 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).
|
|
463
463
|
* @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data.
|
|
464
464
|
* @param {*} [options] Override http request option.
|
|
465
465
|
* @throws {RequiredError}
|
|
@@ -471,7 +471,7 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
471
471
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
472
472
|
},
|
|
473
473
|
/**
|
|
474
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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,
|
|
474
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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).
|
|
475
475
|
* @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data.
|
|
476
476
|
* @param {*} [options] Override http request option.
|
|
477
477
|
* @throws {RequiredError}
|
|
@@ -483,7 +483,7 @@ export const VendorShippingApiFp = function (configuration) {
|
|
|
483
483
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
484
484
|
},
|
|
485
485
|
/**
|
|
486
|
-
* Creates a shipping label for a purchase order and returns a
|
|
486
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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).
|
|
487
487
|
* @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data.
|
|
488
488
|
* @param {*} [options] Override http request option.
|
|
489
489
|
* @throws {RequiredError}
|
|
@@ -504,7 +504,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
504
504
|
const localVarFp = VendorShippingApiFp(configuration);
|
|
505
505
|
return {
|
|
506
506
|
/**
|
|
507
|
-
* Returns a customer invoice based on the
|
|
507
|
+
* Returns a customer invoice based on 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).
|
|
508
508
|
* @param {VendorShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
509
509
|
* @param {*} [options] Override http request option.
|
|
510
510
|
* @throws {RequiredError}
|
|
@@ -513,7 +513,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
513
513
|
return localVarFp.getCustomerInvoice(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
514
514
|
},
|
|
515
515
|
/**
|
|
516
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
516
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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).
|
|
517
517
|
* @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
518
518
|
* @param {*} [options] Override http request option.
|
|
519
519
|
* @throws {RequiredError}
|
|
@@ -522,7 +522,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
522
522
|
return localVarFp.getCustomerInvoices(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
523
523
|
},
|
|
524
524
|
/**
|
|
525
|
-
* Returns a packing slip based on the
|
|
525
|
+
* Returns a packing slip based on 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).
|
|
526
526
|
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
527
527
|
* @param {*} [options] Override http request option.
|
|
528
528
|
* @throws {RequiredError}
|
|
@@ -531,7 +531,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
531
531
|
return localVarFp.getPackingSlip(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
532
532
|
},
|
|
533
533
|
/**
|
|
534
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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,
|
|
534
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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).
|
|
535
535
|
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
536
536
|
* @param {*} [options] Override http request option.
|
|
537
537
|
* @throws {RequiredError}
|
|
@@ -540,7 +540,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
540
540
|
return localVarFp.getPackingSlips(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
541
541
|
},
|
|
542
542
|
/**
|
|
543
|
-
* Returns a shipping label for the
|
|
543
|
+
* Returns a shipping label 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).
|
|
544
544
|
* @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
545
545
|
* @param {*} [options] Override http request option.
|
|
546
546
|
* @throws {RequiredError}
|
|
@@ -549,7 +549,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
549
549
|
return localVarFp.getShippingLabel(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
550
550
|
},
|
|
551
551
|
/**
|
|
552
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
552
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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).
|
|
553
553
|
* @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
554
554
|
* @param {*} [options] Override http request option.
|
|
555
555
|
* @throws {RequiredError}
|
|
@@ -558,7 +558,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
558
558
|
return localVarFp.getShippingLabels(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
559
559
|
},
|
|
560
560
|
/**
|
|
561
|
-
* Submits one or more shipment confirmations for vendor 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,
|
|
561
|
+
* Submits one or more shipment confirmations for vendor 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).
|
|
562
562
|
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
563
563
|
* @param {*} [options] Override http request option.
|
|
564
564
|
* @throws {RequiredError}
|
|
@@ -567,7 +567,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
567
567
|
return localVarFp.submitShipmentConfirmations(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
568
568
|
},
|
|
569
569
|
/**
|
|
570
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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,
|
|
570
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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).
|
|
571
571
|
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
572
572
|
* @param {*} [options] Override http request option.
|
|
573
573
|
* @throws {RequiredError}
|
|
@@ -576,7 +576,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
576
576
|
return localVarFp.submitShipmentStatusUpdates(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
577
577
|
},
|
|
578
578
|
/**
|
|
579
|
-
* Creates a shipping label for a purchase order and returns a
|
|
579
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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).
|
|
580
580
|
* @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
581
581
|
* @param {*} [options] Override http request option.
|
|
582
582
|
* @throws {RequiredError}
|
|
@@ -594,7 +594,7 @@ export const VendorShippingApiFactory = function (configuration, basePath, axios
|
|
|
594
594
|
*/
|
|
595
595
|
export class VendorShippingApi extends BaseAPI {
|
|
596
596
|
/**
|
|
597
|
-
* Returns a customer invoice based on the
|
|
597
|
+
* Returns a customer invoice based on 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).
|
|
598
598
|
* @param {VendorShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
599
599
|
* @param {*} [options] Override http request option.
|
|
600
600
|
* @throws {RequiredError}
|
|
@@ -604,7 +604,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
604
604
|
return VendorShippingApiFp(this.configuration).getCustomerInvoice(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
605
605
|
}
|
|
606
606
|
/**
|
|
607
|
-
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the
|
|
607
|
+
* Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days. **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).
|
|
608
608
|
* @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
609
609
|
* @param {*} [options] Override http request option.
|
|
610
610
|
* @throws {RequiredError}
|
|
@@ -614,7 +614,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
614
614
|
return VendorShippingApiFp(this.configuration).getCustomerInvoices(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
615
615
|
}
|
|
616
616
|
/**
|
|
617
|
-
* Returns a packing slip based on the
|
|
617
|
+
* Returns a packing slip based on 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).
|
|
618
618
|
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
619
619
|
* @param {*} [options] Override http request option.
|
|
620
620
|
* @throws {RequiredError}
|
|
@@ -624,7 +624,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
624
624
|
return VendorShippingApiFp(this.configuration).getPackingSlip(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
625
625
|
}
|
|
626
626
|
/**
|
|
627
|
-
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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,
|
|
627
|
+
* Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days. **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).
|
|
628
628
|
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
629
629
|
* @param {*} [options] Override http request option.
|
|
630
630
|
* @throws {RequiredError}
|
|
@@ -634,7 +634,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
634
634
|
return VendorShippingApiFp(this.configuration).getPackingSlips(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
635
635
|
}
|
|
636
636
|
/**
|
|
637
|
-
* Returns a shipping label for the
|
|
637
|
+
* Returns a shipping label 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).
|
|
638
638
|
* @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
639
639
|
* @param {*} [options] Override http request option.
|
|
640
640
|
* @throws {RequiredError}
|
|
@@ -644,7 +644,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
644
644
|
return VendorShippingApiFp(this.configuration).getShippingLabel(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
645
645
|
}
|
|
646
646
|
/**
|
|
647
|
-
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the
|
|
647
|
+
* Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days. **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).
|
|
648
648
|
* @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
649
649
|
* @param {*} [options] Override http request option.
|
|
650
650
|
* @throws {RequiredError}
|
|
@@ -654,7 +654,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
654
654
|
return VendorShippingApiFp(this.configuration).getShippingLabels(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
655
655
|
}
|
|
656
656
|
/**
|
|
657
|
-
* Submits one or more shipment confirmations for vendor 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,
|
|
657
|
+
* Submits one or more shipment confirmations for vendor 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).
|
|
658
658
|
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
659
659
|
* @param {*} [options] Override http request option.
|
|
660
660
|
* @throws {RequiredError}
|
|
@@ -664,7 +664,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
664
664
|
return VendorShippingApiFp(this.configuration).submitShipmentConfirmations(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
665
665
|
}
|
|
666
666
|
/**
|
|
667
|
-
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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,
|
|
667
|
+
* This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility. **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).
|
|
668
668
|
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
669
669
|
* @param {*} [options] Override http request option.
|
|
670
670
|
* @throws {RequiredError}
|
|
@@ -674,7 +674,7 @@ export class VendorShippingApi extends BaseAPI {
|
|
|
674
674
|
return VendorShippingApiFp(this.configuration).submitShipmentStatusUpdates(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
675
675
|
}
|
|
676
676
|
/**
|
|
677
|
-
* Creates a shipping label for a purchase order and returns a
|
|
677
|
+
* Creates a shipping label for a purchase order and returns a transactionId for reference. **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).
|
|
678
678
|
* @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
679
679
|
* @param {*} [options] Override http request option.
|
|
680
680
|
* @throws {RequiredError}
|