@sp-api-sdk/vendor-direct-fulfillment-shipping-api-v1 2.2.1 → 2.3.1
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/src/api-model/api/vendor-shipping-api.js +64 -64
- package/dist/es/src/api-model/api/vendor-shipping-api.js +64 -64
- package/dist/types/src/api-model/api/vendor-shipping-api.d.ts +78 -78
- package/dist/types/src/api-model/common.d.ts +0 -1
- package/dist/types/src/api-model/models/container.d.ts +1 -1
- package/dist/types/src/api-model/models/customer-invoice-list.d.ts +2 -2
- package/dist/types/src/api-model/models/customer-invoice.d.ts +2 -2
- package/dist/types/src/api-model/models/get-customer-invoice-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-customer-invoices-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-packing-slip-list-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-packing-slip-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-shipping-label-list-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-shipping-label-response.d.ts +1 -1
- package/dist/types/src/api-model/models/item.d.ts +1 -1
- package/dist/types/src/api-model/models/label-data.d.ts +1 -1
- package/dist/types/src/api-model/models/packed-item.d.ts +2 -2
- package/dist/types/src/api-model/models/packing-slip-list.d.ts +1 -1
- package/dist/types/src/api-model/models/pagination.d.ts +2 -2
- package/dist/types/src/api-model/models/party-identification.d.ts +1 -1
- package/dist/types/src/api-model/models/shipment-confirmation.d.ts +1 -1
- package/dist/types/src/api-model/models/shipment-status-update.d.ts +1 -1
- package/dist/types/src/api-model/models/shipping-label-list.d.ts +2 -2
- package/dist/types/src/api-model/models/shipping-label-request.d.ts +1 -1
- package/dist/types/src/api-model/models/shipping-label.d.ts +1 -1
- package/dist/types/src/api-model/models/status-update-details-shipment-schedule.d.ts +4 -4
- package/dist/types/src/api-model/models/status-update-details.d.ts +4 -4
- package/dist/types/src/api-model/models/submit-shipment-confirmations-request.d.ts +2 -2
- package/dist/types/src/api-model/models/submit-shipment-confirmations-response.d.ts +1 -1
- package/dist/types/src/api-model/models/submit-shipment-status-updates-request.d.ts +2 -2
- package/dist/types/src/api-model/models/submit-shipment-status-updates-response.d.ts +1 -1
- package/dist/types/src/api-model/models/submit-shipping-labels-request.d.ts +2 -2
- package/dist/types/src/api-model/models/submit-shipping-labels-response.d.ts +1 -1
- package/dist/types/src/api-model/models/transaction-reference.d.ts +1 -1
- package/package.json +3 -3
|
@@ -30,7 +30,7 @@ const base_1 = require("../base");
|
|
|
30
30
|
const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* 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,
|
|
33
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
34
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
36
36
|
* @throws {RequiredError}
|
|
@@ -58,10 +58,10 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
58
58
|
};
|
|
59
59
|
},
|
|
60
60
|
/**
|
|
61
|
-
* 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,
|
|
62
|
-
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in
|
|
63
|
-
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in
|
|
64
|
-
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
61
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
63
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
64
|
+
* @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
65
65
|
* @param {number} [limit] The limit to the number of records returned
|
|
66
66
|
* @param {GetCustomerInvoicesSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
67
67
|
* @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.
|
|
@@ -114,8 +114,8 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
114
114
|
};
|
|
115
115
|
},
|
|
116
116
|
/**
|
|
117
|
-
* 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,
|
|
118
|
-
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
117
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
118
|
+
* @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip you want.
|
|
119
119
|
* @param {*} [options] Override http request option.
|
|
120
120
|
* @throws {RequiredError}
|
|
121
121
|
*/
|
|
@@ -142,10 +142,10 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
};
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* 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,
|
|
146
|
-
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in
|
|
147
|
-
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in
|
|
148
|
-
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
145
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
146
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
147
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
148
|
+
* @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
149
149
|
* @param {number} [limit] The limit to the number of records returned
|
|
150
150
|
* @param {GetPackingSlipsSortOrderEnum} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
151
151
|
* @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.
|
|
@@ -198,8 +198,8 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
198
198
|
};
|
|
199
199
|
},
|
|
200
200
|
/**
|
|
201
|
-
* 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,
|
|
202
|
-
* @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.
|
|
201
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
202
|
+
* @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.
|
|
203
203
|
* @param {*} [options] Override http request option.
|
|
204
204
|
* @throws {RequiredError}
|
|
205
205
|
*/
|
|
@@ -226,10 +226,10 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
226
226
|
};
|
|
227
227
|
},
|
|
228
228
|
/**
|
|
229
|
-
* 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,
|
|
230
|
-
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
231
|
-
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
232
|
-
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
229
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
230
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
231
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
232
|
+
* @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
233
233
|
* @param {number} [limit] The limit to the number of records returned.
|
|
234
234
|
* @param {GetShippingLabelsSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
235
235
|
* @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.
|
|
@@ -282,8 +282,8 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
282
282
|
};
|
|
283
283
|
},
|
|
284
284
|
/**
|
|
285
|
-
* 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,
|
|
286
|
-
* @param {SubmitShipmentConfirmationsRequest} body
|
|
285
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
286
|
+
* @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data.
|
|
287
287
|
* @param {*} [options] Override http request option.
|
|
288
288
|
* @throws {RequiredError}
|
|
289
289
|
*/
|
|
@@ -311,8 +311,8 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
311
311
|
};
|
|
312
312
|
},
|
|
313
313
|
/**
|
|
314
|
-
* 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,
|
|
315
|
-
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
314
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
315
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data.
|
|
316
316
|
* @param {*} [options] Override http request option.
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
@@ -340,8 +340,8 @@ const VendorShippingApiAxiosParamCreator = function (configuration) {
|
|
|
340
340
|
};
|
|
341
341
|
},
|
|
342
342
|
/**
|
|
343
|
-
* 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,
|
|
344
|
-
* @param {SubmitShippingLabelsRequest} body
|
|
343
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
344
|
+
* @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data.
|
|
345
345
|
* @param {*} [options] Override http request option.
|
|
346
346
|
* @throws {RequiredError}
|
|
347
347
|
*/
|
|
@@ -379,7 +379,7 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
379
379
|
const localVarAxiosParamCreator = (0, exports.VendorShippingApiAxiosParamCreator)(configuration);
|
|
380
380
|
return {
|
|
381
381
|
/**
|
|
382
|
-
* 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,
|
|
382
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
383
383
|
* @param {string} purchaseOrderNumber Purchase order number of the shipment for which to return the invoice.
|
|
384
384
|
* @param {*} [options] Override http request option.
|
|
385
385
|
* @throws {RequiredError}
|
|
@@ -391,10 +391,10 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
391
391
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
392
392
|
},
|
|
393
393
|
/**
|
|
394
|
-
* 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,
|
|
395
|
-
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in
|
|
396
|
-
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in
|
|
397
|
-
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
394
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
395
|
+
* @param {string} createdAfter Orders that became available after this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
396
|
+
* @param {string} createdBefore Orders that became available before this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
397
|
+
* @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
398
398
|
* @param {number} [limit] The limit to the number of records returned
|
|
399
399
|
* @param {GetCustomerInvoicesSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
400
400
|
* @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.
|
|
@@ -408,8 +408,8 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
408
408
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
409
409
|
},
|
|
410
410
|
/**
|
|
411
|
-
* 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,
|
|
412
|
-
* @param {string} purchaseOrderNumber The purchaseOrderNumber for the packing slip you want.
|
|
411
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
412
|
+
* @param {string} purchaseOrderNumber The `purchaseOrderNumber` for the packing slip you want.
|
|
413
413
|
* @param {*} [options] Override http request option.
|
|
414
414
|
* @throws {RequiredError}
|
|
415
415
|
*/
|
|
@@ -420,10 +420,10 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
420
420
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
421
421
|
},
|
|
422
422
|
/**
|
|
423
|
-
* 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,
|
|
424
|
-
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in
|
|
425
|
-
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in
|
|
426
|
-
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
423
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
424
|
+
* @param {string} createdAfter Packing slips that became available after this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
425
|
+
* @param {string} createdBefore Packing slips that became available before this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
426
|
+
* @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified the result will contain orders for all warehouses.
|
|
427
427
|
* @param {number} [limit] The limit to the number of records returned
|
|
428
428
|
* @param {GetPackingSlipsSortOrderEnum} [sortOrder] Sort ASC or DESC by packing slip creation date.
|
|
429
429
|
* @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.
|
|
@@ -437,8 +437,8 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
437
437
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
438
438
|
},
|
|
439
439
|
/**
|
|
440
|
-
* 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,
|
|
441
|
-
* @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.
|
|
440
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
441
|
+
* @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.
|
|
442
442
|
* @param {*} [options] Override http request option.
|
|
443
443
|
* @throws {RequiredError}
|
|
444
444
|
*/
|
|
@@ -449,10 +449,10 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
449
449
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
452
|
-
* 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,
|
|
453
|
-
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in
|
|
454
|
-
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in
|
|
455
|
-
* @param {string} [shipFromPartyId] The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
452
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
453
|
+
* @param {string} createdAfter Shipping labels that became available after this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
454
|
+
* @param {string} createdBefore Shipping labels that became available before this date and time will be included in the result. Must be in <a href=\'https://developer-docs.amazon.com/sp-api/docs/iso-8601\'>ISO 8601</a> date/time format.
|
|
455
|
+
* @param {string} [shipFromPartyId] The vendor `warehouseId` for order fulfillment. If not specified, the result will contain orders for all warehouses.
|
|
456
456
|
* @param {number} [limit] The limit to the number of records returned.
|
|
457
457
|
* @param {GetShippingLabelsSortOrderEnum} [sortOrder] Sort ASC or DESC by order creation date.
|
|
458
458
|
* @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.
|
|
@@ -466,8 +466,8 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
466
466
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
467
467
|
},
|
|
468
468
|
/**
|
|
469
|
-
* 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,
|
|
470
|
-
* @param {SubmitShipmentConfirmationsRequest} body
|
|
469
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
470
|
+
* @param {SubmitShipmentConfirmationsRequest} body Request body containing the shipment confirmations data.
|
|
471
471
|
* @param {*} [options] Override http request option.
|
|
472
472
|
* @throws {RequiredError}
|
|
473
473
|
*/
|
|
@@ -478,8 +478,8 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
478
478
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
479
479
|
},
|
|
480
480
|
/**
|
|
481
|
-
* 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,
|
|
482
|
-
* @param {SubmitShipmentStatusUpdatesRequest} body
|
|
481
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
482
|
+
* @param {SubmitShipmentStatusUpdatesRequest} body Request body containing the shipment status update data.
|
|
483
483
|
* @param {*} [options] Override http request option.
|
|
484
484
|
* @throws {RequiredError}
|
|
485
485
|
*/
|
|
@@ -490,8 +490,8 @@ const VendorShippingApiFp = function (configuration) {
|
|
|
490
490
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
491
491
|
},
|
|
492
492
|
/**
|
|
493
|
-
* 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,
|
|
494
|
-
* @param {SubmitShippingLabelsRequest} body
|
|
493
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
494
|
+
* @param {SubmitShippingLabelsRequest} body Request body containing one or more shipping labels data.
|
|
495
495
|
* @param {*} [options] Override http request option.
|
|
496
496
|
* @throws {RequiredError}
|
|
497
497
|
*/
|
|
@@ -512,7 +512,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
512
512
|
const localVarFp = (0, exports.VendorShippingApiFp)(configuration);
|
|
513
513
|
return {
|
|
514
514
|
/**
|
|
515
|
-
* 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,
|
|
515
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
516
516
|
* @param {VendorShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
517
517
|
* @param {*} [options] Override http request option.
|
|
518
518
|
* @throws {RequiredError}
|
|
@@ -521,7 +521,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
521
521
|
return localVarFp.getCustomerInvoice(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
522
522
|
},
|
|
523
523
|
/**
|
|
524
|
-
* 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,
|
|
524
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
525
525
|
* @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
526
526
|
* @param {*} [options] Override http request option.
|
|
527
527
|
* @throws {RequiredError}
|
|
@@ -530,7 +530,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
530
530
|
return localVarFp.getCustomerInvoices(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
531
531
|
},
|
|
532
532
|
/**
|
|
533
|
-
* 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,
|
|
533
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
534
534
|
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
535
535
|
* @param {*} [options] Override http request option.
|
|
536
536
|
* @throws {RequiredError}
|
|
@@ -539,7 +539,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
539
539
|
return localVarFp.getPackingSlip(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
540
540
|
},
|
|
541
541
|
/**
|
|
542
|
-
* 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,
|
|
542
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
543
543
|
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
544
544
|
* @param {*} [options] Override http request option.
|
|
545
545
|
* @throws {RequiredError}
|
|
@@ -548,7 +548,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
548
548
|
return localVarFp.getPackingSlips(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
549
549
|
},
|
|
550
550
|
/**
|
|
551
|
-
* 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,
|
|
551
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
552
552
|
* @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
553
553
|
* @param {*} [options] Override http request option.
|
|
554
554
|
* @throws {RequiredError}
|
|
@@ -557,7 +557,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
557
557
|
return localVarFp.getShippingLabel(requestParameters.purchaseOrderNumber, options).then((request) => request(axios, basePath));
|
|
558
558
|
},
|
|
559
559
|
/**
|
|
560
|
-
* 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,
|
|
560
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
561
561
|
* @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
562
562
|
* @param {*} [options] Override http request option.
|
|
563
563
|
* @throws {RequiredError}
|
|
@@ -566,7 +566,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
566
566
|
return localVarFp.getShippingLabels(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
567
567
|
},
|
|
568
568
|
/**
|
|
569
|
-
* 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,
|
|
569
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
570
570
|
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
571
571
|
* @param {*} [options] Override http request option.
|
|
572
572
|
* @throws {RequiredError}
|
|
@@ -575,7 +575,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
575
575
|
return localVarFp.submitShipmentConfirmations(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
576
576
|
},
|
|
577
577
|
/**
|
|
578
|
-
* 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,
|
|
578
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
579
579
|
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
580
580
|
* @param {*} [options] Override http request option.
|
|
581
581
|
* @throws {RequiredError}
|
|
@@ -584,7 +584,7 @@ const VendorShippingApiFactory = function (configuration, basePath, axios) {
|
|
|
584
584
|
return localVarFp.submitShipmentStatusUpdates(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
585
585
|
},
|
|
586
586
|
/**
|
|
587
|
-
* 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,
|
|
587
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
588
588
|
* @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
589
589
|
* @param {*} [options] Override http request option.
|
|
590
590
|
* @throws {RequiredError}
|
|
@@ -603,7 +603,7 @@ exports.VendorShippingApiFactory = VendorShippingApiFactory;
|
|
|
603
603
|
*/
|
|
604
604
|
class VendorShippingApi extends base_1.BaseAPI {
|
|
605
605
|
/**
|
|
606
|
-
* 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,
|
|
606
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
607
607
|
* @param {VendorShippingApiGetCustomerInvoiceRequest} requestParameters Request parameters.
|
|
608
608
|
* @param {*} [options] Override http request option.
|
|
609
609
|
* @throws {RequiredError}
|
|
@@ -613,7 +613,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
613
613
|
return (0, exports.VendorShippingApiFp)(this.configuration).getCustomerInvoice(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
614
614
|
}
|
|
615
615
|
/**
|
|
616
|
-
* 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,
|
|
616
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
617
617
|
* @param {VendorShippingApiGetCustomerInvoicesRequest} requestParameters Request parameters.
|
|
618
618
|
* @param {*} [options] Override http request option.
|
|
619
619
|
* @throws {RequiredError}
|
|
@@ -623,7 +623,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
623
623
|
return (0, exports.VendorShippingApiFp)(this.configuration).getCustomerInvoices(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
624
624
|
}
|
|
625
625
|
/**
|
|
626
|
-
* 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,
|
|
626
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
627
627
|
* @param {VendorShippingApiGetPackingSlipRequest} requestParameters Request parameters.
|
|
628
628
|
* @param {*} [options] Override http request option.
|
|
629
629
|
* @throws {RequiredError}
|
|
@@ -633,7 +633,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
633
633
|
return (0, exports.VendorShippingApiFp)(this.configuration).getPackingSlip(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
634
634
|
}
|
|
635
635
|
/**
|
|
636
|
-
* 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,
|
|
636
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
637
637
|
* @param {VendorShippingApiGetPackingSlipsRequest} requestParameters Request parameters.
|
|
638
638
|
* @param {*} [options] Override http request option.
|
|
639
639
|
* @throws {RequiredError}
|
|
@@ -643,7 +643,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
643
643
|
return (0, exports.VendorShippingApiFp)(this.configuration).getPackingSlips(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
644
644
|
}
|
|
645
645
|
/**
|
|
646
|
-
* 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,
|
|
646
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
647
647
|
* @param {VendorShippingApiGetShippingLabelRequest} requestParameters Request parameters.
|
|
648
648
|
* @param {*} [options] Override http request option.
|
|
649
649
|
* @throws {RequiredError}
|
|
@@ -653,7 +653,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
653
653
|
return (0, exports.VendorShippingApiFp)(this.configuration).getShippingLabel(requestParameters.purchaseOrderNumber, options).then((request) => request(this.axios, this.basePath));
|
|
654
654
|
}
|
|
655
655
|
/**
|
|
656
|
-
* 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,
|
|
656
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
657
657
|
* @param {VendorShippingApiGetShippingLabelsRequest} requestParameters Request parameters.
|
|
658
658
|
* @param {*} [options] Override http request option.
|
|
659
659
|
* @throws {RequiredError}
|
|
@@ -663,7 +663,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
663
663
|
return (0, exports.VendorShippingApiFp)(this.configuration).getShippingLabels(requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipFromPartyId, requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
664
664
|
}
|
|
665
665
|
/**
|
|
666
|
-
* 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,
|
|
666
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
667
667
|
* @param {VendorShippingApiSubmitShipmentConfirmationsRequest} requestParameters Request parameters.
|
|
668
668
|
* @param {*} [options] Override http request option.
|
|
669
669
|
* @throws {RequiredError}
|
|
@@ -673,7 +673,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
673
673
|
return (0, exports.VendorShippingApiFp)(this.configuration).submitShipmentConfirmations(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
674
674
|
}
|
|
675
675
|
/**
|
|
676
|
-
* 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,
|
|
676
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
677
677
|
* @param {VendorShippingApiSubmitShipmentStatusUpdatesRequest} requestParameters Request parameters.
|
|
678
678
|
* @param {*} [options] Override http request option.
|
|
679
679
|
* @throws {RequiredError}
|
|
@@ -683,7 +683,7 @@ class VendorShippingApi extends base_1.BaseAPI {
|
|
|
683
683
|
return (0, exports.VendorShippingApiFp)(this.configuration).submitShipmentStatusUpdates(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
684
684
|
}
|
|
685
685
|
/**
|
|
686
|
-
* 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,
|
|
686
|
+
* 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, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
687
687
|
* @param {VendorShippingApiSubmitShippingLabelRequestRequest} requestParameters Request parameters.
|
|
688
688
|
* @param {*} [options] Override http request option.
|
|
689
689
|
* @throws {RequiredError}
|