@sp-api-sdk/fulfillment-inbound-api-v0 3.1.2 → 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-model/api/{fba-inbound-api.js → fulfillment-inbound-api.js} +46 -46
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/client.js +1 -1
- package/dist/es/api-model/api/{fba-inbound-api.js → fulfillment-inbound-api.js} +41 -41
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/client.js +2 -2
- package/dist/types/api-model/api/{fba-inbound-api.d.ts → fulfillment-inbound-api.d.ts} +83 -83
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/client.d.ts +2 -2
- package/package.json +4 -4
|
@@ -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.GetShipmentsShipmentStatusListEnum = exports.GetShipmentsQueryTypeEnum = exports.GetShipmentItemsQueryTypeEnum = exports.GetLabelsLabelTypeEnum = exports.GetLabelsPageTypeEnum = exports.
|
|
19
|
+
exports.GetShipmentsShipmentStatusListEnum = exports.GetShipmentsQueryTypeEnum = exports.GetShipmentItemsQueryTypeEnum = exports.GetLabelsLabelTypeEnum = exports.GetLabelsPageTypeEnum = exports.FulfillmentInboundApi = exports.FulfillmentInboundApiFactory = exports.FulfillmentInboundApiFp = exports.FulfillmentInboundApiAxiosParamCreator = void 0;
|
|
20
20
|
const axios_1 = __importDefault(require("axios"));
|
|
21
21
|
// Some imports not used depending on template conditions
|
|
22
22
|
// @ts-ignore
|
|
@@ -24,10 +24,10 @@ const common_1 = require("../common");
|
|
|
24
24
|
// @ts-ignore
|
|
25
25
|
const base_1 = require("../base");
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
27
|
+
* FulfillmentInboundApi - axios parameter creator
|
|
28
28
|
* @export
|
|
29
29
|
*/
|
|
30
|
-
const
|
|
30
|
+
const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
33
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
@@ -301,13 +301,13 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
301
301
|
},
|
|
302
302
|
};
|
|
303
303
|
};
|
|
304
|
-
exports.
|
|
304
|
+
exports.FulfillmentInboundApiAxiosParamCreator = FulfillmentInboundApiAxiosParamCreator;
|
|
305
305
|
/**
|
|
306
|
-
*
|
|
306
|
+
* FulfillmentInboundApi - functional programming interface
|
|
307
307
|
* @export
|
|
308
308
|
*/
|
|
309
|
-
const
|
|
310
|
-
const localVarAxiosParamCreator = (0, exports.
|
|
309
|
+
const FulfillmentInboundApiFp = function (configuration) {
|
|
310
|
+
const localVarAxiosParamCreator = (0, exports.FulfillmentInboundApiAxiosParamCreator)(configuration);
|
|
311
311
|
return {
|
|
312
312
|
/**
|
|
313
313
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
@@ -318,7 +318,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
318
318
|
async getBillOfLading(shipmentId, options) {
|
|
319
319
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getBillOfLading(shipmentId, options);
|
|
320
320
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
321
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
321
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getBillOfLading']?.[localVarOperationServerIndex]?.url;
|
|
322
322
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
323
323
|
},
|
|
324
324
|
/**
|
|
@@ -337,7 +337,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
337
337
|
async getLabels(shipmentId, pageType, labelType, numberOfPackages, packageLabelsToPrint, numberOfPallets, pageSize, pageStartIndex, options) {
|
|
338
338
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getLabels(shipmentId, pageType, labelType, numberOfPackages, packageLabelsToPrint, numberOfPallets, pageSize, pageStartIndex, options);
|
|
339
339
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
340
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
340
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getLabels']?.[localVarOperationServerIndex]?.url;
|
|
341
341
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
342
342
|
},
|
|
343
343
|
/**
|
|
@@ -351,7 +351,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
351
351
|
async getPrepInstructions(shipToCountryCode, sellerSKUList, aSINList, options) {
|
|
352
352
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPrepInstructions(shipToCountryCode, sellerSKUList, aSINList, options);
|
|
353
353
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
354
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
354
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getPrepInstructions']?.[localVarOperationServerIndex]?.url;
|
|
355
355
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
356
356
|
},
|
|
357
357
|
/**
|
|
@@ -367,7 +367,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
367
367
|
async getShipmentItems(queryType, marketplaceId, lastUpdatedAfter, lastUpdatedBefore, nextToken, options) {
|
|
368
368
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentItems(queryType, marketplaceId, lastUpdatedAfter, lastUpdatedBefore, nextToken, options);
|
|
369
369
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
370
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
370
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getShipmentItems']?.[localVarOperationServerIndex]?.url;
|
|
371
371
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
372
372
|
},
|
|
373
373
|
/**
|
|
@@ -380,7 +380,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
380
380
|
async getShipmentItemsByShipmentId(shipmentId, marketplaceId, options) {
|
|
381
381
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentItemsByShipmentId(shipmentId, marketplaceId, options);
|
|
382
382
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
383
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
383
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getShipmentItemsByShipmentId']?.[localVarOperationServerIndex]?.url;
|
|
384
384
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
385
385
|
},
|
|
386
386
|
/**
|
|
@@ -398,22 +398,22 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
398
398
|
async getShipments(queryType, marketplaceId, shipmentStatusList, shipmentIdList, lastUpdatedAfter, lastUpdatedBefore, nextToken, options) {
|
|
399
399
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipments(queryType, marketplaceId, shipmentStatusList, shipmentIdList, lastUpdatedAfter, lastUpdatedBefore, nextToken, options);
|
|
400
400
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
401
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['
|
|
401
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.getShipments']?.[localVarOperationServerIndex]?.url;
|
|
402
402
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
403
403
|
},
|
|
404
404
|
};
|
|
405
405
|
};
|
|
406
|
-
exports.
|
|
406
|
+
exports.FulfillmentInboundApiFp = FulfillmentInboundApiFp;
|
|
407
407
|
/**
|
|
408
|
-
*
|
|
408
|
+
* FulfillmentInboundApi - factory interface
|
|
409
409
|
* @export
|
|
410
410
|
*/
|
|
411
|
-
const
|
|
412
|
-
const localVarFp = (0, exports.
|
|
411
|
+
const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
412
|
+
const localVarFp = (0, exports.FulfillmentInboundApiFp)(configuration);
|
|
413
413
|
return {
|
|
414
414
|
/**
|
|
415
415
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
416
|
-
* @param {
|
|
416
|
+
* @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
417
417
|
* @param {*} [options] Override http request option.
|
|
418
418
|
* @throws {RequiredError}
|
|
419
419
|
*/
|
|
@@ -422,7 +422,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
422
422
|
},
|
|
423
423
|
/**
|
|
424
424
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
425
|
-
* @param {
|
|
425
|
+
* @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
426
426
|
* @param {*} [options] Override http request option.
|
|
427
427
|
* @throws {RequiredError}
|
|
428
428
|
*/
|
|
@@ -431,7 +431,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
431
431
|
},
|
|
432
432
|
/**
|
|
433
433
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
434
|
-
* @param {
|
|
434
|
+
* @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
435
435
|
* @param {*} [options] Override http request option.
|
|
436
436
|
* @throws {RequiredError}
|
|
437
437
|
*/
|
|
@@ -440,7 +440,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
440
440
|
},
|
|
441
441
|
/**
|
|
442
442
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
443
|
-
* @param {
|
|
443
|
+
* @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
444
444
|
* @param {*} [options] Override http request option.
|
|
445
445
|
* @throws {RequiredError}
|
|
446
446
|
*/
|
|
@@ -449,7 +449,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
449
449
|
},
|
|
450
450
|
/**
|
|
451
451
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
452
|
-
* @param {
|
|
452
|
+
* @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
453
453
|
* @param {*} [options] Override http request option.
|
|
454
454
|
* @throws {RequiredError}
|
|
455
455
|
*/
|
|
@@ -458,7 +458,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
458
458
|
},
|
|
459
459
|
/**
|
|
460
460
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
461
|
-
* @param {
|
|
461
|
+
* @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
462
462
|
* @param {*} [options] Override http request option.
|
|
463
463
|
* @throws {RequiredError}
|
|
464
464
|
*/
|
|
@@ -467,76 +467,76 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
467
467
|
},
|
|
468
468
|
};
|
|
469
469
|
};
|
|
470
|
-
exports.
|
|
470
|
+
exports.FulfillmentInboundApiFactory = FulfillmentInboundApiFactory;
|
|
471
471
|
/**
|
|
472
|
-
*
|
|
472
|
+
* FulfillmentInboundApi - object-oriented interface
|
|
473
473
|
* @export
|
|
474
|
-
* @class
|
|
474
|
+
* @class FulfillmentInboundApi
|
|
475
475
|
* @extends {BaseAPI}
|
|
476
476
|
*/
|
|
477
|
-
class
|
|
477
|
+
class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
478
478
|
/**
|
|
479
479
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
480
|
-
* @param {
|
|
480
|
+
* @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
481
481
|
* @param {*} [options] Override http request option.
|
|
482
482
|
* @throws {RequiredError}
|
|
483
|
-
* @memberof
|
|
483
|
+
* @memberof FulfillmentInboundApi
|
|
484
484
|
*/
|
|
485
485
|
getBillOfLading(requestParameters, options) {
|
|
486
|
-
return (0, exports.
|
|
486
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getBillOfLading(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
487
487
|
}
|
|
488
488
|
/**
|
|
489
489
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
490
|
-
* @param {
|
|
490
|
+
* @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
491
491
|
* @param {*} [options] Override http request option.
|
|
492
492
|
* @throws {RequiredError}
|
|
493
|
-
* @memberof
|
|
493
|
+
* @memberof FulfillmentInboundApi
|
|
494
494
|
*/
|
|
495
495
|
getLabels(requestParameters, options) {
|
|
496
|
-
return (0, exports.
|
|
496
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getLabels(requestParameters.shipmentId, requestParameters.pageType, requestParameters.labelType, requestParameters.numberOfPackages, requestParameters.packageLabelsToPrint, requestParameters.numberOfPallets, requestParameters.pageSize, requestParameters.pageStartIndex, options).then((request) => request(this.axios, this.basePath));
|
|
497
497
|
}
|
|
498
498
|
/**
|
|
499
499
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
500
|
-
* @param {
|
|
500
|
+
* @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
501
501
|
* @param {*} [options] Override http request option.
|
|
502
502
|
* @throws {RequiredError}
|
|
503
|
-
* @memberof
|
|
503
|
+
* @memberof FulfillmentInboundApi
|
|
504
504
|
*/
|
|
505
505
|
getPrepInstructions(requestParameters, options) {
|
|
506
|
-
return (0, exports.
|
|
506
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getPrepInstructions(requestParameters.shipToCountryCode, requestParameters.sellerSKUList, requestParameters.aSINList, options).then((request) => request(this.axios, this.basePath));
|
|
507
507
|
}
|
|
508
508
|
/**
|
|
509
509
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
510
|
-
* @param {
|
|
510
|
+
* @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
511
511
|
* @param {*} [options] Override http request option.
|
|
512
512
|
* @throws {RequiredError}
|
|
513
|
-
* @memberof
|
|
513
|
+
* @memberof FulfillmentInboundApi
|
|
514
514
|
*/
|
|
515
515
|
getShipmentItems(requestParameters, options) {
|
|
516
|
-
return (0, exports.
|
|
516
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getShipmentItems(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
517
517
|
}
|
|
518
518
|
/**
|
|
519
519
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
520
|
-
* @param {
|
|
520
|
+
* @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
521
521
|
* @param {*} [options] Override http request option.
|
|
522
522
|
* @throws {RequiredError}
|
|
523
|
-
* @memberof
|
|
523
|
+
* @memberof FulfillmentInboundApi
|
|
524
524
|
*/
|
|
525
525
|
getShipmentItemsByShipmentId(requestParameters, options) {
|
|
526
|
-
return (0, exports.
|
|
526
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getShipmentItemsByShipmentId(requestParameters.shipmentId, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
527
527
|
}
|
|
528
528
|
/**
|
|
529
529
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
530
|
-
* @param {
|
|
530
|
+
* @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
531
531
|
* @param {*} [options] Override http request option.
|
|
532
532
|
* @throws {RequiredError}
|
|
533
|
-
* @memberof
|
|
533
|
+
* @memberof FulfillmentInboundApi
|
|
534
534
|
*/
|
|
535
535
|
getShipments(requestParameters, options) {
|
|
536
|
-
return (0, exports.
|
|
536
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getShipments(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.shipmentStatusList, requestParameters.shipmentIdList, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
537
537
|
}
|
|
538
538
|
}
|
|
539
|
-
exports.
|
|
539
|
+
exports.FulfillmentInboundApi = FulfillmentInboundApi;
|
|
540
540
|
/**
|
|
541
541
|
* @export
|
|
542
542
|
*/
|
|
@@ -27,4 +27,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
27
27
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
28
28
|
};
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
|
-
__exportStar(require("./api/
|
|
30
|
+
__exportStar(require("./api/fulfillment-inbound-api"), exports);
|
package/dist/cjs/client.js
CHANGED
|
@@ -47,7 +47,7 @@ exports.clientRateLimits = [
|
|
|
47
47
|
burst: 30,
|
|
48
48
|
},
|
|
49
49
|
];
|
|
50
|
-
class FulfillmentInboundApiClient extends api_model_1.
|
|
50
|
+
class FulfillmentInboundApiClient extends api_model_1.FulfillmentInboundApi {
|
|
51
51
|
constructor(configuration) {
|
|
52
52
|
const { axios, endpoint } = (0, common_1.createAxiosInstance)(configuration, exports.clientRateLimits);
|
|
53
53
|
super(new api_model_1.Configuration(), endpoint, axios);
|
|
@@ -18,10 +18,10 @@ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, creat
|
|
|
18
18
|
// @ts-ignore
|
|
19
19
|
import { BASE_PATH, COLLECTION_FORMATS, BaseAPI, operationServerMap } from '../base';
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* FulfillmentInboundApi - axios parameter creator
|
|
22
22
|
* @export
|
|
23
23
|
*/
|
|
24
|
-
export const
|
|
24
|
+
export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
25
25
|
return {
|
|
26
26
|
/**
|
|
27
27
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
@@ -296,11 +296,11 @@ export const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
296
296
|
};
|
|
297
297
|
};
|
|
298
298
|
/**
|
|
299
|
-
*
|
|
299
|
+
* FulfillmentInboundApi - functional programming interface
|
|
300
300
|
* @export
|
|
301
301
|
*/
|
|
302
|
-
export const
|
|
303
|
-
const localVarAxiosParamCreator =
|
|
302
|
+
export const FulfillmentInboundApiFp = function (configuration) {
|
|
303
|
+
const localVarAxiosParamCreator = FulfillmentInboundApiAxiosParamCreator(configuration);
|
|
304
304
|
return {
|
|
305
305
|
/**
|
|
306
306
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
@@ -311,7 +311,7 @@ export const FbaInboundApiFp = function (configuration) {
|
|
|
311
311
|
async getBillOfLading(shipmentId, options) {
|
|
312
312
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getBillOfLading(shipmentId, options);
|
|
313
313
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
314
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
314
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.getBillOfLading']?.[localVarOperationServerIndex]?.url;
|
|
315
315
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
316
316
|
},
|
|
317
317
|
/**
|
|
@@ -330,7 +330,7 @@ export const FbaInboundApiFp = function (configuration) {
|
|
|
330
330
|
async getLabels(shipmentId, pageType, labelType, numberOfPackages, packageLabelsToPrint, numberOfPallets, pageSize, pageStartIndex, options) {
|
|
331
331
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getLabels(shipmentId, pageType, labelType, numberOfPackages, packageLabelsToPrint, numberOfPallets, pageSize, pageStartIndex, options);
|
|
332
332
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
333
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
333
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.getLabels']?.[localVarOperationServerIndex]?.url;
|
|
334
334
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
335
335
|
},
|
|
336
336
|
/**
|
|
@@ -344,7 +344,7 @@ export const FbaInboundApiFp = function (configuration) {
|
|
|
344
344
|
async getPrepInstructions(shipToCountryCode, sellerSKUList, aSINList, options) {
|
|
345
345
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPrepInstructions(shipToCountryCode, sellerSKUList, aSINList, options);
|
|
346
346
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
347
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
347
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.getPrepInstructions']?.[localVarOperationServerIndex]?.url;
|
|
348
348
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
349
349
|
},
|
|
350
350
|
/**
|
|
@@ -360,7 +360,7 @@ export const FbaInboundApiFp = function (configuration) {
|
|
|
360
360
|
async getShipmentItems(queryType, marketplaceId, lastUpdatedAfter, lastUpdatedBefore, nextToken, options) {
|
|
361
361
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentItems(queryType, marketplaceId, lastUpdatedAfter, lastUpdatedBefore, nextToken, options);
|
|
362
362
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
363
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
363
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.getShipmentItems']?.[localVarOperationServerIndex]?.url;
|
|
364
364
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
365
365
|
},
|
|
366
366
|
/**
|
|
@@ -373,7 +373,7 @@ export const FbaInboundApiFp = function (configuration) {
|
|
|
373
373
|
async getShipmentItemsByShipmentId(shipmentId, marketplaceId, options) {
|
|
374
374
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentItemsByShipmentId(shipmentId, marketplaceId, options);
|
|
375
375
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
376
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
376
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.getShipmentItemsByShipmentId']?.[localVarOperationServerIndex]?.url;
|
|
377
377
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
378
378
|
},
|
|
379
379
|
/**
|
|
@@ -391,21 +391,21 @@ export const FbaInboundApiFp = function (configuration) {
|
|
|
391
391
|
async getShipments(queryType, marketplaceId, shipmentStatusList, shipmentIdList, lastUpdatedAfter, lastUpdatedBefore, nextToken, options) {
|
|
392
392
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipments(queryType, marketplaceId, shipmentStatusList, shipmentIdList, lastUpdatedAfter, lastUpdatedBefore, nextToken, options);
|
|
393
393
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
394
|
-
const localVarOperationServerBasePath = operationServerMap['
|
|
394
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.getShipments']?.[localVarOperationServerIndex]?.url;
|
|
395
395
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
396
396
|
},
|
|
397
397
|
};
|
|
398
398
|
};
|
|
399
399
|
/**
|
|
400
|
-
*
|
|
400
|
+
* FulfillmentInboundApi - factory interface
|
|
401
401
|
* @export
|
|
402
402
|
*/
|
|
403
|
-
export const
|
|
404
|
-
const localVarFp =
|
|
403
|
+
export const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
404
|
+
const localVarFp = FulfillmentInboundApiFp(configuration);
|
|
405
405
|
return {
|
|
406
406
|
/**
|
|
407
407
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
408
|
-
* @param {
|
|
408
|
+
* @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
409
409
|
* @param {*} [options] Override http request option.
|
|
410
410
|
* @throws {RequiredError}
|
|
411
411
|
*/
|
|
@@ -414,7 +414,7 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
414
414
|
},
|
|
415
415
|
/**
|
|
416
416
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
417
|
-
* @param {
|
|
417
|
+
* @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
418
418
|
* @param {*} [options] Override http request option.
|
|
419
419
|
* @throws {RequiredError}
|
|
420
420
|
*/
|
|
@@ -423,7 +423,7 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
423
423
|
},
|
|
424
424
|
/**
|
|
425
425
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
426
|
-
* @param {
|
|
426
|
+
* @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
427
427
|
* @param {*} [options] Override http request option.
|
|
428
428
|
* @throws {RequiredError}
|
|
429
429
|
*/
|
|
@@ -432,7 +432,7 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
432
432
|
},
|
|
433
433
|
/**
|
|
434
434
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
435
|
-
* @param {
|
|
435
|
+
* @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
436
436
|
* @param {*} [options] Override http request option.
|
|
437
437
|
* @throws {RequiredError}
|
|
438
438
|
*/
|
|
@@ -441,7 +441,7 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
441
441
|
},
|
|
442
442
|
/**
|
|
443
443
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
444
|
-
* @param {
|
|
444
|
+
* @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
447
|
*/
|
|
@@ -450,7 +450,7 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
450
450
|
},
|
|
451
451
|
/**
|
|
452
452
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
453
|
-
* @param {
|
|
453
|
+
* @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
454
454
|
* @param {*} [options] Override http request option.
|
|
455
455
|
* @throws {RequiredError}
|
|
456
456
|
*/
|
|
@@ -460,71 +460,71 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
460
460
|
};
|
|
461
461
|
};
|
|
462
462
|
/**
|
|
463
|
-
*
|
|
463
|
+
* FulfillmentInboundApi - object-oriented interface
|
|
464
464
|
* @export
|
|
465
|
-
* @class
|
|
465
|
+
* @class FulfillmentInboundApi
|
|
466
466
|
* @extends {BaseAPI}
|
|
467
467
|
*/
|
|
468
|
-
export class
|
|
468
|
+
export class FulfillmentInboundApi extends BaseAPI {
|
|
469
469
|
/**
|
|
470
470
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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
|
-
* @param {
|
|
471
|
+
* @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
472
472
|
* @param {*} [options] Override http request option.
|
|
473
473
|
* @throws {RequiredError}
|
|
474
|
-
* @memberof
|
|
474
|
+
* @memberof FulfillmentInboundApi
|
|
475
475
|
*/
|
|
476
476
|
getBillOfLading(requestParameters, options) {
|
|
477
|
-
return
|
|
477
|
+
return FulfillmentInboundApiFp(this.configuration).getBillOfLading(requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
478
478
|
}
|
|
479
479
|
/**
|
|
480
480
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
481
|
-
* @param {
|
|
481
|
+
* @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
482
482
|
* @param {*} [options] Override http request option.
|
|
483
483
|
* @throws {RequiredError}
|
|
484
|
-
* @memberof
|
|
484
|
+
* @memberof FulfillmentInboundApi
|
|
485
485
|
*/
|
|
486
486
|
getLabels(requestParameters, options) {
|
|
487
|
-
return
|
|
487
|
+
return FulfillmentInboundApiFp(this.configuration).getLabels(requestParameters.shipmentId, requestParameters.pageType, requestParameters.labelType, requestParameters.numberOfPackages, requestParameters.packageLabelsToPrint, requestParameters.numberOfPallets, requestParameters.pageSize, requestParameters.pageStartIndex, options).then((request) => request(this.axios, this.basePath));
|
|
488
488
|
}
|
|
489
489
|
/**
|
|
490
490
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
491
|
-
* @param {
|
|
491
|
+
* @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
492
492
|
* @param {*} [options] Override http request option.
|
|
493
493
|
* @throws {RequiredError}
|
|
494
|
-
* @memberof
|
|
494
|
+
* @memberof FulfillmentInboundApi
|
|
495
495
|
*/
|
|
496
496
|
getPrepInstructions(requestParameters, options) {
|
|
497
|
-
return
|
|
497
|
+
return FulfillmentInboundApiFp(this.configuration).getPrepInstructions(requestParameters.shipToCountryCode, requestParameters.sellerSKUList, requestParameters.aSINList, options).then((request) => request(this.axios, this.basePath));
|
|
498
498
|
}
|
|
499
499
|
/**
|
|
500
500
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
501
|
-
* @param {
|
|
501
|
+
* @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
502
502
|
* @param {*} [options] Override http request option.
|
|
503
503
|
* @throws {RequiredError}
|
|
504
|
-
* @memberof
|
|
504
|
+
* @memberof FulfillmentInboundApi
|
|
505
505
|
*/
|
|
506
506
|
getShipmentItems(requestParameters, options) {
|
|
507
|
-
return
|
|
507
|
+
return FulfillmentInboundApiFp(this.configuration).getShipmentItems(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
508
508
|
}
|
|
509
509
|
/**
|
|
510
510
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
511
|
-
* @param {
|
|
511
|
+
* @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
512
512
|
* @param {*} [options] Override http request option.
|
|
513
513
|
* @throws {RequiredError}
|
|
514
|
-
* @memberof
|
|
514
|
+
* @memberof FulfillmentInboundApi
|
|
515
515
|
*/
|
|
516
516
|
getShipmentItemsByShipmentId(requestParameters, options) {
|
|
517
|
-
return
|
|
517
|
+
return FulfillmentInboundApiFp(this.configuration).getShipmentItemsByShipmentId(requestParameters.shipmentId, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
518
518
|
}
|
|
519
519
|
/**
|
|
520
520
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
521
|
-
* @param {
|
|
521
|
+
* @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
522
522
|
* @param {*} [options] Override http request option.
|
|
523
523
|
* @throws {RequiredError}
|
|
524
|
-
* @memberof
|
|
524
|
+
* @memberof FulfillmentInboundApi
|
|
525
525
|
*/
|
|
526
526
|
getShipments(requestParameters, options) {
|
|
527
|
-
return
|
|
527
|
+
return FulfillmentInboundApiFp(this.configuration).getShipments(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.shipmentStatusList, requestParameters.shipmentIdList, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(this.axios, this.basePath));
|
|
528
528
|
}
|
|
529
529
|
}
|
|
530
530
|
/**
|
package/dist/es/api-model/api.js
CHANGED
package/dist/es/client.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { createAxiosInstance } from '@sp-api-sdk/common';
|
|
2
|
-
import { Configuration,
|
|
2
|
+
import { Configuration, FulfillmentInboundApi } from './api-model';
|
|
3
3
|
export const clientRateLimits = [
|
|
4
4
|
{
|
|
5
5
|
method: 'get',
|
|
@@ -44,7 +44,7 @@ export const clientRateLimits = [
|
|
|
44
44
|
burst: 30,
|
|
45
45
|
},
|
|
46
46
|
];
|
|
47
|
-
export class FulfillmentInboundApiClient extends
|
|
47
|
+
export class FulfillmentInboundApiClient extends FulfillmentInboundApi {
|
|
48
48
|
constructor(configuration) {
|
|
49
49
|
const { axios, endpoint } = createAxiosInstance(configuration, clientRateLimits);
|
|
50
50
|
super(new Configuration(), endpoint, axios);
|
|
@@ -19,10 +19,10 @@ import type { GetPrepInstructionsResponse } from '../models';
|
|
|
19
19
|
import type { GetShipmentItemsResponse } from '../models';
|
|
20
20
|
import type { GetShipmentsResponse } from '../models';
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* FulfillmentInboundApi - axios parameter creator
|
|
23
23
|
* @export
|
|
24
24
|
*/
|
|
25
|
-
export declare const
|
|
25
|
+
export declare const FulfillmentInboundApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
26
26
|
/**
|
|
27
27
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
28
28
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -87,10 +87,10 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
87
87
|
getShipments: (queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
88
|
};
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* FulfillmentInboundApi - functional programming interface
|
|
91
91
|
* @export
|
|
92
92
|
*/
|
|
93
|
-
export declare const
|
|
93
|
+
export declare const FulfillmentInboundApiFp: (configuration?: Configuration) => {
|
|
94
94
|
/**
|
|
95
95
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
96
96
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -155,306 +155,306 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
155
155
|
getShipments(queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentsResponse>>;
|
|
156
156
|
};
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* FulfillmentInboundApi - factory interface
|
|
159
159
|
* @export
|
|
160
160
|
*/
|
|
161
|
-
export declare const
|
|
161
|
+
export declare const FulfillmentInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
162
162
|
/**
|
|
163
163
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
164
|
-
* @param {
|
|
164
|
+
* @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
166
166
|
* @throws {RequiredError}
|
|
167
167
|
*/
|
|
168
|
-
getBillOfLading(requestParameters:
|
|
168
|
+
getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetBillOfLadingResponse>;
|
|
169
169
|
/**
|
|
170
170
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
171
|
-
* @param {
|
|
171
|
+
* @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
172
172
|
* @param {*} [options] Override http request option.
|
|
173
173
|
* @throws {RequiredError}
|
|
174
174
|
*/
|
|
175
|
-
getLabels(requestParameters:
|
|
175
|
+
getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLabelsResponse>;
|
|
176
176
|
/**
|
|
177
177
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
178
|
-
* @param {
|
|
178
|
+
* @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
179
179
|
* @param {*} [options] Override http request option.
|
|
180
180
|
* @throws {RequiredError}
|
|
181
181
|
*/
|
|
182
|
-
getPrepInstructions(requestParameters:
|
|
182
|
+
getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrepInstructionsResponse>;
|
|
183
183
|
/**
|
|
184
184
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
185
|
-
* @param {
|
|
185
|
+
* @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
186
186
|
* @param {*} [options] Override http request option.
|
|
187
187
|
* @throws {RequiredError}
|
|
188
188
|
*/
|
|
189
|
-
getShipmentItems(requestParameters:
|
|
189
|
+
getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
|
|
190
190
|
/**
|
|
191
191
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
192
|
-
* @param {
|
|
192
|
+
* @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
193
193
|
* @param {*} [options] Override http request option.
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
196
|
-
getShipmentItemsByShipmentId(requestParameters:
|
|
196
|
+
getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
|
|
197
197
|
/**
|
|
198
198
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
199
|
-
* @param {
|
|
199
|
+
* @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
203
|
-
getShipments(requestParameters:
|
|
203
|
+
getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentsResponse>;
|
|
204
204
|
};
|
|
205
205
|
/**
|
|
206
|
-
* Request parameters for getBillOfLading operation in
|
|
206
|
+
* Request parameters for getBillOfLading operation in FulfillmentInboundApi.
|
|
207
207
|
* @export
|
|
208
|
-
* @interface
|
|
208
|
+
* @interface FulfillmentInboundApiGetBillOfLadingRequest
|
|
209
209
|
*/
|
|
210
|
-
export interface
|
|
210
|
+
export interface FulfillmentInboundApiGetBillOfLadingRequest {
|
|
211
211
|
/**
|
|
212
212
|
* A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
213
213
|
* @type {string}
|
|
214
|
-
* @memberof
|
|
214
|
+
* @memberof FulfillmentInboundApiGetBillOfLading
|
|
215
215
|
*/
|
|
216
216
|
readonly shipmentId: string;
|
|
217
217
|
}
|
|
218
218
|
/**
|
|
219
|
-
* Request parameters for getLabels operation in
|
|
219
|
+
* Request parameters for getLabels operation in FulfillmentInboundApi.
|
|
220
220
|
* @export
|
|
221
|
-
* @interface
|
|
221
|
+
* @interface FulfillmentInboundApiGetLabelsRequest
|
|
222
222
|
*/
|
|
223
|
-
export interface
|
|
223
|
+
export interface FulfillmentInboundApiGetLabelsRequest {
|
|
224
224
|
/**
|
|
225
225
|
* A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
226
226
|
* @type {string}
|
|
227
|
-
* @memberof
|
|
227
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
228
228
|
*/
|
|
229
229
|
readonly shipmentId: string;
|
|
230
230
|
/**
|
|
231
231
|
* The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
|
|
232
232
|
* @type {'PackageLabel_Letter_2' | 'PackageLabel_Letter_4' | 'PackageLabel_Letter_6' | 'PackageLabel_Letter_6_CarrierLeft' | 'PackageLabel_A4_2' | 'PackageLabel_A4_4' | 'PackageLabel_Plain_Paper' | 'PackageLabel_Plain_Paper_CarrierBottom' | 'PackageLabel_Thermal' | 'PackageLabel_Thermal_Unified' | 'PackageLabel_Thermal_NonPCP' | 'PackageLabel_Thermal_No_Carrier_Rotation'}
|
|
233
|
-
* @memberof
|
|
233
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
234
234
|
*/
|
|
235
235
|
readonly pageType: GetLabelsPageTypeEnum;
|
|
236
236
|
/**
|
|
237
237
|
* The type of labels requested.
|
|
238
238
|
* @type {'BARCODE_2D' | 'UNIQUE' | 'PALLET'}
|
|
239
|
-
* @memberof
|
|
239
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
240
240
|
*/
|
|
241
241
|
readonly labelType: GetLabelsLabelTypeEnum;
|
|
242
242
|
/**
|
|
243
243
|
* The number of packages in the shipment.
|
|
244
244
|
* @type {number}
|
|
245
|
-
* @memberof
|
|
245
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
246
246
|
*/
|
|
247
247
|
readonly numberOfPackages?: number;
|
|
248
248
|
/**
|
|
249
249
|
* A list of identifiers that specify packages for which you want package labels printed. If you provide box content information with the [FBA Inbound Shipment Carton Information Feed](https://developer-docs.amazon.com/sp-api/docs/fulfillment-by-amazon-feed-type-values#fba-inbound-shipment-carton-information-feed), then `PackageLabelsToPrint` must match the `CartonId` values you provide through that feed. If you provide box content information with the Fulfillment Inbound API v2024-03-20, then `PackageLabelsToPrint` must match the `boxID` values from the [`listShipmentBoxes`](https://developer-docs.amazon.com/sp-api/docs/fulfillment-inbound-api-v2024-03-20-reference#listshipmentboxes) response. If these values do not match as required, the operation returns the `IncorrectPackageIdentifier` error code.
|
|
250
250
|
* @type {Array<string>}
|
|
251
|
-
* @memberof
|
|
251
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
252
252
|
*/
|
|
253
253
|
readonly packageLabelsToPrint?: Array<string>;
|
|
254
254
|
/**
|
|
255
255
|
* The number of pallets in the shipment. This returns four identical labels for each pallet.
|
|
256
256
|
* @type {number}
|
|
257
|
-
* @memberof
|
|
257
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
258
258
|
*/
|
|
259
259
|
readonly numberOfPallets?: number;
|
|
260
260
|
/**
|
|
261
261
|
* The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
|
|
262
262
|
* @type {number}
|
|
263
|
-
* @memberof
|
|
263
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
264
264
|
*/
|
|
265
265
|
readonly pageSize?: number;
|
|
266
266
|
/**
|
|
267
267
|
* The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments.
|
|
268
268
|
* @type {number}
|
|
269
|
-
* @memberof
|
|
269
|
+
* @memberof FulfillmentInboundApiGetLabels
|
|
270
270
|
*/
|
|
271
271
|
readonly pageStartIndex?: number;
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
* Request parameters for getPrepInstructions operation in
|
|
274
|
+
* Request parameters for getPrepInstructions operation in FulfillmentInboundApi.
|
|
275
275
|
* @export
|
|
276
|
-
* @interface
|
|
276
|
+
* @interface FulfillmentInboundApiGetPrepInstructionsRequest
|
|
277
277
|
*/
|
|
278
|
-
export interface
|
|
278
|
+
export interface FulfillmentInboundApiGetPrepInstructionsRequest {
|
|
279
279
|
/**
|
|
280
280
|
* The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
|
|
281
281
|
* @type {string}
|
|
282
|
-
* @memberof
|
|
282
|
+
* @memberof FulfillmentInboundApiGetPrepInstructions
|
|
283
283
|
*/
|
|
284
284
|
readonly shipToCountryCode: string;
|
|
285
285
|
/**
|
|
286
286
|
* A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
|
|
287
287
|
* @type {Array<string>}
|
|
288
|
-
* @memberof
|
|
288
|
+
* @memberof FulfillmentInboundApiGetPrepInstructions
|
|
289
289
|
*/
|
|
290
290
|
readonly sellerSKUList?: Array<string>;
|
|
291
291
|
/**
|
|
292
292
|
* A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
|
|
293
293
|
* @type {Array<string>}
|
|
294
|
-
* @memberof
|
|
294
|
+
* @memberof FulfillmentInboundApiGetPrepInstructions
|
|
295
295
|
*/
|
|
296
296
|
readonly aSINList?: Array<string>;
|
|
297
297
|
}
|
|
298
298
|
/**
|
|
299
|
-
* Request parameters for getShipmentItems operation in
|
|
299
|
+
* Request parameters for getShipmentItems operation in FulfillmentInboundApi.
|
|
300
300
|
* @export
|
|
301
|
-
* @interface
|
|
301
|
+
* @interface FulfillmentInboundApiGetShipmentItemsRequest
|
|
302
302
|
*/
|
|
303
|
-
export interface
|
|
303
|
+
export interface FulfillmentInboundApiGetShipmentItemsRequest {
|
|
304
304
|
/**
|
|
305
305
|
* Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
|
|
306
306
|
* @type {'DATE_RANGE' | 'NEXT_TOKEN'}
|
|
307
|
-
* @memberof
|
|
307
|
+
* @memberof FulfillmentInboundApiGetShipmentItems
|
|
308
308
|
*/
|
|
309
309
|
readonly queryType: GetShipmentItemsQueryTypeEnum;
|
|
310
310
|
/**
|
|
311
311
|
* A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
312
312
|
* @type {string}
|
|
313
|
-
* @memberof
|
|
313
|
+
* @memberof FulfillmentInboundApiGetShipmentItems
|
|
314
314
|
*/
|
|
315
315
|
readonly marketplaceId: string;
|
|
316
316
|
/**
|
|
317
317
|
* A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
318
318
|
* @type {string}
|
|
319
|
-
* @memberof
|
|
319
|
+
* @memberof FulfillmentInboundApiGetShipmentItems
|
|
320
320
|
*/
|
|
321
321
|
readonly lastUpdatedAfter?: string;
|
|
322
322
|
/**
|
|
323
323
|
* A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
324
324
|
* @type {string}
|
|
325
|
-
* @memberof
|
|
325
|
+
* @memberof FulfillmentInboundApiGetShipmentItems
|
|
326
326
|
*/
|
|
327
327
|
readonly lastUpdatedBefore?: string;
|
|
328
328
|
/**
|
|
329
329
|
* A string token returned in the response to your previous request.
|
|
330
330
|
* @type {string}
|
|
331
|
-
* @memberof
|
|
331
|
+
* @memberof FulfillmentInboundApiGetShipmentItems
|
|
332
332
|
*/
|
|
333
333
|
readonly nextToken?: string;
|
|
334
334
|
}
|
|
335
335
|
/**
|
|
336
|
-
* Request parameters for getShipmentItemsByShipmentId operation in
|
|
336
|
+
* Request parameters for getShipmentItemsByShipmentId operation in FulfillmentInboundApi.
|
|
337
337
|
* @export
|
|
338
|
-
* @interface
|
|
338
|
+
* @interface FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest
|
|
339
339
|
*/
|
|
340
|
-
export interface
|
|
340
|
+
export interface FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest {
|
|
341
341
|
/**
|
|
342
342
|
* A shipment identifier used for selecting items in a specific inbound shipment.
|
|
343
343
|
* @type {string}
|
|
344
|
-
* @memberof
|
|
344
|
+
* @memberof FulfillmentInboundApiGetShipmentItemsByShipmentId
|
|
345
345
|
*/
|
|
346
346
|
readonly shipmentId: string;
|
|
347
347
|
/**
|
|
348
348
|
* Deprecated. Do not use.
|
|
349
349
|
* @type {string}
|
|
350
|
-
* @memberof
|
|
350
|
+
* @memberof FulfillmentInboundApiGetShipmentItemsByShipmentId
|
|
351
351
|
*/
|
|
352
352
|
readonly marketplaceId?: string;
|
|
353
353
|
}
|
|
354
354
|
/**
|
|
355
|
-
* Request parameters for getShipments operation in
|
|
355
|
+
* Request parameters for getShipments operation in FulfillmentInboundApi.
|
|
356
356
|
* @export
|
|
357
|
-
* @interface
|
|
357
|
+
* @interface FulfillmentInboundApiGetShipmentsRequest
|
|
358
358
|
*/
|
|
359
|
-
export interface
|
|
359
|
+
export interface FulfillmentInboundApiGetShipmentsRequest {
|
|
360
360
|
/**
|
|
361
361
|
* Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
|
|
362
362
|
* @type {'SHIPMENT' | 'DATE_RANGE' | 'NEXT_TOKEN'}
|
|
363
|
-
* @memberof
|
|
363
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
364
364
|
*/
|
|
365
365
|
readonly queryType: GetShipmentsQueryTypeEnum;
|
|
366
366
|
/**
|
|
367
367
|
* A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
368
368
|
* @type {string}
|
|
369
|
-
* @memberof
|
|
369
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
370
370
|
*/
|
|
371
371
|
readonly marketplaceId: string;
|
|
372
372
|
/**
|
|
373
373
|
* A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
|
|
374
374
|
* @type {Array<'WORKING' | 'READY_TO_SHIP' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'>}
|
|
375
|
-
* @memberof
|
|
375
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
376
376
|
*/
|
|
377
377
|
readonly shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>;
|
|
378
378
|
/**
|
|
379
379
|
* A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
|
|
380
380
|
* @type {Array<string>}
|
|
381
|
-
* @memberof
|
|
381
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
382
382
|
*/
|
|
383
383
|
readonly shipmentIdList?: Array<string>;
|
|
384
384
|
/**
|
|
385
385
|
* A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
386
386
|
* @type {string}
|
|
387
|
-
* @memberof
|
|
387
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
388
388
|
*/
|
|
389
389
|
readonly lastUpdatedAfter?: string;
|
|
390
390
|
/**
|
|
391
391
|
* A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
392
392
|
* @type {string}
|
|
393
|
-
* @memberof
|
|
393
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
394
394
|
*/
|
|
395
395
|
readonly lastUpdatedBefore?: string;
|
|
396
396
|
/**
|
|
397
397
|
* A string token returned in the response to your previous request.
|
|
398
398
|
* @type {string}
|
|
399
|
-
* @memberof
|
|
399
|
+
* @memberof FulfillmentInboundApiGetShipments
|
|
400
400
|
*/
|
|
401
401
|
readonly nextToken?: string;
|
|
402
402
|
}
|
|
403
403
|
/**
|
|
404
|
-
*
|
|
404
|
+
* FulfillmentInboundApi - object-oriented interface
|
|
405
405
|
* @export
|
|
406
|
-
* @class
|
|
406
|
+
* @class FulfillmentInboundApi
|
|
407
407
|
* @extends {BaseAPI}
|
|
408
408
|
*/
|
|
409
|
-
export declare class
|
|
409
|
+
export declare class FulfillmentInboundApi extends BaseAPI {
|
|
410
410
|
/**
|
|
411
411
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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
|
-
* @param {
|
|
412
|
+
* @param {FulfillmentInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
413
413
|
* @param {*} [options] Override http request option.
|
|
414
414
|
* @throws {RequiredError}
|
|
415
|
-
* @memberof
|
|
415
|
+
* @memberof FulfillmentInboundApi
|
|
416
416
|
*/
|
|
417
|
-
getBillOfLading(requestParameters:
|
|
417
|
+
getBillOfLading(requestParameters: FulfillmentInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetBillOfLadingResponse, any>>;
|
|
418
418
|
/**
|
|
419
419
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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
|
-
* @param {
|
|
420
|
+
* @param {FulfillmentInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
421
421
|
* @param {*} [options] Override http request option.
|
|
422
422
|
* @throws {RequiredError}
|
|
423
|
-
* @memberof
|
|
423
|
+
* @memberof FulfillmentInboundApi
|
|
424
424
|
*/
|
|
425
|
-
getLabels(requestParameters:
|
|
425
|
+
getLabels(requestParameters: FulfillmentInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetLabelsResponse, any>>;
|
|
426
426
|
/**
|
|
427
427
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
428
|
-
* @param {
|
|
428
|
+
* @param {FulfillmentInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
429
429
|
* @param {*} [options] Override http request option.
|
|
430
430
|
* @throws {RequiredError}
|
|
431
|
-
* @memberof
|
|
431
|
+
* @memberof FulfillmentInboundApi
|
|
432
432
|
*/
|
|
433
|
-
getPrepInstructions(requestParameters:
|
|
433
|
+
getPrepInstructions(requestParameters: FulfillmentInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPrepInstructionsResponse, any>>;
|
|
434
434
|
/**
|
|
435
435
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
436
|
-
* @param {
|
|
436
|
+
* @param {FulfillmentInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
438
438
|
* @throws {RequiredError}
|
|
439
|
-
* @memberof
|
|
439
|
+
* @memberof FulfillmentInboundApi
|
|
440
440
|
*/
|
|
441
|
-
getShipmentItems(requestParameters:
|
|
441
|
+
getShipmentItems(requestParameters: FulfillmentInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentItemsResponse, any>>;
|
|
442
442
|
/**
|
|
443
443
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
444
|
-
* @param {
|
|
444
|
+
* @param {FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
445
445
|
* @param {*} [options] Override http request option.
|
|
446
446
|
* @throws {RequiredError}
|
|
447
|
-
* @memberof
|
|
447
|
+
* @memberof FulfillmentInboundApi
|
|
448
448
|
*/
|
|
449
|
-
getShipmentItemsByShipmentId(requestParameters:
|
|
449
|
+
getShipmentItemsByShipmentId(requestParameters: FulfillmentInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentItemsResponse, any>>;
|
|
450
450
|
/**
|
|
451
451
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | 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).
|
|
452
|
-
* @param {
|
|
452
|
+
* @param {FulfillmentInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
453
453
|
* @param {*} [options] Override http request option.
|
|
454
454
|
* @throws {RequiredError}
|
|
455
|
-
* @memberof
|
|
455
|
+
* @memberof FulfillmentInboundApi
|
|
456
456
|
*/
|
|
457
|
-
getShipments(requestParameters:
|
|
457
|
+
getShipments(requestParameters: FulfillmentInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentsResponse, any>>;
|
|
458
458
|
}
|
|
459
459
|
/**
|
|
460
460
|
* @export
|
package/dist/types/client.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type ClientConfiguration, type RateLimit } from '@sp-api-sdk/common';
|
|
2
|
-
import {
|
|
2
|
+
import { FulfillmentInboundApi } from './api-model';
|
|
3
3
|
export declare const clientRateLimits: RateLimit[];
|
|
4
|
-
export declare class FulfillmentInboundApiClient extends
|
|
4
|
+
export declare class FulfillmentInboundApiClient extends FulfillmentInboundApi {
|
|
5
5
|
constructor(configuration: ClientConfiguration);
|
|
6
6
|
}
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/fulfillment-inbound-api-v0",
|
|
3
3
|
"author": "Bertrand Marron <bertrand@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.",
|
|
5
|
-
"version": "
|
|
5
|
+
"version": "4.0.0",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -18,8 +18,8 @@
|
|
|
18
18
|
"dist/**/*.d.ts"
|
|
19
19
|
],
|
|
20
20
|
"dependencies": {
|
|
21
|
-
"@sp-api-sdk/common": "2.1.
|
|
22
|
-
"axios": "^1.
|
|
21
|
+
"@sp-api-sdk/common": "2.1.14",
|
|
22
|
+
"axios": "^1.9.0"
|
|
23
23
|
},
|
|
24
24
|
"repository": {
|
|
25
25
|
"type": "git",
|
|
@@ -40,5 +40,5 @@
|
|
|
40
40
|
"sp sdk",
|
|
41
41
|
"fulfillment inbound api"
|
|
42
42
|
],
|
|
43
|
-
"gitHead": "
|
|
43
|
+
"gitHead": "773f45c3f4aab28e0bd9f6033045988800d7f258"
|
|
44
44
|
}
|