@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
|
@@ -51,7 +51,7 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
51
51
|
};
|
|
52
52
|
},
|
|
53
53
|
/**
|
|
54
|
-
* 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 | | ---- | ---- | |
|
|
54
|
+
* 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).
|
|
55
55
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
56
56
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
57
57
|
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
@@ -408,7 +408,7 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
408
408
|
};
|
|
409
409
|
},
|
|
410
410
|
/**
|
|
411
|
-
* 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 | | ---- | ---- | |
|
|
411
|
+
* 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).
|
|
412
412
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
413
413
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
414
414
|
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
|
|
@@ -603,7 +603,7 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
603
603
|
};
|
|
604
604
|
},
|
|
605
605
|
/**
|
|
606
|
-
* 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 | | ---- | ---- | |
|
|
606
|
+
* 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).
|
|
607
607
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
608
608
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
609
609
|
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
@@ -903,7 +903,7 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
903
903
|
};
|
|
904
904
|
},
|
|
905
905
|
/**
|
|
906
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
906
|
+
* 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).
|
|
907
907
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
908
908
|
* @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).
|
|
909
909
|
* @param {*} [options] Override http request option.
|
|
@@ -1091,7 +1091,7 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1091
1091
|
};
|
|
1092
1092
|
},
|
|
1093
1093
|
/**
|
|
1094
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
1094
|
+
* 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).
|
|
1095
1095
|
* @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).
|
|
1096
1096
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
1097
1097
|
* @param {*} [options] Override http request option.
|
|
@@ -1331,7 +1331,7 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1331
1331
|
};
|
|
1332
1332
|
},
|
|
1333
1333
|
/**
|
|
1334
|
-
* 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 | | ---- | ---- | |
|
|
1334
|
+
* 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).
|
|
1335
1335
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1336
1336
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1337
1337
|
* @param {string} slotId An identifier to a self-ship appointment slot.
|
|
@@ -1433,6 +1433,43 @@ export const FulfillmentInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1433
1433
|
options: localVarRequestOptions,
|
|
1434
1434
|
};
|
|
1435
1435
|
},
|
|
1436
|
+
/**
|
|
1437
|
+
* 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).
|
|
1438
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
1439
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
1440
|
+
* @param {UpdateBoxIdentifiersRequest} body The body of the request to `updateBoxIdentifiers`.
|
|
1441
|
+
* @param {*} [options] Override http request option.
|
|
1442
|
+
* @throws {RequiredError}
|
|
1443
|
+
*/
|
|
1444
|
+
updateBoxIdentifiers: async (inboundPlanId, shipmentId, body, options = {}) => {
|
|
1445
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1446
|
+
assertParamExists('updateBoxIdentifiers', 'inboundPlanId', inboundPlanId);
|
|
1447
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1448
|
+
assertParamExists('updateBoxIdentifiers', 'shipmentId', shipmentId);
|
|
1449
|
+
// verify required parameter 'body' is not null or undefined
|
|
1450
|
+
assertParamExists('updateBoxIdentifiers', 'body', body);
|
|
1451
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxIdentifiers`
|
|
1452
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1453
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1454
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1455
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1456
|
+
let baseOptions;
|
|
1457
|
+
if (configuration) {
|
|
1458
|
+
baseOptions = configuration.baseOptions;
|
|
1459
|
+
}
|
|
1460
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1461
|
+
const localVarHeaderParameter = {};
|
|
1462
|
+
const localVarQueryParameter = {};
|
|
1463
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1464
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1465
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1466
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1467
|
+
localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration);
|
|
1468
|
+
return {
|
|
1469
|
+
url: toPathString(localVarUrlObj),
|
|
1470
|
+
options: localVarRequestOptions,
|
|
1471
|
+
};
|
|
1472
|
+
},
|
|
1436
1473
|
/**
|
|
1437
1474
|
* 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).
|
|
1438
1475
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
@@ -1633,7 +1670,7 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1633
1670
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1634
1671
|
},
|
|
1635
1672
|
/**
|
|
1636
|
-
* 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 | | ---- | ---- | |
|
|
1673
|
+
* 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).
|
|
1637
1674
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1638
1675
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1639
1676
|
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
@@ -1776,7 +1813,7 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1776
1813
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1777
1814
|
},
|
|
1778
1815
|
/**
|
|
1779
|
-
* 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 | | ---- | ---- | |
|
|
1816
|
+
* 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).
|
|
1780
1817
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1781
1818
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1782
1819
|
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
|
|
@@ -1854,7 +1891,7 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1854
1891
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1855
1892
|
},
|
|
1856
1893
|
/**
|
|
1857
|
-
* 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 | | ---- | ---- | |
|
|
1894
|
+
* 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).
|
|
1858
1895
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1859
1896
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1860
1897
|
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
@@ -1969,7 +2006,7 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
1969
2006
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1970
2007
|
},
|
|
1971
2008
|
/**
|
|
1972
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
2009
|
+
* 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).
|
|
1973
2010
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
1974
2011
|
* @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).
|
|
1975
2012
|
* @param {*} [options] Override http request option.
|
|
@@ -2040,7 +2077,7 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
2040
2077
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2041
2078
|
},
|
|
2042
2079
|
/**
|
|
2043
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
2080
|
+
* 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).
|
|
2044
2081
|
* @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).
|
|
2045
2082
|
* @param {Array<string>} mskus A list of merchant SKUs, a merchant-supplied identifier of a specific SKU.
|
|
2046
2083
|
* @param {*} [options] Override http request option.
|
|
@@ -2129,7 +2166,7 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
2129
2166
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2130
2167
|
},
|
|
2131
2168
|
/**
|
|
2132
|
-
* 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 | | ---- | ---- | |
|
|
2169
|
+
* 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).
|
|
2133
2170
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2134
2171
|
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2135
2172
|
* @param {string} slotId An identifier to a self-ship appointment slot.
|
|
@@ -2168,6 +2205,20 @@ export const FulfillmentInboundApiFp = function (configuration) {
|
|
|
2168
2205
|
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.setPrepDetails']?.[localVarOperationServerIndex]?.url;
|
|
2169
2206
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2170
2207
|
},
|
|
2208
|
+
/**
|
|
2209
|
+
* 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).
|
|
2210
|
+
* @param {string} inboundPlanId Identifier to an inbound plan.
|
|
2211
|
+
* @param {string} shipmentId Identifier to a shipment. A shipment contains the boxes and units being inbounded.
|
|
2212
|
+
* @param {UpdateBoxIdentifiersRequest} body The body of the request to `updateBoxIdentifiers`.
|
|
2213
|
+
* @param {*} [options] Override http request option.
|
|
2214
|
+
* @throws {RequiredError}
|
|
2215
|
+
*/
|
|
2216
|
+
async updateBoxIdentifiers(inboundPlanId, shipmentId, body, options) {
|
|
2217
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateBoxIdentifiers(inboundPlanId, shipmentId, body, options);
|
|
2218
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2219
|
+
const localVarOperationServerBasePath = operationServerMap['FulfillmentInboundApi.updateBoxIdentifiers']?.[localVarOperationServerIndex]?.url;
|
|
2220
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2221
|
+
},
|
|
2171
2222
|
/**
|
|
2172
2223
|
* 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).
|
|
2173
2224
|
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
@@ -2254,7 +2305,7 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2254
2305
|
return localVarFp.cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
2255
2306
|
},
|
|
2256
2307
|
/**
|
|
2257
|
-
* 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 | | ---- | ---- | |
|
|
2308
|
+
* 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).
|
|
2258
2309
|
* @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2259
2310
|
* @param {*} [options] Override http request option.
|
|
2260
2311
|
* @throws {RequiredError}
|
|
@@ -2353,7 +2404,7 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2353
2404
|
return localVarFp.generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2354
2405
|
},
|
|
2355
2406
|
/**
|
|
2356
|
-
* 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 | | ---- | ---- | |
|
|
2407
|
+
* 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).
|
|
2357
2408
|
* @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2358
2409
|
* @param {*} [options] Override http request option.
|
|
2359
2410
|
* @throws {RequiredError}
|
|
@@ -2407,7 +2458,7 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2407
2458
|
return localVarFp.getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
2408
2459
|
},
|
|
2409
2460
|
/**
|
|
2410
|
-
* 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 | | ---- | ---- | |
|
|
2461
|
+
* 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).
|
|
2411
2462
|
* @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2412
2463
|
* @param {*} [options] Override http request option.
|
|
2413
2464
|
* @throws {RequiredError}
|
|
@@ -2479,7 +2530,7 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2479
2530
|
return localVarFp.listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
|
|
2480
2531
|
},
|
|
2481
2532
|
/**
|
|
2482
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
2533
|
+
* 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).
|
|
2483
2534
|
* @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
2484
2535
|
* @param {*} [options] Override http request option.
|
|
2485
2536
|
* @throws {RequiredError}
|
|
@@ -2524,7 +2575,7 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2524
2575
|
return localVarFp.listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2525
2576
|
},
|
|
2526
2577
|
/**
|
|
2527
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
2578
|
+
* 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).
|
|
2528
2579
|
* @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
|
|
2529
2580
|
* @param {*} [options] Override http request option.
|
|
2530
2581
|
* @throws {RequiredError}
|
|
@@ -2578,7 +2629,7 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2578
2629
|
return localVarFp.listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
2579
2630
|
},
|
|
2580
2631
|
/**
|
|
2581
|
-
* 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 | | ---- | ---- | |
|
|
2632
|
+
* 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).
|
|
2582
2633
|
* @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2583
2634
|
* @param {*} [options] Override http request option.
|
|
2584
2635
|
* @throws {RequiredError}
|
|
@@ -2604,6 +2655,15 @@ export const FulfillmentInboundApiFactory = function (configuration, basePath, a
|
|
|
2604
2655
|
setPrepDetails(requestParameters, options) {
|
|
2605
2656
|
return localVarFp.setPrepDetails(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2606
2657
|
},
|
|
2658
|
+
/**
|
|
2659
|
+
* 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).
|
|
2660
|
+
* @param {FulfillmentInboundApiUpdateBoxIdentifiersRequest} requestParameters Request parameters.
|
|
2661
|
+
* @param {*} [options] Override http request option.
|
|
2662
|
+
* @throws {RequiredError}
|
|
2663
|
+
*/
|
|
2664
|
+
updateBoxIdentifiers(requestParameters, options) {
|
|
2665
|
+
return localVarFp.updateBoxIdentifiers(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2666
|
+
},
|
|
2607
2667
|
/**
|
|
2608
2668
|
* 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).
|
|
2609
2669
|
* @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
|
|
@@ -2665,7 +2725,7 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
2665
2725
|
return FulfillmentInboundApiFp(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
2666
2726
|
}
|
|
2667
2727
|
/**
|
|
2668
|
-
* 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 | | ---- | ---- | |
|
|
2728
|
+
* 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).
|
|
2669
2729
|
* @param {FulfillmentInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2670
2730
|
* @param {*} [options] Override http request option.
|
|
2671
2731
|
* @throws {RequiredError}
|
|
@@ -2764,7 +2824,7 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
2764
2824
|
return FulfillmentInboundApiFp(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2765
2825
|
}
|
|
2766
2826
|
/**
|
|
2767
|
-
* 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 | | ---- | ---- | |
|
|
2827
|
+
* 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).
|
|
2768
2828
|
* @param {FulfillmentInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2769
2829
|
* @param {*} [options] Override http request option.
|
|
2770
2830
|
* @throws {RequiredError}
|
|
@@ -2818,7 +2878,7 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
2818
2878
|
return FulfillmentInboundApiFp(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
2819
2879
|
}
|
|
2820
2880
|
/**
|
|
2821
|
-
* 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 | | ---- | ---- | |
|
|
2881
|
+
* 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).
|
|
2822
2882
|
* @param {FulfillmentInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
2823
2883
|
* @param {*} [options] Override http request option.
|
|
2824
2884
|
* @throws {RequiredError}
|
|
@@ -2890,7 +2950,7 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
2890
2950
|
return FulfillmentInboundApiFp(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
|
|
2891
2951
|
}
|
|
2892
2952
|
/**
|
|
2893
|
-
* List the inbound compliance details for MSKUs in a given marketplace.
|
|
2953
|
+
* 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).
|
|
2894
2954
|
* @param {FulfillmentInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
2895
2955
|
* @param {*} [options] Override http request option.
|
|
2896
2956
|
* @throws {RequiredError}
|
|
@@ -2935,7 +2995,7 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
2935
2995
|
return FulfillmentInboundApiFp(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2936
2996
|
}
|
|
2937
2997
|
/**
|
|
2938
|
-
* Get preparation details for a list of MSKUs in a specified marketplace.
|
|
2998
|
+
* 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).
|
|
2939
2999
|
* @param {FulfillmentInboundApiListPrepDetailsRequest} requestParameters Request parameters.
|
|
2940
3000
|
* @param {*} [options] Override http request option.
|
|
2941
3001
|
* @throws {RequiredError}
|
|
@@ -2989,7 +3049,7 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
2989
3049
|
return FulfillmentInboundApiFp(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
2990
3050
|
}
|
|
2991
3051
|
/**
|
|
2992
|
-
* 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 | | ---- | ---- | |
|
|
3052
|
+
* 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).
|
|
2993
3053
|
* @param {FulfillmentInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
2994
3054
|
* @param {*} [options] Override http request option.
|
|
2995
3055
|
* @throws {RequiredError}
|
|
@@ -3015,6 +3075,15 @@ export class FulfillmentInboundApi extends BaseAPI {
|
|
|
3015
3075
|
setPrepDetails(requestParameters, options) {
|
|
3016
3076
|
return FulfillmentInboundApiFp(this.configuration).setPrepDetails(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
3017
3077
|
}
|
|
3078
|
+
/**
|
|
3079
|
+
* 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).
|
|
3080
|
+
* @param {FulfillmentInboundApiUpdateBoxIdentifiersRequest} requestParameters Request parameters.
|
|
3081
|
+
* @param {*} [options] Override http request option.
|
|
3082
|
+
* @throws {RequiredError}
|
|
3083
|
+
*/
|
|
3084
|
+
updateBoxIdentifiers(requestParameters, options) {
|
|
3085
|
+
return FulfillmentInboundApiFp(this.configuration).updateBoxIdentifiers(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
3086
|
+
}
|
|
3018
3087
|
/**
|
|
3019
3088
|
* 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).
|
|
3020
3089
|
* @param {FulfillmentInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for FBA inbound operations.
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for FBA inbound operations.
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* Type of Box Identifier.
|
|
16
|
+
*/
|
|
17
|
+
export const BoxIdentifierType = {
|
|
18
|
+
Amazon: 'AMAZON',
|
|
19
|
+
Sscc: 'SSCC'
|
|
20
|
+
};
|
|
@@ -5,6 +5,8 @@ export * from './appointment-slot';
|
|
|
5
5
|
export * from './appointment-slot-time';
|
|
6
6
|
export * from './box';
|
|
7
7
|
export * from './box-content-information-source';
|
|
8
|
+
export * from './box-identifier-input';
|
|
9
|
+
export * from './box-identifier-type';
|
|
8
10
|
export * from './box-input';
|
|
9
11
|
export * from './box-requirements';
|
|
10
12
|
export * from './box-update-input';
|
|
@@ -126,6 +128,8 @@ export * from './transportation-option';
|
|
|
126
128
|
export * from './transportation-selection';
|
|
127
129
|
export * from './unit-of-measurement';
|
|
128
130
|
export * from './unit-of-weight';
|
|
131
|
+
export * from './update-box-identifiers-request';
|
|
132
|
+
export * from './update-box-identifiers-response';
|
|
129
133
|
export * from './update-inbound-plan-name-request';
|
|
130
134
|
export * from './update-item-compliance-details-request';
|
|
131
135
|
export * from './update-item-compliance-details-response';
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for FBA inbound operations.
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* The Selling Partner API for FBA inbound operations.
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2024-03-20
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
export {};
|
package/dist/es/client.js
CHANGED
|
@@ -211,34 +211,6 @@ export const clientRateLimits = [
|
|
|
211
211
|
rate: 2,
|
|
212
212
|
burst: 30,
|
|
213
213
|
},
|
|
214
|
-
{
|
|
215
|
-
method: 'put',
|
|
216
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
217
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/selfShipAppointmentCancellation$'),
|
|
218
|
-
rate: 2,
|
|
219
|
-
burst: 30,
|
|
220
|
-
},
|
|
221
|
-
{
|
|
222
|
-
method: 'get',
|
|
223
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
224
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/selfShipAppointmentSlots$'),
|
|
225
|
-
rate: 2,
|
|
226
|
-
burst: 6,
|
|
227
|
-
},
|
|
228
|
-
{
|
|
229
|
-
method: 'post',
|
|
230
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
231
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/selfShipAppointmentSlots$'),
|
|
232
|
-
rate: 2,
|
|
233
|
-
burst: 2,
|
|
234
|
-
},
|
|
235
|
-
{
|
|
236
|
-
method: 'post',
|
|
237
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
238
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/inboundPlans/[^/]*/schedule$'),
|
|
239
|
-
rate: 2,
|
|
240
|
-
burst: 2,
|
|
241
|
-
},
|
|
242
214
|
{
|
|
243
215
|
method: 'put',
|
|
244
216
|
// eslint-disable-next-line prefer-regex-literals
|
|
@@ -274,13 +246,6 @@ export const clientRateLimits = [
|
|
|
274
246
|
rate: 2,
|
|
275
247
|
burst: 2,
|
|
276
248
|
},
|
|
277
|
-
{
|
|
278
|
-
method: 'get',
|
|
279
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
280
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/items/compliance$'),
|
|
281
|
-
rate: 2,
|
|
282
|
-
burst: 6,
|
|
283
|
-
},
|
|
284
249
|
{
|
|
285
250
|
method: 'put',
|
|
286
251
|
// eslint-disable-next-line prefer-regex-literals
|
|
@@ -295,13 +260,6 @@ export const clientRateLimits = [
|
|
|
295
260
|
rate: 2,
|
|
296
261
|
burst: 30,
|
|
297
262
|
},
|
|
298
|
-
{
|
|
299
|
-
method: 'get',
|
|
300
|
-
// eslint-disable-next-line prefer-regex-literals
|
|
301
|
-
urlRegex: new RegExp('^/inbound/fba/2024-03-20/items/prepDetails$'),
|
|
302
|
-
rate: 2,
|
|
303
|
-
burst: 30,
|
|
304
|
-
},
|
|
305
263
|
{
|
|
306
264
|
method: 'post',
|
|
307
265
|
// eslint-disable-next-line prefer-regex-literals
|