@sp-api-sdk/fulfillment-inbound-api-2024-03-20 3.0.2 → 3.1.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/fulfillment-inbound-api.js +93 -24
- package/dist/cjs/api-model/models/box-identifier-input.js +15 -0
- package/dist/cjs/api-model/models/box-identifier-type.js +23 -0
- package/dist/cjs/api-model/models/index.js +4 -0
- package/dist/cjs/api-model/models/update-box-identifiers-request.js +15 -0
- package/dist/cjs/api-model/models/update-box-identifiers-response.js +15 -0
- package/dist/cjs/client.js +0 -42
- package/dist/es/api-model/api/fulfillment-inbound-api.js +93 -24
- package/dist/es/api-model/models/box-identifier-input.js +14 -0
- package/dist/es/api-model/models/box-identifier-type.js +20 -0
- package/dist/es/api-model/models/index.js +4 -0
- package/dist/es/api-model/models/update-box-identifiers-request.js +14 -0
- package/dist/es/api-model/models/update-box-identifiers-response.js +14 -0
- package/dist/es/client.js +0 -42
- package/dist/types/api-model/api/fulfillment-inbound-api.d.ts +75 -24
- package/dist/types/api-model/models/address-input.d.ts +4 -0
- package/dist/types/api-model/models/address.d.ts +4 -0
- package/dist/types/api-model/models/box-identifier-input.d.ts +26 -0
- package/dist/types/api-model/models/box-identifier-type.d.ts +19 -0
- package/dist/types/api-model/models/freight-information.d.ts +1 -1
- package/dist/types/api-model/models/index.d.ts +4 -0
- package/dist/types/api-model/models/item.d.ts +1 -1
- package/dist/types/api-model/models/shipment-destination.d.ts +1 -1
- package/dist/types/api-model/models/spd-tracking-item.d.ts +1 -1
- package/dist/types/api-model/models/update-box-identifiers-request.d.ts +21 -0
- package/dist/types/api-model/models/update-box-identifiers-response.d.ts +20 -0
- package/package.json +3 -3
|
@@ -57,7 +57,7 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
57
57
|
};
|
|
58
58
|
},
|
|
59
59
|
/**
|
|
60
|
-
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
60
|
+
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
61
61
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
62
62
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
63
63
|
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
@@ -414,7 +414,7 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
414
414
|
};
|
|
415
415
|
},
|
|
416
416
|
/**
|
|
417
|
-
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
417
|
+
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
418
418
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
419
419
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
420
420
|
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
|
|
@@ -609,7 +609,7 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
609
609
|
};
|
|
610
610
|
},
|
|
611
611
|
/**
|
|
612
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
612
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
613
613
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
614
614
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
615
615
|
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
@@ -909,7 +909,7 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
909
909
|
};
|
|
910
910
|
},
|
|
911
911
|
/**
|
|
912
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
912
|
+
* List the inbound compliance details for MSKUs in a given marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
913
913
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
914
914
|
* @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
915
915
|
* @param {*} [options] Override http request option.
|
|
@@ -1097,7 +1097,7 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1097
1097
|
};
|
|
1098
1098
|
},
|
|
1099
1099
|
/**
|
|
1100
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
1100
|
+
* Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1101
1101
|
* @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1102
1102
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
1103
1103
|
* @param {*} [options] Override http request option.
|
|
@@ -1337,7 +1337,7 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1337
1337
|
};
|
|
1338
1338
|
},
|
|
1339
1339
|
/**
|
|
1340
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1340
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1341
1341
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1342
1342
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1343
1343
|
* @param {string} slotId An identifier to a self-ship appointment slot.
|
|
@@ -1439,6 +1439,43 @@ const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1439
1439
|
options: localVarRequestOptions,
|
|
1440
1440
|
};
|
|
1441
1441
|
},
|
|
1442
|
+
/**
|
|
1443
|
+
* Update/Add custom identifier to the boxes within a shipment. These custom identifiers are provided by the clients and reflected on the box labels to identify boxes. One example of this custom identifier is the SSCC (Serial Shipping Container Codes) barcodes, with the encoding of GS1-128, which is an industry standard to uniquely identify boxes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1444
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
1445
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1446
|
+
* @param {UpdateBoxIdentifiersRequest} body The body of the request to `updateBoxIdentifiers`.
|
|
1447
|
+
* @param {*} [options] Override http request option.
|
|
1448
|
+
* @throws {RequiredError}
|
|
1449
|
+
*/
|
|
1450
|
+
updateBoxIdentifiers: async (inboundPlanId, shipmentId, body, options = {}) => {
|
|
1451
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1452
|
+
(0, common_1.assertParamExists)('updateBoxIdentifiers', 'inboundPlanId', inboundPlanId);
|
|
1453
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1454
|
+
(0, common_1.assertParamExists)('updateBoxIdentifiers', 'shipmentId', shipmentId);
|
|
1455
|
+
// verify required parameter 'body' is not null or undefined
|
|
1456
|
+
(0, common_1.assertParamExists)('updateBoxIdentifiers', 'body', body);
|
|
1457
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxIdentifiers`
|
|
1458
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1459
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1460
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1461
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1462
|
+
let baseOptions;
|
|
1463
|
+
if (configuration) {
|
|
1464
|
+
baseOptions = configuration.baseOptions;
|
|
1465
|
+
}
|
|
1466
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1467
|
+
const localVarHeaderParameter = {};
|
|
1468
|
+
const localVarQueryParameter = {};
|
|
1469
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1470
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1471
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1472
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1473
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
1474
|
+
return {
|
|
1475
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1476
|
+
options: localVarRequestOptions,
|
|
1477
|
+
};
|
|
1478
|
+
},
|
|
1442
1479
|
/**
|
|
1443
1480
|
* Updates the name of an existing inbound plan. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1444
1481
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
@@ -1640,7 +1677,7 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1640
1677
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1641
1678
|
},
|
|
1642
1679
|
/**
|
|
1643
|
-
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1680
|
+
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1644
1681
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1645
1682
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1646
1683
|
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
@@ -1783,7 +1820,7 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1783
1820
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1784
1821
|
},
|
|
1785
1822
|
/**
|
|
1786
|
-
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1823
|
+
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1787
1824
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1788
1825
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1789
1826
|
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
|
|
@@ -1861,7 +1898,7 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1861
1898
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1862
1899
|
},
|
|
1863
1900
|
/**
|
|
1864
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1901
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1865
1902
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1866
1903
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1867
1904
|
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
@@ -1976,7 +2013,7 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1976
2013
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1977
2014
|
},
|
|
1978
2015
|
/**
|
|
1979
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
2016
|
+
* List the inbound compliance details for MSKUs in a given marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
1980
2017
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
1981
2018
|
* @param {string} marketplaceId The Marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
1982
2019
|
* @param {*} [options] Override http request option.
|
|
@@ -2047,7 +2084,7 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
2047
2084
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2048
2085
|
},
|
|
2049
2086
|
/**
|
|
2050
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
2087
|
+
* Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2051
2088
|
* @param {string} marketplaceId The marketplace ID. For a list of possible values, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
2052
2089
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
2053
2090
|
* @param {*} [options] Override http request option.
|
|
@@ -2136,7 +2173,7 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
2136
2173
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2137
2174
|
},
|
|
2138
2175
|
/**
|
|
2139
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2176
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2140
2177
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2141
2178
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2142
2179
|
* @param {string} slotId An identifier to a self-ship appointment slot.
|
|
@@ -2175,6 +2212,20 @@ const FulfillmentInboundApiFp = function (configuration) {
|
|
|
2175
2212
|
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.setPrepDetails']?.[localVarOperationServerIndex]?.url;
|
|
2176
2213
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2177
2214
|
},
|
|
2215
|
+
/**
|
|
2216
|
+
* Update/Add custom identifier to the boxes within a shipment. These custom identifiers are provided by the clients and reflected on the box labels to identify boxes. One example of this custom identifier is the SSCC (Serial Shipping Container Codes) barcodes, with the encoding of GS1-128, which is an industry standard to uniquely identify boxes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2217
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
2218
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
2219
|
+
* @param {UpdateBoxIdentifiersRequest} body The body of the request to `updateBoxIdentifiers`.
|
|
2220
|
+
* @param {*} [options] Override http request option.
|
|
2221
|
+
* @throws {RequiredError}
|
|
2222
|
+
*/
|
|
2223
|
+
async updateBoxIdentifiers(inboundPlanId, shipmentId, body, options) {
|
|
2224
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateBoxIdentifiers(inboundPlanId, shipmentId, body, options);
|
|
2225
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2226
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FulfillmentInboundApi.updateBoxIdentifiers']?.[localVarOperationServerIndex]?.url;
|
|
2227
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2228
|
+
},
|
|
2178
2229
|
/**
|
|
2179
2230
|
* Updates the name of an existing inbound plan. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2180
2231
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
@@ -2262,7 +2313,7 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2262
2313
|
return localVarFp.cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
2263
2314
|
},
|
|
2264
2315
|
/**
|
|
2265
|
-
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2316
|
+
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2266
2317
|
* @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2267
2318
|
* @param {*} [options] Override http request option.
|
|
2268
2319
|
* @throws {RequiredError}
|
|
@@ -2361,7 +2412,7 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2361
2412
|
return localVarFp.generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2362
2413
|
},
|
|
2363
2414
|
/**
|
|
2364
|
-
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2415
|
+
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2365
2416
|
* @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2366
2417
|
* @param {*} [options] Override http request option.
|
|
2367
2418
|
* @throws {RequiredError}
|
|
@@ -2415,7 +2466,7 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2415
2466
|
return localVarFp.getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
2416
2467
|
},
|
|
2417
2468
|
/**
|
|
2418
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2469
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2419
2470
|
* @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2420
2471
|
* @param {*} [options] Override http request option.
|
|
2421
2472
|
* @throws {RequiredError}
|
|
@@ -2487,7 +2538,7 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2487
2538
|
return localVarFp.listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
|
|
2488
2539
|
},
|
|
2489
2540
|
/**
|
|
2490
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
2541
|
+
* List the inbound compliance details for MSKUs in a given marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2491
2542
|
* @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
2492
2543
|
* @param {*} [options] Override http request option.
|
|
2493
2544
|
* @throws {RequiredError}
|
|
@@ -2532,7 +2583,7 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2532
2583
|
return localVarFp.listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2533
2584
|
},
|
|
2534
2585
|
/**
|
|
2535
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
2586
|
+
* Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2536
2587
|
* @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
|
|
2537
2588
|
* @param {*} [options] Override http request option.
|
|
2538
2589
|
* @throws {RequiredError}
|
|
@@ -2586,7 +2637,7 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2586
2637
|
return localVarFp.listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
2587
2638
|
},
|
|
2588
2639
|
/**
|
|
2589
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2640
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2590
2641
|
* @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2591
2642
|
* @param {*} [options] Override http request option.
|
|
2592
2643
|
* @throws {RequiredError}
|
|
@@ -2612,6 +2663,15 @@ const FulfillmentInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
2612
2663
|
setPrepDetails(requestParameters, options) {
|
|
2613
2664
|
return localVarFp.setPrepDetails(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2614
2665
|
},
|
|
2666
|
+
/**
|
|
2667
|
+
* Update/Add custom identifier to the boxes within a shipment. These custom identifiers are provided by the clients and reflected on the box labels to identify boxes. One example of this custom identifier is the SSCC (Serial Shipping Container Codes) barcodes, with the encoding of GS1-128, which is an industry standard to uniquely identify boxes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2668
|
+
* @param {FulfillmentInboundApiUpdateBoxIdentifiersRequest} requestParameters Request parameters.
|
|
2669
|
+
* @param {*} [options] Override http request option.
|
|
2670
|
+
* @throws {RequiredError}
|
|
2671
|
+
*/
|
|
2672
|
+
updateBoxIdentifiers(requestParameters, options) {
|
|
2673
|
+
return localVarFp.updateBoxIdentifiers(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2674
|
+
},
|
|
2615
2675
|
/**
|
|
2616
2676
|
* Updates the name of an existing inbound plan. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2617
2677
|
* @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
|
|
@@ -2674,7 +2734,7 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
2674
2734
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
2675
2735
|
}
|
|
2676
2736
|
/**
|
|
2677
|
-
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2737
|
+
* Cancels a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2678
2738
|
* @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2679
2739
|
* @param {*} [options] Override http request option.
|
|
2680
2740
|
* @throws {RequiredError}
|
|
@@ -2773,7 +2833,7 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
2773
2833
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2774
2834
|
}
|
|
2775
2835
|
/**
|
|
2776
|
-
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2836
|
+
* Initiates the process of generating the appointment slots list. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2777
2837
|
* @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2778
2838
|
* @param {*} [options] Override http request option.
|
|
2779
2839
|
* @throws {RequiredError}
|
|
@@ -2827,7 +2887,7 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
2827
2887
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
2828
2888
|
}
|
|
2829
2889
|
/**
|
|
2830
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2890
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2831
2891
|
* @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2832
2892
|
* @param {*} [options] Override http request option.
|
|
2833
2893
|
* @throws {RequiredError}
|
|
@@ -2899,7 +2959,7 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
2899
2959
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
|
|
2900
2960
|
}
|
|
2901
2961
|
/**
|
|
2902
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
2962
|
+
* List the inbound compliance details for MSKUs in a given marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2903
2963
|
* @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
2904
2964
|
* @param {*} [options] Override http request option.
|
|
2905
2965
|
* @throws {RequiredError}
|
|
@@ -2944,7 +3004,7 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
2944
3004
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2945
3005
|
}
|
|
2946
3006
|
/**
|
|
2947
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
3007
|
+
* Get preparation details for a list of MSKUs in a specified marketplace.\\n\\n**Note:** MSKUs that contain certain characters must be encoded. For more information, refer to [URL Encoding](https://developer-docs.amazon.com/sp-api/docs/url-encoding).\\n\\nThe following characters must be double percent encoded:\\n\\n- `%`\\n- `+`\\n- `,`\\n\\n**Examples:** An MSKU value of `test%msku` is encoded as `test%2525msku`. An MSKU value of `test,msku` is encoded as `test%252Cmsku`.\\n\\n**Usage Plan:**\\n\\n| Rate (requests per second) | Burst |\\n| ---- | ---- |\\n| n | n |\\n\\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
2948
3008
|
* @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
|
|
2949
3009
|
* @param {*} [options] Override http request option.
|
|
2950
3010
|
* @throws {RequiredError}
|
|
@@ -2998,7 +3058,7 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
2998
3058
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
2999
3059
|
}
|
|
3000
3060
|
/**
|
|
3001
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
3061
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. Only available in the following [marketplaces](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids): MX, BR, EG, SA, AE, IN. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
3002
3062
|
* @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
3003
3063
|
* @param {*} [options] Override http request option.
|
|
3004
3064
|
* @throws {RequiredError}
|
|
@@ -3024,6 +3084,15 @@ class FulfillmentInboundApi extends base_1.BaseAPI {
|
|
|
3024
3084
|
setPrepDetails(requestParameters, options) {
|
|
3025
3085
|
return (0, exports.FulfillmentInboundApiFp)(this.configuration).setPrepDetails(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
3026
3086
|
}
|
|
3087
|
+
/**
|
|
3088
|
+
* Update/Add custom identifier to the boxes within a shipment. These custom identifiers are provided by the clients and reflected on the box labels to identify boxes. One example of this custom identifier is the SSCC (Serial Shipping Container Codes) barcodes, with the encoding of GS1-128, which is an industry standard to uniquely identify boxes. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | n | n | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
3089
|
+
* @param {FulfillmentInboundApiUpdateBoxIdentifiersRequest} requestParameters Request parameters.
|
|
3090
|
+
* @param {*} [options] Override http request option.
|
|
3091
|
+
* @throws {RequiredError}
|
|
3092
|
+
*/
|
|
3093
|
+
updateBoxIdentifiers(requestParameters, options) {
|
|
3094
|
+
return (0, exports.FulfillmentInboundApiFp)(this.configuration).updateBoxIdentifiers(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
3095
|
+
}
|
|
3027
3096
|
/**
|
|
3028
3097
|
* Updates the name of an existing inbound plan. **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 preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
3029
3098
|
* @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* The Selling Partner API for FBA inbound operations.
|
|
6
|
+
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* The Selling Partner API for FBA inbound operations.
|
|
6
|
+
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.BoxIdentifierType = void 0;
|
|
17
|
+
/**
|
|
18
|
+
* Type of Box Identifier.
|
|
19
|
+
*/
|
|
20
|
+
exports.BoxIdentifierType = {
|
|
21
|
+
Amazon: 'AMAZON',
|
|
22
|
+
Sscc: 'SSCC'
|
|
23
|
+
};
|
|
@@ -21,6 +21,8 @@ __exportStar(require("./appointment-slot"), exports);
|
|
|
21
21
|
__exportStar(require("./appointment-slot-time"), exports);
|
|
22
22
|
__exportStar(require("./box"), exports);
|
|
23
23
|
__exportStar(require("./box-content-information-source"), exports);
|
|
24
|
+
__exportStar(require("./box-identifier-input"), exports);
|
|
25
|
+
__exportStar(require("./box-identifier-type"), exports);
|
|
24
26
|
__exportStar(require("./box-input"), exports);
|
|
25
27
|
__exportStar(require("./box-requirements"), exports);
|
|
26
28
|
__exportStar(require("./box-update-input"), exports);
|
|
@@ -142,6 +144,8 @@ __exportStar(require("./transportation-option"), exports);
|
|
|
142
144
|
__exportStar(require("./transportation-selection"), exports);
|
|
143
145
|
__exportStar(require("./unit-of-measurement"), exports);
|
|
144
146
|
__exportStar(require("./unit-of-weight"), exports);
|
|
147
|
+
__exportStar(require("./update-box-identifiers-request"), exports);
|
|
148
|
+
__exportStar(require("./update-box-identifiers-response"), exports);
|
|
145
149
|
__exportStar(require("./update-inbound-plan-name-request"), exports);
|
|
146
150
|
__exportStar(require("./update-item-compliance-details-request"), exports);
|
|
147
151
|
__exportStar(require("./update-item-compliance-details-response"), exports);
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* The Selling Partner API for FBA inbound operations.
|
|
6
|
+
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* The Selling Partner API for FBA inbound operations.
|
|
6
|
+
* The Selling Partner API for Fulfillment By Amazon (FBA) Inbound. The FBA Inbound API enables building inbound workflows to create, manage, and send shipments into Amazon\'s fulfillment network. The API has interoperability with the Send-to-Amazon user interface.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/cjs/client.js
CHANGED
|
@@ -214,34 +214,6 @@ exports.clientRateLimits = [
|
|
|
214
214
|
rate: 2,
|
|
215
215
|
burst: 30,
|
|
216
216
|
},
|
|
217
|
-
{
|
|
218
|
-
method: 'put',
|
|
219
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
220
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/selfShipAppointmentCancellation$'),
|
|
221
|
-
rate: 2,
|
|
222
|
-
burst: 30,
|
|
223
|
-
},
|
|
224
|
-
{
|
|
225
|
-
method: 'get',
|
|
226
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
227
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/selfShipAppointmentSlots$'),
|
|
228
|
-
rate: 2,
|
|
229
|
-
burst: 6,
|
|
230
|
-
},
|
|
231
|
-
{
|
|
232
|
-
method: 'post',
|
|
233
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
234
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/selfShipAppointmentSlots$'),
|
|
235
|
-
rate: 2,
|
|
236
|
-
burst: 2,
|
|
237
|
-
},
|
|
238
|
-
{
|
|
239
|
-
method: 'post',
|
|
240
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
241
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/schedule$'),
|
|
242
|
-
rate: 2,
|
|
243
|
-
burst: 2,
|
|
244
|
-
},
|
|
245
217
|
{
|
|
246
218
|
method: 'put',
|
|
247
219
|
// eslint-disable-next-line prefer-regex-literals
|
|
@@ -277,13 +249,6 @@ exports.clientRateLimits = [
|
|
|
277
249
|
rate: 2,
|
|
278
250
|
burst: 2,
|
|
279
251
|
},
|
|
280
|
-
{
|
|
281
|
-
method: 'get',
|
|
282
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
283
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/items/compliance$'),
|
|
284
|
-
rate: 2,
|
|
285
|
-
burst: 6,
|
|
286
|
-
},
|
|
287
252
|
{
|
|
288
253
|
method: 'put',
|
|
289
254
|
// eslint-disable-next-line prefer-regex-literals
|
|
@@ -298,13 +263,6 @@ exports.clientRateLimits = [
|
|
|
298
263
|
rate: 2,
|
|
299
264
|
burst: 30,
|
|
300
265
|
},
|
|
301
|
-
{
|
|
302
|
-
method: 'get',
|
|
303
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
304
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/items/prepDetails$'),
|
|
305
|
-
rate: 2,
|
|
306
|
-
burst: 30,
|
|
307
|
-
},
|
|
308
266
|
{
|
|
309
267
|
method: 'post',
|
|
310
268
|
// eslint-disable-next-line prefer-regex-literals
|