@sp-api-sdk/vendor-shipments-api-v1 2.5.2 → 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/README.md +1 -1
- package/dist/cjs/api-model/api/vendor-shipments-api.js +1 -110
- package/dist/cjs/api-model/models/index.js +0 -8
- package/dist/cjs/client.js +0 -7
- package/dist/es/api-model/api/vendor-shipments-api.js +0 -109
- package/dist/es/api-model/models/index.js +0 -8
- package/dist/es/client.js +0 -7
- package/dist/types/api-model/api/vendor-shipments-api.d.ts +0 -111
- package/dist/types/api-model/models/index.d.ts +0 -8
- package/package.json +4 -4
- package/dist/cjs/api-model/models/get-shipment-labels.js +0 -15
- package/dist/cjs/api-model/models/label-data.js +0 -19
- package/dist/cjs/api-model/models/packed-quantity.js +0 -20
- package/dist/cjs/api-model/models/purchase-order-item-details.js +0 -15
- package/dist/cjs/api-model/models/shipment-information.js +0 -20
- package/dist/cjs/api-model/models/transport-label.js +0 -15
- package/dist/cjs/api-model/models/transportation-labels.js +0 -15
- package/dist/cjs/api-model/models/vendor-details.js +0 -15
- package/dist/es/api-model/models/get-shipment-labels.js +0 -14
- package/dist/es/api-model/models/label-data.js +0 -16
- package/dist/es/api-model/models/packed-quantity.js +0 -17
- package/dist/es/api-model/models/purchase-order-item-details.js +0 -14
- package/dist/es/api-model/models/shipment-information.js +0 -17
- package/dist/es/api-model/models/transport-label.js +0 -14
- package/dist/es/api-model/models/transportation-labels.js +0 -14
- package/dist/es/api-model/models/vendor-details.js +0 -14
- package/dist/types/api-model/models/get-shipment-labels.d.ts +0 -31
- package/dist/types/api-model/models/label-data.d.ts +0 -52
- package/dist/types/api-model/models/packed-quantity.d.ts +0 -41
- package/dist/types/api-model/models/purchase-order-item-details.d.ts +0 -25
- package/dist/types/api-model/models/shipment-information.d.ts +0 -73
- package/dist/types/api-model/models/transport-label.d.ts +0 -38
- package/dist/types/api-model/models/transportation-labels.d.ts +0 -32
- package/dist/types/api-model/models/vendor-details.d.ts +0 -31
package/README.md
CHANGED
|
@@ -9,7 +9,7 @@ The Selling Partner API for Retail Procurement Shipments provides programmatic a
|
|
|
9
9
|
|
|
10
10
|
Learn more about this Selling Partner API by visiting the [official documentation](https://developer-docs.amazon.com/sp-api/docs).
|
|
11
11
|
|
|
12
|
-
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/
|
|
12
|
+
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp-api-sdk_vendor-shipments-api-v1.html) for this API client.
|
|
13
13
|
|
|
14
14
|
## Installing
|
|
15
15
|
|
|
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
16
16
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
17
|
};
|
|
18
18
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
-
exports.
|
|
19
|
+
exports.GetShipmentDetailsSortOrderEnum = exports.VendorShipmentsApi = exports.VendorShipmentsApiFactory = exports.VendorShipmentsApiFp = exports.VendorShipmentsApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -182,67 +182,6 @@ const VendorShipmentsApiAxiosParamCreator = function (configuration) {
|
|
|
182
182
|
options: localVarRequestOptions,
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
|
-
/**
|
|
186
|
-
* Returns transport Labels based on the filters 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).
|
|
187
|
-
* @summary GetShipmentLabels
|
|
188
|
-
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
189
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
190
|
-
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
191
|
-
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
192
|
-
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
193
|
-
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
194
|
-
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
195
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
196
|
-
* @param {*} [options] Override http request option.
|
|
197
|
-
* @throws {RequiredError}
|
|
198
|
-
*/
|
|
199
|
-
getShipmentLabels: async (limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options = {}) => {
|
|
200
|
-
const localVarPath = `/vendor/shipping/v1/transportLabels`;
|
|
201
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
202
|
-
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
203
|
-
let baseOptions;
|
|
204
|
-
if (configuration) {
|
|
205
|
-
baseOptions = configuration.baseOptions;
|
|
206
|
-
}
|
|
207
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
208
|
-
const localVarHeaderParameter = {};
|
|
209
|
-
const localVarQueryParameter = {};
|
|
210
|
-
if (limit !== undefined) {
|
|
211
|
-
localVarQueryParameter['limit'] = limit;
|
|
212
|
-
}
|
|
213
|
-
if (sortOrder !== undefined) {
|
|
214
|
-
localVarQueryParameter['sortOrder'] = sortOrder;
|
|
215
|
-
}
|
|
216
|
-
if (nextToken !== undefined) {
|
|
217
|
-
localVarQueryParameter['nextToken'] = nextToken;
|
|
218
|
-
}
|
|
219
|
-
if (labelCreatedAfter !== undefined) {
|
|
220
|
-
localVarQueryParameter['labelCreatedAfter'] = (labelCreatedAfter instanceof Date) ?
|
|
221
|
-
labelCreatedAfter.toISOString() :
|
|
222
|
-
labelCreatedAfter;
|
|
223
|
-
}
|
|
224
|
-
if (labelcreatedBefore !== undefined) {
|
|
225
|
-
localVarQueryParameter['labelcreatedBefore'] = (labelcreatedBefore instanceof Date) ?
|
|
226
|
-
labelcreatedBefore.toISOString() :
|
|
227
|
-
labelcreatedBefore;
|
|
228
|
-
}
|
|
229
|
-
if (buyerReferenceNumber !== undefined) {
|
|
230
|
-
localVarQueryParameter['buyerReferenceNumber'] = buyerReferenceNumber;
|
|
231
|
-
}
|
|
232
|
-
if (vendorShipmentIdentifier !== undefined) {
|
|
233
|
-
localVarQueryParameter['vendorShipmentIdentifier'] = vendorShipmentIdentifier;
|
|
234
|
-
}
|
|
235
|
-
if (sellerWarehouseCode !== undefined) {
|
|
236
|
-
localVarQueryParameter['sellerWarehouseCode'] = sellerWarehouseCode;
|
|
237
|
-
}
|
|
238
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
239
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
240
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
241
|
-
return {
|
|
242
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
243
|
-
options: localVarRequestOptions,
|
|
244
|
-
};
|
|
245
|
-
},
|
|
246
185
|
/**
|
|
247
186
|
* 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).
|
|
248
187
|
* @summary SubmitShipmentConfirmations
|
|
@@ -349,26 +288,6 @@ const VendorShipmentsApiFp = function (configuration) {
|
|
|
349
288
|
const localVarOperationServerBasePath = base_1.operationServerMap['VendorShipmentsApi.getShipmentDetails']?.[localVarOperationServerIndex]?.url;
|
|
350
289
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
351
290
|
},
|
|
352
|
-
/**
|
|
353
|
-
* Returns transport Labels based on the filters 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).
|
|
354
|
-
* @summary GetShipmentLabels
|
|
355
|
-
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
356
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
357
|
-
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
358
|
-
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
359
|
-
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
360
|
-
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
361
|
-
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
362
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
363
|
-
* @param {*} [options] Override http request option.
|
|
364
|
-
* @throws {RequiredError}
|
|
365
|
-
*/
|
|
366
|
-
async getShipmentLabels(limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options) {
|
|
367
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentLabels(limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options);
|
|
368
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
369
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['VendorShipmentsApi.getShipmentLabels']?.[localVarOperationServerIndex]?.url;
|
|
370
|
-
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
371
|
-
},
|
|
372
291
|
/**
|
|
373
292
|
* 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).
|
|
374
293
|
* @summary SubmitShipmentConfirmations
|
|
@@ -415,16 +334,6 @@ const VendorShipmentsApiFactory = function (configuration, basePath, axios) {
|
|
|
415
334
|
getShipmentDetails(requestParameters = {}, options) {
|
|
416
335
|
return localVarFp.getShipmentDetails(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentConfirmedBefore, requestParameters.shipmentConfirmedAfter, requestParameters.packageLabelCreatedBefore, requestParameters.packageLabelCreatedAfter, requestParameters.shippedBefore, requestParameters.shippedAfter, requestParameters.estimatedDeliveryBefore, requestParameters.estimatedDeliveryAfter, requestParameters.shipmentDeliveryBefore, requestParameters.shipmentDeliveryAfter, requestParameters.requestedPickUpBefore, requestParameters.requestedPickUpAfter, requestParameters.scheduledPickUpBefore, requestParameters.scheduledPickUpAfter, requestParameters.currentShipmentStatus, requestParameters.vendorShipmentIdentifier, requestParameters.buyerReferenceNumber, requestParameters.buyerWarehouseCode, requestParameters.sellerWarehouseCode, options).then((request) => request(axios, basePath));
|
|
417
336
|
},
|
|
418
|
-
/**
|
|
419
|
-
* Returns transport Labels based on the filters 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).
|
|
420
|
-
* @summary GetShipmentLabels
|
|
421
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
422
|
-
* @param {*} [options] Override http request option.
|
|
423
|
-
* @throws {RequiredError}
|
|
424
|
-
*/
|
|
425
|
-
getShipmentLabels(requestParameters = {}, options) {
|
|
426
|
-
return localVarFp.getShipmentLabels(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.labelCreatedAfter, requestParameters.labelcreatedBefore, requestParameters.buyerReferenceNumber, requestParameters.vendorShipmentIdentifier, requestParameters.sellerWarehouseCode, options).then((request) => request(axios, basePath));
|
|
427
|
-
},
|
|
428
337
|
/**
|
|
429
338
|
* 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).
|
|
430
339
|
* @summary SubmitShipmentConfirmations
|
|
@@ -466,17 +375,6 @@ class VendorShipmentsApi extends base_1.BaseAPI {
|
|
|
466
375
|
getShipmentDetails(requestParameters = {}, options) {
|
|
467
376
|
return (0, exports.VendorShipmentsApiFp)(this.configuration).getShipmentDetails(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentConfirmedBefore, requestParameters.shipmentConfirmedAfter, requestParameters.packageLabelCreatedBefore, requestParameters.packageLabelCreatedAfter, requestParameters.shippedBefore, requestParameters.shippedAfter, requestParameters.estimatedDeliveryBefore, requestParameters.estimatedDeliveryAfter, requestParameters.shipmentDeliveryBefore, requestParameters.shipmentDeliveryAfter, requestParameters.requestedPickUpBefore, requestParameters.requestedPickUpAfter, requestParameters.scheduledPickUpBefore, requestParameters.scheduledPickUpAfter, requestParameters.currentShipmentStatus, requestParameters.vendorShipmentIdentifier, requestParameters.buyerReferenceNumber, requestParameters.buyerWarehouseCode, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath));
|
|
468
377
|
}
|
|
469
|
-
/**
|
|
470
|
-
* Returns transport Labels based on the filters 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).
|
|
471
|
-
* @summary GetShipmentLabels
|
|
472
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
473
|
-
* @param {*} [options] Override http request option.
|
|
474
|
-
* @throws {RequiredError}
|
|
475
|
-
* @memberof VendorShipmentsApi
|
|
476
|
-
*/
|
|
477
|
-
getShipmentLabels(requestParameters = {}, options) {
|
|
478
|
-
return (0, exports.VendorShipmentsApiFp)(this.configuration).getShipmentLabels(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.labelCreatedAfter, requestParameters.labelcreatedBefore, requestParameters.buyerReferenceNumber, requestParameters.vendorShipmentIdentifier, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath));
|
|
479
|
-
}
|
|
480
378
|
/**
|
|
481
379
|
* 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).
|
|
482
380
|
* @summary SubmitShipmentConfirmations
|
|
@@ -508,10 +406,3 @@ exports.GetShipmentDetailsSortOrderEnum = {
|
|
|
508
406
|
Asc: 'ASC',
|
|
509
407
|
Desc: 'DESC'
|
|
510
408
|
};
|
|
511
|
-
/**
|
|
512
|
-
* @export
|
|
513
|
-
*/
|
|
514
|
-
exports.GetShipmentLabelsSortOrderEnum = {
|
|
515
|
-
Asc: 'ASC',
|
|
516
|
-
Desc: 'DESC'
|
|
517
|
-
};
|
|
@@ -27,30 +27,25 @@ __exportStar(require("./dimensions"), exports);
|
|
|
27
27
|
__exportStar(require("./duration"), exports);
|
|
28
28
|
__exportStar(require("./expiry"), exports);
|
|
29
29
|
__exportStar(require("./get-shipment-details-response"), exports);
|
|
30
|
-
__exportStar(require("./get-shipment-labels"), exports);
|
|
31
30
|
__exportStar(require("./import-details"), exports);
|
|
32
31
|
__exportStar(require("./inner-containers-details"), exports);
|
|
33
32
|
__exportStar(require("./item"), exports);
|
|
34
33
|
__exportStar(require("./item-details"), exports);
|
|
35
34
|
__exportStar(require("./item-quantity"), exports);
|
|
36
|
-
__exportStar(require("./label-data"), exports);
|
|
37
35
|
__exportStar(require("./location"), exports);
|
|
38
36
|
__exportStar(require("./model-error"), exports);
|
|
39
37
|
__exportStar(require("./money"), exports);
|
|
40
38
|
__exportStar(require("./package-item-details"), exports);
|
|
41
39
|
__exportStar(require("./packed-items"), exports);
|
|
42
|
-
__exportStar(require("./packed-quantity"), exports);
|
|
43
40
|
__exportStar(require("./pagination"), exports);
|
|
44
41
|
__exportStar(require("./pallet"), exports);
|
|
45
42
|
__exportStar(require("./party-identification"), exports);
|
|
46
|
-
__exportStar(require("./purchase-order-item-details"), exports);
|
|
47
43
|
__exportStar(require("./purchase-order-items"), exports);
|
|
48
44
|
__exportStar(require("./purchase-orders"), exports);
|
|
49
45
|
__exportStar(require("./route"), exports);
|
|
50
46
|
__exportStar(require("./shipment"), exports);
|
|
51
47
|
__exportStar(require("./shipment-confirmation"), exports);
|
|
52
48
|
__exportStar(require("./shipment-details"), exports);
|
|
53
|
-
__exportStar(require("./shipment-information"), exports);
|
|
54
49
|
__exportStar(require("./shipment-measurements"), exports);
|
|
55
50
|
__exportStar(require("./shipment-status-details"), exports);
|
|
56
51
|
__exportStar(require("./stop"), exports);
|
|
@@ -60,11 +55,8 @@ __exportStar(require("./submit-shipments"), exports);
|
|
|
60
55
|
__exportStar(require("./tax-registration-details"), exports);
|
|
61
56
|
__exportStar(require("./total-weight"), exports);
|
|
62
57
|
__exportStar(require("./transaction-reference"), exports);
|
|
63
|
-
__exportStar(require("./transport-label"), exports);
|
|
64
58
|
__exportStar(require("./transport-shipment-measurements"), exports);
|
|
65
59
|
__exportStar(require("./transportation-details"), exports);
|
|
66
60
|
__exportStar(require("./transportation-details-for-shipment-confirmation"), exports);
|
|
67
|
-
__exportStar(require("./transportation-labels"), exports);
|
|
68
|
-
__exportStar(require("./vendor-details"), exports);
|
|
69
61
|
__exportStar(require("./volume"), exports);
|
|
70
62
|
__exportStar(require("./weight"), exports);
|
package/dist/cjs/client.js
CHANGED
|
@@ -25,13 +25,6 @@ exports.clientRateLimits = [
|
|
|
25
25
|
rate: 10,
|
|
26
26
|
burst: 10,
|
|
27
27
|
},
|
|
28
|
-
{
|
|
29
|
-
method: 'get',
|
|
30
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
31
|
-
urlRegex: new RegExp('^/vendor/shipping/v1/transportLabels$'),
|
|
32
|
-
rate: 10,
|
|
33
|
-
burst: 10,
|
|
34
|
-
},
|
|
35
28
|
];
|
|
36
29
|
class VendorShipmentsApiClient extends api_model_1.VendorShipmentsApi {
|
|
37
30
|
constructor(configuration) {
|
|
@@ -176,67 +176,6 @@ export const VendorShipmentsApiAxiosParamCreator = function (configuration) {
|
|
|
176
176
|
options: localVarRequestOptions,
|
|
177
177
|
};
|
|
178
178
|
},
|
|
179
|
-
/**
|
|
180
|
-
* Returns transport Labels based on the filters 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).
|
|
181
|
-
* @summary GetShipmentLabels
|
|
182
|
-
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
183
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
184
|
-
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
185
|
-
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
186
|
-
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
187
|
-
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
188
|
-
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
189
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
190
|
-
* @param {*} [options] Override http request option.
|
|
191
|
-
* @throws {RequiredError}
|
|
192
|
-
*/
|
|
193
|
-
getShipmentLabels: async (limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options = {}) => {
|
|
194
|
-
const localVarPath = `/vendor/shipping/v1/transportLabels`;
|
|
195
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
196
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
197
|
-
let baseOptions;
|
|
198
|
-
if (configuration) {
|
|
199
|
-
baseOptions = configuration.baseOptions;
|
|
200
|
-
}
|
|
201
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
202
|
-
const localVarHeaderParameter = {};
|
|
203
|
-
const localVarQueryParameter = {};
|
|
204
|
-
if (limit !== undefined) {
|
|
205
|
-
localVarQueryParameter['limit'] = limit;
|
|
206
|
-
}
|
|
207
|
-
if (sortOrder !== undefined) {
|
|
208
|
-
localVarQueryParameter['sortOrder'] = sortOrder;
|
|
209
|
-
}
|
|
210
|
-
if (nextToken !== undefined) {
|
|
211
|
-
localVarQueryParameter['nextToken'] = nextToken;
|
|
212
|
-
}
|
|
213
|
-
if (labelCreatedAfter !== undefined) {
|
|
214
|
-
localVarQueryParameter['labelCreatedAfter'] = (labelCreatedAfter instanceof Date) ?
|
|
215
|
-
labelCreatedAfter.toISOString() :
|
|
216
|
-
labelCreatedAfter;
|
|
217
|
-
}
|
|
218
|
-
if (labelcreatedBefore !== undefined) {
|
|
219
|
-
localVarQueryParameter['labelcreatedBefore'] = (labelcreatedBefore instanceof Date) ?
|
|
220
|
-
labelcreatedBefore.toISOString() :
|
|
221
|
-
labelcreatedBefore;
|
|
222
|
-
}
|
|
223
|
-
if (buyerReferenceNumber !== undefined) {
|
|
224
|
-
localVarQueryParameter['buyerReferenceNumber'] = buyerReferenceNumber;
|
|
225
|
-
}
|
|
226
|
-
if (vendorShipmentIdentifier !== undefined) {
|
|
227
|
-
localVarQueryParameter['vendorShipmentIdentifier'] = vendorShipmentIdentifier;
|
|
228
|
-
}
|
|
229
|
-
if (sellerWarehouseCode !== undefined) {
|
|
230
|
-
localVarQueryParameter['sellerWarehouseCode'] = sellerWarehouseCode;
|
|
231
|
-
}
|
|
232
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
233
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
234
|
-
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
235
|
-
return {
|
|
236
|
-
url: toPathString(localVarUrlObj),
|
|
237
|
-
options: localVarRequestOptions,
|
|
238
|
-
};
|
|
239
|
-
},
|
|
240
179
|
/**
|
|
241
180
|
* 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).
|
|
242
181
|
* @summary SubmitShipmentConfirmations
|
|
@@ -342,26 +281,6 @@ export const VendorShipmentsApiFp = function (configuration) {
|
|
|
342
281
|
const localVarOperationServerBasePath = operationServerMap['VendorShipmentsApi.getShipmentDetails']?.[localVarOperationServerIndex]?.url;
|
|
343
282
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
344
283
|
},
|
|
345
|
-
/**
|
|
346
|
-
* Returns transport Labels based on the filters 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).
|
|
347
|
-
* @summary GetShipmentLabels
|
|
348
|
-
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
349
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
350
|
-
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
351
|
-
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
352
|
-
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
353
|
-
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
354
|
-
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
355
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
356
|
-
* @param {*} [options] Override http request option.
|
|
357
|
-
* @throws {RequiredError}
|
|
358
|
-
*/
|
|
359
|
-
async getShipmentLabels(limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options) {
|
|
360
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentLabels(limit, sortOrder, nextToken, labelCreatedAfter, labelcreatedBefore, buyerReferenceNumber, vendorShipmentIdentifier, sellerWarehouseCode, options);
|
|
361
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
362
|
-
const localVarOperationServerBasePath = operationServerMap['VendorShipmentsApi.getShipmentLabels']?.[localVarOperationServerIndex]?.url;
|
|
363
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
364
|
-
},
|
|
365
284
|
/**
|
|
366
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, 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).
|
|
367
286
|
* @summary SubmitShipmentConfirmations
|
|
@@ -407,16 +326,6 @@ export const VendorShipmentsApiFactory = function (configuration, basePath, axio
|
|
|
407
326
|
getShipmentDetails(requestParameters = {}, options) {
|
|
408
327
|
return localVarFp.getShipmentDetails(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentConfirmedBefore, requestParameters.shipmentConfirmedAfter, requestParameters.packageLabelCreatedBefore, requestParameters.packageLabelCreatedAfter, requestParameters.shippedBefore, requestParameters.shippedAfter, requestParameters.estimatedDeliveryBefore, requestParameters.estimatedDeliveryAfter, requestParameters.shipmentDeliveryBefore, requestParameters.shipmentDeliveryAfter, requestParameters.requestedPickUpBefore, requestParameters.requestedPickUpAfter, requestParameters.scheduledPickUpBefore, requestParameters.scheduledPickUpAfter, requestParameters.currentShipmentStatus, requestParameters.vendorShipmentIdentifier, requestParameters.buyerReferenceNumber, requestParameters.buyerWarehouseCode, requestParameters.sellerWarehouseCode, options).then((request) => request(axios, basePath));
|
|
409
328
|
},
|
|
410
|
-
/**
|
|
411
|
-
* Returns transport Labels based on the filters 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).
|
|
412
|
-
* @summary GetShipmentLabels
|
|
413
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
414
|
-
* @param {*} [options] Override http request option.
|
|
415
|
-
* @throws {RequiredError}
|
|
416
|
-
*/
|
|
417
|
-
getShipmentLabels(requestParameters = {}, options) {
|
|
418
|
-
return localVarFp.getShipmentLabels(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.labelCreatedAfter, requestParameters.labelcreatedBefore, requestParameters.buyerReferenceNumber, requestParameters.vendorShipmentIdentifier, requestParameters.sellerWarehouseCode, options).then((request) => request(axios, basePath));
|
|
419
|
-
},
|
|
420
329
|
/**
|
|
421
330
|
* 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).
|
|
422
331
|
* @summary SubmitShipmentConfirmations
|
|
@@ -457,17 +366,6 @@ export class VendorShipmentsApi extends BaseAPI {
|
|
|
457
366
|
getShipmentDetails(requestParameters = {}, options) {
|
|
458
367
|
return VendorShipmentsApiFp(this.configuration).getShipmentDetails(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.createdAfter, requestParameters.createdBefore, requestParameters.shipmentConfirmedBefore, requestParameters.shipmentConfirmedAfter, requestParameters.packageLabelCreatedBefore, requestParameters.packageLabelCreatedAfter, requestParameters.shippedBefore, requestParameters.shippedAfter, requestParameters.estimatedDeliveryBefore, requestParameters.estimatedDeliveryAfter, requestParameters.shipmentDeliveryBefore, requestParameters.shipmentDeliveryAfter, requestParameters.requestedPickUpBefore, requestParameters.requestedPickUpAfter, requestParameters.scheduledPickUpBefore, requestParameters.scheduledPickUpAfter, requestParameters.currentShipmentStatus, requestParameters.vendorShipmentIdentifier, requestParameters.buyerReferenceNumber, requestParameters.buyerWarehouseCode, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath));
|
|
459
368
|
}
|
|
460
|
-
/**
|
|
461
|
-
* Returns transport Labels based on the filters 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).
|
|
462
|
-
* @summary GetShipmentLabels
|
|
463
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
464
|
-
* @param {*} [options] Override http request option.
|
|
465
|
-
* @throws {RequiredError}
|
|
466
|
-
* @memberof VendorShipmentsApi
|
|
467
|
-
*/
|
|
468
|
-
getShipmentLabels(requestParameters = {}, options) {
|
|
469
|
-
return VendorShipmentsApiFp(this.configuration).getShipmentLabels(requestParameters.limit, requestParameters.sortOrder, requestParameters.nextToken, requestParameters.labelCreatedAfter, requestParameters.labelcreatedBefore, requestParameters.buyerReferenceNumber, requestParameters.vendorShipmentIdentifier, requestParameters.sellerWarehouseCode, options).then((request) => request(this.axios, this.basePath));
|
|
470
|
-
}
|
|
471
369
|
/**
|
|
472
370
|
* 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).
|
|
473
371
|
* @summary SubmitShipmentConfirmations
|
|
@@ -498,10 +396,3 @@ export const GetShipmentDetailsSortOrderEnum = {
|
|
|
498
396
|
Asc: 'ASC',
|
|
499
397
|
Desc: 'DESC'
|
|
500
398
|
};
|
|
501
|
-
/**
|
|
502
|
-
* @export
|
|
503
|
-
*/
|
|
504
|
-
export const GetShipmentLabelsSortOrderEnum = {
|
|
505
|
-
Asc: 'ASC',
|
|
506
|
-
Desc: 'DESC'
|
|
507
|
-
};
|
|
@@ -11,30 +11,25 @@ export * from './dimensions';
|
|
|
11
11
|
export * from './duration';
|
|
12
12
|
export * from './expiry';
|
|
13
13
|
export * from './get-shipment-details-response';
|
|
14
|
-
export * from './get-shipment-labels';
|
|
15
14
|
export * from './import-details';
|
|
16
15
|
export * from './inner-containers-details';
|
|
17
16
|
export * from './item';
|
|
18
17
|
export * from './item-details';
|
|
19
18
|
export * from './item-quantity';
|
|
20
|
-
export * from './label-data';
|
|
21
19
|
export * from './location';
|
|
22
20
|
export * from './model-error';
|
|
23
21
|
export * from './money';
|
|
24
22
|
export * from './package-item-details';
|
|
25
23
|
export * from './packed-items';
|
|
26
|
-
export * from './packed-quantity';
|
|
27
24
|
export * from './pagination';
|
|
28
25
|
export * from './pallet';
|
|
29
26
|
export * from './party-identification';
|
|
30
|
-
export * from './purchase-order-item-details';
|
|
31
27
|
export * from './purchase-order-items';
|
|
32
28
|
export * from './purchase-orders';
|
|
33
29
|
export * from './route';
|
|
34
30
|
export * from './shipment';
|
|
35
31
|
export * from './shipment-confirmation';
|
|
36
32
|
export * from './shipment-details';
|
|
37
|
-
export * from './shipment-information';
|
|
38
33
|
export * from './shipment-measurements';
|
|
39
34
|
export * from './shipment-status-details';
|
|
40
35
|
export * from './stop';
|
|
@@ -44,11 +39,8 @@ export * from './submit-shipments';
|
|
|
44
39
|
export * from './tax-registration-details';
|
|
45
40
|
export * from './total-weight';
|
|
46
41
|
export * from './transaction-reference';
|
|
47
|
-
export * from './transport-label';
|
|
48
42
|
export * from './transport-shipment-measurements';
|
|
49
43
|
export * from './transportation-details';
|
|
50
44
|
export * from './transportation-details-for-shipment-confirmation';
|
|
51
|
-
export * from './transportation-labels';
|
|
52
|
-
export * from './vendor-details';
|
|
53
45
|
export * from './volume';
|
|
54
46
|
export * from './weight';
|
package/dist/es/client.js
CHANGED
|
@@ -22,13 +22,6 @@ export const clientRateLimits = [
|
|
|
22
22
|
rate: 10,
|
|
23
23
|
burst: 10,
|
|
24
24
|
},
|
|
25
|
-
{
|
|
26
|
-
method: 'get',
|
|
27
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
28
|
-
urlRegex: new RegExp('^/vendor/shipping/v1/transportLabels$'),
|
|
29
|
-
rate: 10,
|
|
30
|
-
burst: 10,
|
|
31
|
-
},
|
|
32
25
|
];
|
|
33
26
|
export class VendorShipmentsApiClient extends VendorShipmentsApi {
|
|
34
27
|
constructor(configuration) {
|
|
@@ -14,7 +14,6 @@ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
15
|
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
16
|
import type { GetShipmentDetailsResponse } from '../models';
|
|
17
|
-
import type { GetShipmentLabels } from '../models';
|
|
18
17
|
import type { SubmitShipmentConfirmationsRequest } from '../models';
|
|
19
18
|
import type { SubmitShipmentConfirmationsResponse } from '../models';
|
|
20
19
|
import type { SubmitShipments } from '../models';
|
|
@@ -54,21 +53,6 @@ export declare const VendorShipmentsApiAxiosParamCreator: (configuration?: Confi
|
|
|
54
53
|
* @throws {RequiredError}
|
|
55
54
|
*/
|
|
56
55
|
getShipmentDetails: (limit?: number, sortOrder?: GetShipmentDetailsSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
-
/**
|
|
58
|
-
* Returns transport Labels based on the filters 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).
|
|
59
|
-
* @summary GetShipmentLabels
|
|
60
|
-
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
61
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
62
|
-
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
63
|
-
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
64
|
-
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
65
|
-
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
66
|
-
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
67
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
68
|
-
* @param {*} [options] Override http request option.
|
|
69
|
-
* @throws {RequiredError}
|
|
70
|
-
*/
|
|
71
|
-
getShipmentLabels: (limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string, labelcreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
72
56
|
/**
|
|
73
57
|
* 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).
|
|
74
58
|
* @summary SubmitShipmentConfirmations
|
|
@@ -122,21 +106,6 @@ export declare const VendorShipmentsApiFp: (configuration?: Configuration) => {
|
|
|
122
106
|
* @throws {RequiredError}
|
|
123
107
|
*/
|
|
124
108
|
getShipmentDetails(limit?: number, sortOrder?: GetShipmentDetailsSortOrderEnum, nextToken?: string, createdAfter?: string, createdBefore?: string, shipmentConfirmedBefore?: string, shipmentConfirmedAfter?: string, packageLabelCreatedBefore?: string, packageLabelCreatedAfter?: string, shippedBefore?: string, shippedAfter?: string, estimatedDeliveryBefore?: string, estimatedDeliveryAfter?: string, shipmentDeliveryBefore?: string, shipmentDeliveryAfter?: string, requestedPickUpBefore?: string, requestedPickUpAfter?: string, scheduledPickUpBefore?: string, scheduledPickUpAfter?: string, currentShipmentStatus?: string, vendorShipmentIdentifier?: string, buyerReferenceNumber?: string, buyerWarehouseCode?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentDetailsResponse>>;
|
|
125
|
-
/**
|
|
126
|
-
* Returns transport Labels based on the filters 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).
|
|
127
|
-
* @summary GetShipmentLabels
|
|
128
|
-
* @param {number} [limit] The limit to the number of records returned. Default value is 50 records.
|
|
129
|
-
* @param {GetShipmentLabelsSortOrderEnum} [sortOrder] Sort in ascending or descending order by transport label creation date.
|
|
130
|
-
* @param {string} [nextToken] Used for pagination when there are more transport label than the specified result size limit.
|
|
131
|
-
* @param {string} [labelCreatedAfter] transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
132
|
-
* @param {string} [labelcreatedBefore] transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
133
|
-
* @param {string} [buyerReferenceNumber] Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
134
|
-
* @param {string} [vendorShipmentIdentifier] Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
135
|
-
* @param {string} [sellerWarehouseCode] Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
136
|
-
* @param {*} [options] Override http request option.
|
|
137
|
-
* @throws {RequiredError}
|
|
138
|
-
*/
|
|
139
|
-
getShipmentLabels(limit?: number, sortOrder?: GetShipmentLabelsSortOrderEnum, nextToken?: string, labelCreatedAfter?: string, labelcreatedBefore?: string, buyerReferenceNumber?: string, vendorShipmentIdentifier?: string, sellerWarehouseCode?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentLabels>>;
|
|
140
109
|
/**
|
|
141
110
|
* 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).
|
|
142
111
|
* @summary SubmitShipmentConfirmations
|
|
@@ -167,14 +136,6 @@ export declare const VendorShipmentsApiFactory: (configuration?: Configuration,
|
|
|
167
136
|
* @throws {RequiredError}
|
|
168
137
|
*/
|
|
169
138
|
getShipmentDetails(requestParameters?: VendorShipmentsApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentDetailsResponse>;
|
|
170
|
-
/**
|
|
171
|
-
* Returns transport Labels based on the filters 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).
|
|
172
|
-
* @summary GetShipmentLabels
|
|
173
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
174
|
-
* @param {*} [options] Override http request option.
|
|
175
|
-
* @throws {RequiredError}
|
|
176
|
-
*/
|
|
177
|
-
getShipmentLabels(requestParameters?: VendorShipmentsApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentLabels>;
|
|
178
139
|
/**
|
|
179
140
|
* 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).
|
|
180
141
|
* @summary SubmitShipmentConfirmations
|
|
@@ -343,61 +304,6 @@ export interface VendorShipmentsApiGetShipmentDetailsRequest {
|
|
|
343
304
|
*/
|
|
344
305
|
readonly sellerWarehouseCode?: string;
|
|
345
306
|
}
|
|
346
|
-
/**
|
|
347
|
-
* Request parameters for getShipmentLabels operation in VendorShipmentsApi.
|
|
348
|
-
* @export
|
|
349
|
-
* @interface VendorShipmentsApiGetShipmentLabelsRequest
|
|
350
|
-
*/
|
|
351
|
-
export interface VendorShipmentsApiGetShipmentLabelsRequest {
|
|
352
|
-
/**
|
|
353
|
-
* The limit to the number of records returned. Default value is 50 records.
|
|
354
|
-
* @type {number}
|
|
355
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
356
|
-
*/
|
|
357
|
-
readonly limit?: number;
|
|
358
|
-
/**
|
|
359
|
-
* Sort in ascending or descending order by transport label creation date.
|
|
360
|
-
* @type {'ASC' | 'DESC'}
|
|
361
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
362
|
-
*/
|
|
363
|
-
readonly sortOrder?: GetShipmentLabelsSortOrderEnum;
|
|
364
|
-
/**
|
|
365
|
-
* Used for pagination when there are more transport label than the specified result size limit.
|
|
366
|
-
* @type {string}
|
|
367
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
368
|
-
*/
|
|
369
|
-
readonly nextToken?: string;
|
|
370
|
-
/**
|
|
371
|
-
* transport Labels that became available after this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
372
|
-
* @type {string}
|
|
373
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
374
|
-
*/
|
|
375
|
-
readonly labelCreatedAfter?: string;
|
|
376
|
-
/**
|
|
377
|
-
* transport Labels that became available before this timestamp will be included in the result. Must be in ISO-8601 date/time format.
|
|
378
|
-
* @type {string}
|
|
379
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
380
|
-
*/
|
|
381
|
-
readonly labelcreatedBefore?: string;
|
|
382
|
-
/**
|
|
383
|
-
* Get transport labels by passing Buyer Reference Number to retreive the corresponding transport label.
|
|
384
|
-
* @type {string}
|
|
385
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
386
|
-
*/
|
|
387
|
-
readonly buyerReferenceNumber?: string;
|
|
388
|
-
/**
|
|
389
|
-
* Get transport labels by passing Vendor Shipment ID to retreive the corresponding transport label.
|
|
390
|
-
* @type {string}
|
|
391
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
392
|
-
*/
|
|
393
|
-
readonly vendorShipmentIdentifier?: string;
|
|
394
|
-
/**
|
|
395
|
-
* Get Shipping labels based Vendor Warehouse code. This value should be same as \'shipFromParty.partyId\' in the Shipment.
|
|
396
|
-
* @type {string}
|
|
397
|
-
* @memberof VendorShipmentsApiGetShipmentLabels
|
|
398
|
-
*/
|
|
399
|
-
readonly sellerWarehouseCode?: string;
|
|
400
|
-
}
|
|
401
307
|
/**
|
|
402
308
|
* Request parameters for submitShipmentConfirmations operation in VendorShipmentsApi.
|
|
403
309
|
* @export
|
|
@@ -440,15 +346,6 @@ export declare class VendorShipmentsApi extends BaseAPI {
|
|
|
440
346
|
* @memberof VendorShipmentsApi
|
|
441
347
|
*/
|
|
442
348
|
getShipmentDetails(requestParameters?: VendorShipmentsApiGetShipmentDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentDetailsResponse, any>>;
|
|
443
|
-
/**
|
|
444
|
-
* Returns transport Labels based on the filters 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).
|
|
445
|
-
* @summary GetShipmentLabels
|
|
446
|
-
* @param {VendorShipmentsApiGetShipmentLabelsRequest} requestParameters Request parameters.
|
|
447
|
-
* @param {*} [options] Override http request option.
|
|
448
|
-
* @throws {RequiredError}
|
|
449
|
-
* @memberof VendorShipmentsApi
|
|
450
|
-
*/
|
|
451
|
-
getShipmentLabels(requestParameters?: VendorShipmentsApiGetShipmentLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentLabels, any>>;
|
|
452
349
|
/**
|
|
453
350
|
* 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).
|
|
454
351
|
* @summary SubmitShipmentConfirmations
|
|
@@ -476,11 +373,3 @@ export declare const GetShipmentDetailsSortOrderEnum: {
|
|
|
476
373
|
readonly Desc: "DESC";
|
|
477
374
|
};
|
|
478
375
|
export type GetShipmentDetailsSortOrderEnum = typeof GetShipmentDetailsSortOrderEnum[keyof typeof GetShipmentDetailsSortOrderEnum];
|
|
479
|
-
/**
|
|
480
|
-
* @export
|
|
481
|
-
*/
|
|
482
|
-
export declare const GetShipmentLabelsSortOrderEnum: {
|
|
483
|
-
readonly Asc: "ASC";
|
|
484
|
-
readonly Desc: "DESC";
|
|
485
|
-
};
|
|
486
|
-
export type GetShipmentLabelsSortOrderEnum = typeof GetShipmentLabelsSortOrderEnum[keyof typeof GetShipmentLabelsSortOrderEnum];
|