@sp-api-sdk/fulfillment-inbound-api-2024-03-20 1.1.0 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/api-model/api/fba-inbound-api.js +1210 -240
- package/dist/cjs/src/api-model/models/confirm-shipment-content-update-preview-response.js +15 -0
- package/dist/cjs/src/api-model/models/content-update-preview.js +15 -0
- package/dist/cjs/src/api-model/models/create-marketplace-item-labels-request.js +15 -0
- package/dist/cjs/src/api-model/models/create-marketplace-item-labels-response.js +15 -0
- package/dist/cjs/src/api-model/models/delivery-window-option.js +15 -0
- package/dist/cjs/src/api-model/models/freight-information.js +15 -0
- package/dist/cjs/src/api-model/models/generate-delivery-window-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/generate-shipment-content-update-previews-request.js +15 -0
- package/dist/cjs/src/api-model/models/generate-shipment-content-update-previews-response.js +15 -0
- package/dist/cjs/src/api-model/models/index.js +28 -4
- package/dist/cjs/src/api-model/models/item-label-page-type.js +34 -0
- package/dist/cjs/src/api-model/models/label-owner.js +3 -2
- package/dist/cjs/src/api-model/models/label-print-type.js +25 -0
- package/dist/cjs/src/api-model/models/list-delivery-window-options-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-packing-group-boxes-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-shipment-boxes-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-shipment-content-update-previews-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-shipment-items-response.js +15 -0
- package/dist/cjs/src/api-model/models/list-shipment-pallets-response.js +15 -0
- package/dist/cjs/src/api-model/models/msku-quantity.js +15 -0
- package/dist/cjs/src/api-model/models/prep-owner.js +3 -2
- package/dist/cjs/src/api-model/models/requested-updates.js +15 -0
- package/dist/cjs/src/api-model/models/selected-delivery-window.js +15 -0
- package/dist/cjs/src/api-model/models/update-inbound-plan-name-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-name-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-source-address-request.js +15 -0
- package/dist/cjs/src/api-model/models/update-shipment-source-address-response.js +15 -0
- package/dist/cjs/src/client.js +166 -68
- package/dist/es/src/api-model/api/fba-inbound-api.js +1210 -240
- package/dist/es/src/api-model/models/confirm-shipment-content-update-preview-response.js +14 -0
- package/dist/es/src/api-model/models/content-update-preview.js +14 -0
- package/dist/es/src/api-model/models/create-marketplace-item-labels-request.js +14 -0
- package/dist/es/src/api-model/models/create-marketplace-item-labels-response.js +14 -0
- package/dist/es/src/api-model/models/delivery-window-option.js +14 -0
- package/dist/es/src/api-model/models/freight-information.js +14 -0
- package/dist/es/src/api-model/models/generate-delivery-window-options-response.js +14 -0
- package/dist/es/src/api-model/models/generate-shipment-content-update-previews-request.js +14 -0
- package/dist/es/src/api-model/models/generate-shipment-content-update-previews-response.js +14 -0
- package/dist/es/src/api-model/models/index.js +28 -4
- package/dist/es/src/api-model/models/item-label-page-type.js +31 -0
- package/dist/es/src/api-model/models/label-owner.js +3 -2
- package/dist/es/src/api-model/models/label-print-type.js +22 -0
- package/dist/es/src/api-model/models/list-delivery-window-options-response.js +14 -0
- package/dist/es/src/api-model/models/list-packing-group-boxes-response.js +14 -0
- package/dist/es/src/api-model/models/list-shipment-boxes-response.js +14 -0
- package/dist/es/src/api-model/models/list-shipment-content-update-previews-response.js +14 -0
- package/dist/es/src/api-model/models/list-shipment-items-response.js +14 -0
- package/dist/es/src/api-model/models/list-shipment-pallets-response.js +14 -0
- package/dist/es/src/api-model/models/msku-quantity.js +14 -0
- package/dist/es/src/api-model/models/prep-owner.js +3 -2
- package/dist/es/src/api-model/models/requested-updates.js +14 -0
- package/dist/es/src/api-model/models/selected-delivery-window.js +14 -0
- package/dist/es/src/api-model/models/update-inbound-plan-name-request.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-name-request.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-source-address-request.js +14 -0
- package/dist/es/src/api-model/models/update-shipment-source-address-response.js +14 -0
- package/dist/es/src/client.js +166 -68
- package/dist/types/src/api-model/api/fba-inbound-api.d.ts +1106 -278
- package/dist/types/src/api-model/common.d.ts +0 -1
- package/dist/types/src/api-model/models/address-input.d.ts +78 -0
- package/dist/types/src/api-model/models/address.d.ts +13 -1
- package/dist/types/src/api-model/models/appointment-slot-time.d.ts +1 -1
- package/dist/types/src/api-model/models/box-input.d.ts +7 -19
- package/dist/types/src/api-model/models/box-update-input.d.ts +58 -0
- package/dist/types/src/api-model/models/box.d.ts +9 -2
- package/dist/types/src/api-model/models/cancel-self-ship-appointment-response.d.ts +1 -1
- package/dist/types/src/api-model/models/carrier-appointment.d.ts +30 -0
- package/dist/types/src/api-model/models/{update-shipment-delivery-window-response.d.ts → confirm-delivery-window-options-response.d.ts} +4 -4
- package/dist/types/src/api-model/models/confirm-shipment-content-update-preview-response.d.ts +24 -0
- package/dist/types/src/api-model/models/contact-information.d.ts +4 -4
- package/dist/types/src/api-model/models/content-update-preview.d.ts +44 -0
- package/dist/types/src/api-model/models/create-inbound-plan-request.d.ts +3 -10
- package/dist/types/src/api-model/models/create-inbound-plan-response.d.ts +1 -1
- package/dist/types/src/api-model/models/create-marketplace-item-labels-request.d.ts +63 -0
- package/dist/types/src/api-model/models/create-marketplace-item-labels-response.d.ts +25 -0
- package/dist/types/src/api-model/models/dates.d.ts +1 -7
- package/dist/types/src/api-model/models/delivery-window-option.d.ts +48 -0
- package/dist/types/src/api-model/models/dimensions.d.ts +4 -4
- package/dist/types/src/api-model/models/document-download.d.ts +1 -1
- package/dist/types/src/api-model/models/{pallet-information.d.ts → freight-information.d.ts} +6 -13
- package/dist/types/src/api-model/models/generate-delivery-window-options-response.d.ts +24 -0
- package/dist/types/src/api-model/models/generate-placement-options-request.d.ts +1 -1
- package/dist/types/src/api-model/models/generate-shipment-content-update-previews-request.d.ts +32 -0
- package/dist/types/src/api-model/models/generate-shipment-content-update-previews-response.d.ts +24 -0
- package/dist/types/src/api-model/models/inbound-operation-status.d.ts +3 -3
- package/dist/types/src/api-model/models/inbound-plan-summary.d.ts +3 -10
- package/dist/types/src/api-model/models/inbound-plan.d.ts +6 -13
- package/dist/types/src/api-model/models/incentive.d.ts +1 -1
- package/dist/types/src/api-model/models/index.d.ts +28 -4
- package/dist/types/src/api-model/models/item-input.d.ts +2 -2
- package/dist/types/src/api-model/models/item-label-page-type.d.ts +30 -0
- package/dist/types/src/api-model/models/item.d.ts +1 -1
- package/dist/types/src/api-model/models/label-owner.d.ts +2 -1
- package/dist/types/src/api-model/models/label-print-type.d.ts +21 -0
- package/dist/types/src/api-model/models/list-delivery-window-options-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-inbound-plan-boxes-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-inbound-plan-items-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-inbound-plan-pallets-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-inbound-plans-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-item-compliance-details-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-packing-group-boxes-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-packing-group-items-response.d.ts +2 -2
- package/dist/types/src/api-model/models/list-packing-options-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-placement-options-response.d.ts +1 -1
- package/dist/types/src/api-model/models/list-shipment-boxes-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-shipment-content-update-previews-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-shipment-items-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-shipment-pallets-response.d.ts +32 -0
- package/dist/types/src/api-model/models/list-transportation-options-response.d.ts +1 -1
- package/dist/types/src/api-model/models/msku-quantity.d.ts +30 -0
- package/dist/types/src/api-model/models/operation-problem.d.ts +1 -1
- package/dist/types/src/api-model/models/packing-option-summary.d.ts +1 -1
- package/dist/types/src/api-model/models/packing-option.d.ts +3 -9
- package/dist/types/src/api-model/models/pallet-input.d.ts +1 -1
- package/dist/types/src/api-model/models/placement-option-summary.d.ts +2 -2
- package/dist/types/src/api-model/models/placement-option.d.ts +3 -3
- package/dist/types/src/api-model/models/prep-instruction.d.ts +2 -2
- package/dist/types/src/api-model/models/prep-owner.d.ts +2 -1
- package/dist/types/src/api-model/models/quote.d.ts +1 -1
- package/dist/types/src/api-model/models/requested-updates.d.ts +32 -0
- package/dist/types/src/api-model/models/schedule-self-ship-appointment-request.d.ts +1 -1
- package/dist/types/src/api-model/models/schedule-self-ship-appointment-response.d.ts +1 -1
- package/dist/types/src/api-model/models/selected-delivery-window.d.ts +48 -0
- package/dist/types/src/api-model/models/self-ship-appointment-slots-availability.d.ts +1 -1
- package/dist/types/src/api-model/models/set-packing-information-request.d.ts +2 -2
- package/dist/types/src/api-model/models/set-packing-information-response.d.ts +1 -1
- package/dist/types/src/api-model/models/shipment-destination.d.ts +2 -2
- package/dist/types/src/api-model/models/shipment-source.d.ts +1 -1
- package/dist/types/src/api-model/models/shipment-summary.d.ts +2 -2
- package/dist/types/src/api-model/models/shipment-transportation-configuration.d.ts +11 -4
- package/dist/types/src/api-model/models/shipment.d.ts +14 -13
- package/dist/types/src/api-model/models/shipping-configuration.d.ts +2 -2
- package/dist/types/src/api-model/models/spd-tracking-item-input.d.ts +1 -1
- package/dist/types/src/api-model/models/spd-tracking-item.d.ts +2 -2
- package/dist/types/src/api-model/models/tax-rate.d.ts +1 -1
- package/dist/types/src/api-model/models/transportation-option.d.ts +11 -17
- package/dist/types/src/api-model/models/transportation-selection.d.ts +0 -7
- package/dist/types/src/api-model/models/update-inbound-plan-name-request.d.ts +24 -0
- package/dist/types/src/api-model/models/update-shipment-name-request.d.ts +24 -0
- package/dist/types/src/api-model/models/{update-shipment-delivery-window-request.d.ts → update-shipment-source-address-request.d.ts} +7 -7
- package/dist/types/src/api-model/models/update-shipment-source-address-response.d.ts +24 -0
- package/package.json +4 -4
- package/dist/types/src/api-model/models/box-content.d.ts +0 -56
- /package/dist/cjs/src/api-model/models/{box-content.js → address-input.js} +0 -0
- /package/dist/cjs/src/api-model/models/{pallet-information.js → box-update-input.js} +0 -0
- /package/dist/cjs/src/api-model/models/{update-shipment-delivery-window-request.js → carrier-appointment.js} +0 -0
- /package/dist/cjs/src/api-model/models/{update-shipment-delivery-window-response.js → confirm-delivery-window-options-response.js} +0 -0
- /package/dist/es/src/api-model/models/{box-content.js → address-input.js} +0 -0
- /package/dist/es/src/api-model/models/{pallet-information.js → box-update-input.js} +0 -0
- /package/dist/es/src/api-model/models/{update-shipment-delivery-window-request.js → carrier-appointment.js} +0 -0
- /package/dist/es/src/api-model/models/{update-shipment-delivery-window-response.js → confirm-delivery-window-options-response.js} +0 -0
|
@@ -30,8 +30,8 @@ const base_1 = require("../base");
|
|
|
30
30
|
const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
31
31
|
return {
|
|
32
32
|
/**
|
|
33
|
-
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
|
|
34
|
-
* @param {string} inboundPlanId Identifier
|
|
33
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
35
35
|
* @param {*} [options] Override http request option.
|
|
36
36
|
* @throws {RequiredError}
|
|
37
37
|
*/
|
|
@@ -58,27 +58,23 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
58
58
|
};
|
|
59
59
|
},
|
|
60
60
|
/**
|
|
61
|
-
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
62
|
-
* @param {string} inboundPlanId Identifier
|
|
63
|
-
* @param {string} shipmentId Identifier
|
|
64
|
-
* @param {string} slotId Identifier to a self-ship appointment slot.
|
|
61
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
63
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
65
64
|
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
66
65
|
* @param {*} [options] Override http request option.
|
|
67
66
|
* @throws {RequiredError}
|
|
68
67
|
*/
|
|
69
|
-
cancelSelfShipAppointment: async (inboundPlanId, shipmentId,
|
|
68
|
+
cancelSelfShipAppointment: async (inboundPlanId, shipmentId, body, options = {}) => {
|
|
70
69
|
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
71
70
|
(0, common_1.assertParamExists)('cancelSelfShipAppointment', 'inboundPlanId', inboundPlanId);
|
|
72
71
|
// verify required parameter 'shipmentId' is not null or undefined
|
|
73
72
|
(0, common_1.assertParamExists)('cancelSelfShipAppointment', 'shipmentId', shipmentId);
|
|
74
|
-
// verify required parameter 'slotId' is not null or undefined
|
|
75
|
-
(0, common_1.assertParamExists)('cancelSelfShipAppointment', 'slotId', slotId);
|
|
76
73
|
// verify required parameter 'body' is not null or undefined
|
|
77
74
|
(0, common_1.assertParamExists)('cancelSelfShipAppointment', 'body', body);
|
|
78
|
-
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/
|
|
75
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/selfShipAppointmentCancellation`
|
|
79
76
|
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
80
|
-
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
|
|
81
|
-
.replace(`{${"slotId"}}`, encodeURIComponent(String(slotId)));
|
|
77
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
82
78
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
83
79
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
84
80
|
let baseOptions;
|
|
@@ -99,9 +95,45 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
99
95
|
};
|
|
100
96
|
},
|
|
101
97
|
/**
|
|
102
|
-
* Confirms the
|
|
103
|
-
* @param {string} inboundPlanId Identifier
|
|
104
|
-
* @param {string}
|
|
98
|
+
* Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
99
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
100
|
+
* @param {string} shipmentId The shipment to confirm the delivery window option for.
|
|
101
|
+
* @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed.
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
confirmDeliveryWindowOptions: async (inboundPlanId, shipmentId, deliveryWindowOptionId, options = {}) => {
|
|
106
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
107
|
+
(0, common_1.assertParamExists)('confirmDeliveryWindowOptions', 'inboundPlanId', inboundPlanId);
|
|
108
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
109
|
+
(0, common_1.assertParamExists)('confirmDeliveryWindowOptions', 'shipmentId', shipmentId);
|
|
110
|
+
// verify required parameter 'deliveryWindowOptionId' is not null or undefined
|
|
111
|
+
(0, common_1.assertParamExists)('confirmDeliveryWindowOptions', 'deliveryWindowOptionId', deliveryWindowOptionId);
|
|
112
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions/{deliveryWindowOptionId}/confirmation`
|
|
113
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
114
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
|
|
115
|
+
.replace(`{${"deliveryWindowOptionId"}}`, encodeURIComponent(String(deliveryWindowOptionId)));
|
|
116
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
117
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
|
+
let baseOptions;
|
|
119
|
+
if (configuration) {
|
|
120
|
+
baseOptions = configuration.baseOptions;
|
|
121
|
+
}
|
|
122
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
123
|
+
const localVarHeaderParameter = {};
|
|
124
|
+
const localVarQueryParameter = {};
|
|
125
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
126
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
127
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
128
|
+
return {
|
|
129
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
130
|
+
options: localVarRequestOptions,
|
|
131
|
+
};
|
|
132
|
+
},
|
|
133
|
+
/**
|
|
134
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
135
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
136
|
+
* @param {string} packingOptionId Identifier of a packing option.
|
|
105
137
|
* @param {*} [options] Override http request option.
|
|
106
138
|
* @throws {RequiredError}
|
|
107
139
|
*/
|
|
@@ -131,9 +163,9 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
131
163
|
};
|
|
132
164
|
},
|
|
133
165
|
/**
|
|
134
|
-
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
135
|
-
* @param {string} inboundPlanId Identifier
|
|
136
|
-
* @param {string} placementOptionId
|
|
166
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
167
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
168
|
+
* @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
|
|
137
169
|
* @param {*} [options] Override http request option.
|
|
138
170
|
* @throws {RequiredError}
|
|
139
171
|
*/
|
|
@@ -163,8 +195,44 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
163
195
|
};
|
|
164
196
|
},
|
|
165
197
|
/**
|
|
166
|
-
*
|
|
167
|
-
* @param {string} inboundPlanId Identifier
|
|
198
|
+
* Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
199
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
200
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
201
|
+
* @param {string} contentUpdatePreviewId Identifier of a content update preview.
|
|
202
|
+
* @param {*} [options] Override http request option.
|
|
203
|
+
* @throws {RequiredError}
|
|
204
|
+
*/
|
|
205
|
+
confirmShipmentContentUpdatePreview: async (inboundPlanId, shipmentId, contentUpdatePreviewId, options = {}) => {
|
|
206
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
207
|
+
(0, common_1.assertParamExists)('confirmShipmentContentUpdatePreview', 'inboundPlanId', inboundPlanId);
|
|
208
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
209
|
+
(0, common_1.assertParamExists)('confirmShipmentContentUpdatePreview', 'shipmentId', shipmentId);
|
|
210
|
+
// verify required parameter 'contentUpdatePreviewId' is not null or undefined
|
|
211
|
+
(0, common_1.assertParamExists)('confirmShipmentContentUpdatePreview', 'contentUpdatePreviewId', contentUpdatePreviewId);
|
|
212
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}/confirmation`
|
|
213
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
214
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
|
|
215
|
+
.replace(`{${"contentUpdatePreviewId"}}`, encodeURIComponent(String(contentUpdatePreviewId)));
|
|
216
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
217
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
218
|
+
let baseOptions;
|
|
219
|
+
if (configuration) {
|
|
220
|
+
baseOptions = configuration.baseOptions;
|
|
221
|
+
}
|
|
222
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
223
|
+
const localVarHeaderParameter = {};
|
|
224
|
+
const localVarQueryParameter = {};
|
|
225
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
226
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
227
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
228
|
+
return {
|
|
229
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
230
|
+
options: localVarRequestOptions,
|
|
231
|
+
};
|
|
232
|
+
},
|
|
233
|
+
/**
|
|
234
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
235
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
168
236
|
* @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`.
|
|
169
237
|
* @param {*} [options] Override http request option.
|
|
170
238
|
* @throws {RequiredError}
|
|
@@ -196,7 +264,7 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
196
264
|
};
|
|
197
265
|
},
|
|
198
266
|
/**
|
|
199
|
-
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
267
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
200
268
|
* @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
|
|
201
269
|
* @param {*} [options] Override http request option.
|
|
202
270
|
* @throws {RequiredError}
|
|
@@ -225,8 +293,69 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
225
293
|
};
|
|
226
294
|
},
|
|
227
295
|
/**
|
|
228
|
-
*
|
|
229
|
-
* @param {
|
|
296
|
+
* For a given marketplace - creates labels for a list of mskus. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
297
|
+
* @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`.
|
|
298
|
+
* @param {*} [options] Override http request option.
|
|
299
|
+
* @throws {RequiredError}
|
|
300
|
+
*/
|
|
301
|
+
createMarketplaceItemLabels: async (body, options = {}) => {
|
|
302
|
+
// verify required parameter 'body' is not null or undefined
|
|
303
|
+
(0, common_1.assertParamExists)('createMarketplaceItemLabels', 'body', body);
|
|
304
|
+
const localVarPath = `/inbound/fba/2024-03-20/items/labels`;
|
|
305
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
306
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
307
|
+
let baseOptions;
|
|
308
|
+
if (configuration) {
|
|
309
|
+
baseOptions = configuration.baseOptions;
|
|
310
|
+
}
|
|
311
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
312
|
+
const localVarHeaderParameter = {};
|
|
313
|
+
const localVarQueryParameter = {};
|
|
314
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
315
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
316
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
317
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
318
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
319
|
+
return {
|
|
320
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
321
|
+
options: localVarRequestOptions,
|
|
322
|
+
};
|
|
323
|
+
},
|
|
324
|
+
/**
|
|
325
|
+
* Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
326
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
327
|
+
* @param {string} shipmentId The shipment to generate delivery window options for.
|
|
328
|
+
* @param {*} [options] Override http request option.
|
|
329
|
+
* @throws {RequiredError}
|
|
330
|
+
*/
|
|
331
|
+
generateDeliveryWindowOptions: async (inboundPlanId, shipmentId, options = {}) => {
|
|
332
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
333
|
+
(0, common_1.assertParamExists)('generateDeliveryWindowOptions', 'inboundPlanId', inboundPlanId);
|
|
334
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
335
|
+
(0, common_1.assertParamExists)('generateDeliveryWindowOptions', 'shipmentId', shipmentId);
|
|
336
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions`
|
|
337
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
338
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
339
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
340
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
341
|
+
let baseOptions;
|
|
342
|
+
if (configuration) {
|
|
343
|
+
baseOptions = configuration.baseOptions;
|
|
344
|
+
}
|
|
345
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
346
|
+
const localVarHeaderParameter = {};
|
|
347
|
+
const localVarQueryParameter = {};
|
|
348
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
349
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
350
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
351
|
+
return {
|
|
352
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
353
|
+
options: localVarRequestOptions,
|
|
354
|
+
};
|
|
355
|
+
},
|
|
356
|
+
/**
|
|
357
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
358
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
230
359
|
* @param {*} [options] Override http request option.
|
|
231
360
|
* @throws {RequiredError}
|
|
232
361
|
*/
|
|
@@ -253,8 +382,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
253
382
|
};
|
|
254
383
|
},
|
|
255
384
|
/**
|
|
256
|
-
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
257
|
-
* @param {string} inboundPlanId Identifier
|
|
385
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
386
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
258
387
|
* @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`.
|
|
259
388
|
* @param {*} [options] Override http request option.
|
|
260
389
|
* @throws {RequiredError}
|
|
@@ -286,10 +415,10 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
286
415
|
};
|
|
287
416
|
},
|
|
288
417
|
/**
|
|
289
|
-
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
290
|
-
* @param {string} inboundPlanId Identifier
|
|
291
|
-
* @param {string} shipmentId Identifier
|
|
292
|
-
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`.
|
|
418
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
419
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
420
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
421
|
+
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
|
|
293
422
|
* @param {*} [options] Override http request option.
|
|
294
423
|
* @throws {RequiredError}
|
|
295
424
|
*/
|
|
@@ -323,8 +452,45 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
323
452
|
};
|
|
324
453
|
},
|
|
325
454
|
/**
|
|
326
|
-
*
|
|
327
|
-
* @param {string} inboundPlanId Identifier
|
|
455
|
+
* Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
456
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
457
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
458
|
+
* @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`.
|
|
459
|
+
* @param {*} [options] Override http request option.
|
|
460
|
+
* @throws {RequiredError}
|
|
461
|
+
*/
|
|
462
|
+
generateShipmentContentUpdatePreviews: async (inboundPlanId, shipmentId, body, options = {}) => {
|
|
463
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
464
|
+
(0, common_1.assertParamExists)('generateShipmentContentUpdatePreviews', 'inboundPlanId', inboundPlanId);
|
|
465
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
466
|
+
(0, common_1.assertParamExists)('generateShipmentContentUpdatePreviews', 'shipmentId', shipmentId);
|
|
467
|
+
// verify required parameter 'body' is not null or undefined
|
|
468
|
+
(0, common_1.assertParamExists)('generateShipmentContentUpdatePreviews', 'body', body);
|
|
469
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews`
|
|
470
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
471
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
472
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
473
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
474
|
+
let baseOptions;
|
|
475
|
+
if (configuration) {
|
|
476
|
+
baseOptions = configuration.baseOptions;
|
|
477
|
+
}
|
|
478
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
479
|
+
const localVarHeaderParameter = {};
|
|
480
|
+
const localVarQueryParameter = {};
|
|
481
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
482
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
483
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
484
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
485
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
486
|
+
return {
|
|
487
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
488
|
+
options: localVarRequestOptions,
|
|
489
|
+
};
|
|
490
|
+
},
|
|
491
|
+
/**
|
|
492
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
493
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
328
494
|
* @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`.
|
|
329
495
|
* @param {*} [options] Override http request option.
|
|
330
496
|
* @throws {RequiredError}
|
|
@@ -356,9 +522,9 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
356
522
|
};
|
|
357
523
|
},
|
|
358
524
|
/**
|
|
359
|
-
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
360
|
-
* @param {string} inboundPlanId Identifier
|
|
361
|
-
* @param {string} shipmentId Identifier
|
|
525
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
526
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
527
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
362
528
|
* @param {*} [options] Override http request option.
|
|
363
529
|
* @throws {RequiredError}
|
|
364
530
|
*/
|
|
@@ -388,8 +554,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
388
554
|
};
|
|
389
555
|
},
|
|
390
556
|
/**
|
|
391
|
-
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
392
|
-
* @param {string} operationId Identifier
|
|
557
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
558
|
+
* @param {string} operationId Identifier of an asynchronous operation.
|
|
393
559
|
* @param {*} [options] Override http request option.
|
|
394
560
|
* @throws {RequiredError}
|
|
395
561
|
*/
|
|
@@ -416,8 +582,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
416
582
|
};
|
|
417
583
|
},
|
|
418
584
|
/**
|
|
419
|
-
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
420
|
-
* @param {string} inboundPlanId Identifier
|
|
585
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
586
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
421
587
|
* @param {*} [options] Override http request option.
|
|
422
588
|
* @throws {RequiredError}
|
|
423
589
|
*/
|
|
@@ -444,9 +610,9 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
444
610
|
};
|
|
445
611
|
},
|
|
446
612
|
/**
|
|
447
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
448
|
-
* @param {string} inboundPlanId Identifier
|
|
449
|
-
* @param {string} shipmentId Identifier
|
|
613
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
614
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
615
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
450
616
|
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
451
617
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
452
618
|
* @param {*} [options] Override http request option.
|
|
@@ -484,9 +650,9 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
484
650
|
};
|
|
485
651
|
},
|
|
486
652
|
/**
|
|
487
|
-
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
488
|
-
* @param {string} inboundPlanId Identifier
|
|
489
|
-
* @param {string} shipmentId Identifier
|
|
653
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
654
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
655
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
490
656
|
* @param {*} [options] Override http request option.
|
|
491
657
|
* @throws {RequiredError}
|
|
492
658
|
*/
|
|
@@ -516,8 +682,84 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
516
682
|
};
|
|
517
683
|
},
|
|
518
684
|
/**
|
|
519
|
-
*
|
|
520
|
-
* @param {string} inboundPlanId Identifier
|
|
685
|
+
* Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
686
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
687
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
688
|
+
* @param {string} contentUpdatePreviewId Identifier of a content update preview.
|
|
689
|
+
* @param {*} [options] Override http request option.
|
|
690
|
+
* @throws {RequiredError}
|
|
691
|
+
*/
|
|
692
|
+
getShipmentContentUpdatePreview: async (inboundPlanId, shipmentId, contentUpdatePreviewId, options = {}) => {
|
|
693
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
694
|
+
(0, common_1.assertParamExists)('getShipmentContentUpdatePreview', 'inboundPlanId', inboundPlanId);
|
|
695
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
696
|
+
(0, common_1.assertParamExists)('getShipmentContentUpdatePreview', 'shipmentId', shipmentId);
|
|
697
|
+
// verify required parameter 'contentUpdatePreviewId' is not null or undefined
|
|
698
|
+
(0, common_1.assertParamExists)('getShipmentContentUpdatePreview', 'contentUpdatePreviewId', contentUpdatePreviewId);
|
|
699
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews/{contentUpdatePreviewId}`
|
|
700
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
701
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)))
|
|
702
|
+
.replace(`{${"contentUpdatePreviewId"}}`, encodeURIComponent(String(contentUpdatePreviewId)));
|
|
703
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
704
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
705
|
+
let baseOptions;
|
|
706
|
+
if (configuration) {
|
|
707
|
+
baseOptions = configuration.baseOptions;
|
|
708
|
+
}
|
|
709
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
710
|
+
const localVarHeaderParameter = {};
|
|
711
|
+
const localVarQueryParameter = {};
|
|
712
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
713
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
714
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
715
|
+
return {
|
|
716
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
717
|
+
options: localVarRequestOptions,
|
|
718
|
+
};
|
|
719
|
+
},
|
|
720
|
+
/**
|
|
721
|
+
* Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
722
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
723
|
+
* @param {string} shipmentId The shipment to get delivery window options for.
|
|
724
|
+
* @param {number} [pageSize] The number of delivery window options to return in the response matching the given query.
|
|
725
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
726
|
+
* @param {*} [options] Override http request option.
|
|
727
|
+
* @throws {RequiredError}
|
|
728
|
+
*/
|
|
729
|
+
listDeliveryWindowOptions: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
|
|
730
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
731
|
+
(0, common_1.assertParamExists)('listDeliveryWindowOptions', 'inboundPlanId', inboundPlanId);
|
|
732
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
733
|
+
(0, common_1.assertParamExists)('listDeliveryWindowOptions', 'shipmentId', shipmentId);
|
|
734
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/deliveryWindowOptions`
|
|
735
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
736
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
737
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
738
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
739
|
+
let baseOptions;
|
|
740
|
+
if (configuration) {
|
|
741
|
+
baseOptions = configuration.baseOptions;
|
|
742
|
+
}
|
|
743
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
744
|
+
const localVarHeaderParameter = {};
|
|
745
|
+
const localVarQueryParameter = {};
|
|
746
|
+
if (pageSize !== undefined) {
|
|
747
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
748
|
+
}
|
|
749
|
+
if (paginationToken !== undefined) {
|
|
750
|
+
localVarQueryParameter['paginationToken'] = paginationToken;
|
|
751
|
+
}
|
|
752
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
753
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
754
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
755
|
+
return {
|
|
756
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
757
|
+
options: localVarRequestOptions,
|
|
758
|
+
};
|
|
759
|
+
},
|
|
760
|
+
/**
|
|
761
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
762
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
521
763
|
* @param {number} [pageSize] The number of boxes to return in the response matching the given query.
|
|
522
764
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
523
765
|
* @param {*} [options] Override http request option.
|
|
@@ -552,8 +794,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
552
794
|
};
|
|
553
795
|
},
|
|
554
796
|
/**
|
|
555
|
-
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
556
|
-
* @param {string} inboundPlanId Identifier
|
|
797
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
798
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
557
799
|
* @param {number} [pageSize] The number of items to return in the response matching the given query.
|
|
558
800
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
559
801
|
* @param {*} [options] Override http request option.
|
|
@@ -588,8 +830,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
588
830
|
};
|
|
589
831
|
},
|
|
590
832
|
/**
|
|
591
|
-
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
592
|
-
* @param {string} inboundPlanId Identifier
|
|
833
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
834
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
593
835
|
* @param {number} [pageSize] The number of pallets to return in the response matching the given query.
|
|
594
836
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
595
837
|
* @param {*} [options] Override http request option.
|
|
@@ -624,7 +866,7 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
624
866
|
};
|
|
625
867
|
},
|
|
626
868
|
/**
|
|
627
|
-
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
869
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
628
870
|
* @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
|
|
629
871
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
630
872
|
* @param {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
|
|
@@ -668,8 +910,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
668
910
|
};
|
|
669
911
|
},
|
|
670
912
|
/**
|
|
671
|
-
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
672
|
-
* @param {Array<string>} mskus List of merchant SKUs
|
|
913
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
914
|
+
* @param {Array<string>} mskus List of merchant SKUs - a merchant-supplied identifier for a specific SKU.
|
|
673
915
|
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
674
916
|
* @param {*} [options] Override http request option.
|
|
675
917
|
* @throws {RequiredError}
|
|
@@ -704,25 +946,61 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
704
946
|
};
|
|
705
947
|
},
|
|
706
948
|
/**
|
|
707
|
-
* Retrieves a
|
|
708
|
-
* @param {string} inboundPlanId Identifier
|
|
709
|
-
* @param {string}
|
|
710
|
-
* @param {
|
|
949
|
+
* Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
950
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
951
|
+
* @param {string} packingGroupId Identifier of a packing group.
|
|
952
|
+
* @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query.
|
|
953
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
954
|
+
* @param {*} [options] Override http request option.
|
|
955
|
+
* @throws {RequiredError}
|
|
956
|
+
*/
|
|
957
|
+
listPackingGroupBoxes: async (inboundPlanId, packingGroupId, pageSize, paginationToken, options = {}) => {
|
|
958
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
959
|
+
(0, common_1.assertParamExists)('listPackingGroupBoxes', 'inboundPlanId', inboundPlanId);
|
|
960
|
+
// verify required parameter 'packingGroupId' is not null or undefined
|
|
961
|
+
(0, common_1.assertParamExists)('listPackingGroupBoxes', 'packingGroupId', packingGroupId);
|
|
962
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/boxes`
|
|
963
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
964
|
+
.replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId)));
|
|
965
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
966
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
967
|
+
let baseOptions;
|
|
968
|
+
if (configuration) {
|
|
969
|
+
baseOptions = configuration.baseOptions;
|
|
970
|
+
}
|
|
971
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
972
|
+
const localVarHeaderParameter = {};
|
|
973
|
+
const localVarQueryParameter = {};
|
|
974
|
+
if (pageSize !== undefined) {
|
|
975
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
976
|
+
}
|
|
977
|
+
if (paginationToken !== undefined) {
|
|
978
|
+
localVarQueryParameter['paginationToken'] = paginationToken;
|
|
979
|
+
}
|
|
980
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
981
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
982
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
983
|
+
return {
|
|
984
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
985
|
+
options: localVarRequestOptions,
|
|
986
|
+
};
|
|
987
|
+
},
|
|
988
|
+
/**
|
|
989
|
+
* Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
990
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
991
|
+
* @param {string} packingGroupId Identifier of a packing group.
|
|
711
992
|
* @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
|
|
712
993
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
713
994
|
* @param {*} [options] Override http request option.
|
|
714
995
|
* @throws {RequiredError}
|
|
715
996
|
*/
|
|
716
|
-
listPackingGroupItems: async (inboundPlanId,
|
|
997
|
+
listPackingGroupItems: async (inboundPlanId, packingGroupId, pageSize, paginationToken, options = {}) => {
|
|
717
998
|
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
718
999
|
(0, common_1.assertParamExists)('listPackingGroupItems', 'inboundPlanId', inboundPlanId);
|
|
719
|
-
// verify required parameter 'packingOptionId' is not null or undefined
|
|
720
|
-
(0, common_1.assertParamExists)('listPackingGroupItems', 'packingOptionId', packingOptionId);
|
|
721
1000
|
// verify required parameter 'packingGroupId' is not null or undefined
|
|
722
1001
|
(0, common_1.assertParamExists)('listPackingGroupItems', 'packingGroupId', packingGroupId);
|
|
723
|
-
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/
|
|
1002
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/packingGroups/{packingGroupId}/items`
|
|
724
1003
|
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
725
|
-
.replace(`{${"packingOptionId"}}`, encodeURIComponent(String(packingOptionId)))
|
|
726
1004
|
.replace(`{${"packingGroupId"}}`, encodeURIComponent(String(packingGroupId)));
|
|
727
1005
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
728
1006
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -748,8 +1026,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
748
1026
|
};
|
|
749
1027
|
},
|
|
750
1028
|
/**
|
|
751
|
-
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding
|
|
752
|
-
* @param {string} inboundPlanId Identifier
|
|
1029
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1030
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
753
1031
|
* @param {number} [pageSize] The number of packing options to return in the response matching the given query.
|
|
754
1032
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
755
1033
|
* @param {*} [options] Override http request option.
|
|
@@ -784,8 +1062,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
784
1062
|
};
|
|
785
1063
|
},
|
|
786
1064
|
/**
|
|
787
|
-
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding
|
|
788
|
-
* @param {string} inboundPlanId Identifier
|
|
1065
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1066
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
789
1067
|
* @param {number} [pageSize] The number of placement options to return in the response matching the given query.
|
|
790
1068
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
791
1069
|
* @param {*} [options] Override http request option.
|
|
@@ -820,12 +1098,172 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
820
1098
|
};
|
|
821
1099
|
},
|
|
822
1100
|
/**
|
|
823
|
-
*
|
|
824
|
-
* @param {string} inboundPlanId Identifier
|
|
1101
|
+
* Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1102
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1103
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1104
|
+
* @param {number} [pageSize] The number of boxes to return in the response matching the given query.
|
|
1105
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1106
|
+
* @param {*} [options] Override http request option.
|
|
1107
|
+
* @throws {RequiredError}
|
|
1108
|
+
*/
|
|
1109
|
+
listShipmentBoxes: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
|
|
1110
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1111
|
+
(0, common_1.assertParamExists)('listShipmentBoxes', 'inboundPlanId', inboundPlanId);
|
|
1112
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1113
|
+
(0, common_1.assertParamExists)('listShipmentBoxes', 'shipmentId', shipmentId);
|
|
1114
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/boxes`
|
|
1115
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1116
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1117
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1118
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1119
|
+
let baseOptions;
|
|
1120
|
+
if (configuration) {
|
|
1121
|
+
baseOptions = configuration.baseOptions;
|
|
1122
|
+
}
|
|
1123
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1124
|
+
const localVarHeaderParameter = {};
|
|
1125
|
+
const localVarQueryParameter = {};
|
|
1126
|
+
if (pageSize !== undefined) {
|
|
1127
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1128
|
+
}
|
|
1129
|
+
if (paginationToken !== undefined) {
|
|
1130
|
+
localVarQueryParameter['paginationToken'] = paginationToken;
|
|
1131
|
+
}
|
|
1132
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1133
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1134
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1135
|
+
return {
|
|
1136
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1137
|
+
options: localVarRequestOptions,
|
|
1138
|
+
};
|
|
1139
|
+
},
|
|
1140
|
+
/**
|
|
1141
|
+
* Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1142
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1143
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1144
|
+
* @param {number} [pageSize] The number of content update previews to return.
|
|
1145
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1146
|
+
* @param {*} [options] Override http request option.
|
|
1147
|
+
* @throws {RequiredError}
|
|
1148
|
+
*/
|
|
1149
|
+
listShipmentContentUpdatePreviews: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
|
|
1150
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1151
|
+
(0, common_1.assertParamExists)('listShipmentContentUpdatePreviews', 'inboundPlanId', inboundPlanId);
|
|
1152
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1153
|
+
(0, common_1.assertParamExists)('listShipmentContentUpdatePreviews', 'shipmentId', shipmentId);
|
|
1154
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/contentUpdatePreviews`
|
|
1155
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1156
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1157
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1158
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1159
|
+
let baseOptions;
|
|
1160
|
+
if (configuration) {
|
|
1161
|
+
baseOptions = configuration.baseOptions;
|
|
1162
|
+
}
|
|
1163
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1164
|
+
const localVarHeaderParameter = {};
|
|
1165
|
+
const localVarQueryParameter = {};
|
|
1166
|
+
if (pageSize !== undefined) {
|
|
1167
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1168
|
+
}
|
|
1169
|
+
if (paginationToken !== undefined) {
|
|
1170
|
+
localVarQueryParameter['paginationToken'] = paginationToken;
|
|
1171
|
+
}
|
|
1172
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1173
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1174
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1175
|
+
return {
|
|
1176
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1177
|
+
options: localVarRequestOptions,
|
|
1178
|
+
};
|
|
1179
|
+
},
|
|
1180
|
+
/**
|
|
1181
|
+
* Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1182
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1183
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1184
|
+
* @param {number} [pageSize] The number of items to return in the response matching the given query.
|
|
1185
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1186
|
+
* @param {*} [options] Override http request option.
|
|
1187
|
+
* @throws {RequiredError}
|
|
1188
|
+
*/
|
|
1189
|
+
listShipmentItems: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
|
|
1190
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1191
|
+
(0, common_1.assertParamExists)('listShipmentItems', 'inboundPlanId', inboundPlanId);
|
|
1192
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1193
|
+
(0, common_1.assertParamExists)('listShipmentItems', 'shipmentId', shipmentId);
|
|
1194
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/items`
|
|
1195
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1196
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1197
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1198
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1199
|
+
let baseOptions;
|
|
1200
|
+
if (configuration) {
|
|
1201
|
+
baseOptions = configuration.baseOptions;
|
|
1202
|
+
}
|
|
1203
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1204
|
+
const localVarHeaderParameter = {};
|
|
1205
|
+
const localVarQueryParameter = {};
|
|
1206
|
+
if (pageSize !== undefined) {
|
|
1207
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1208
|
+
}
|
|
1209
|
+
if (paginationToken !== undefined) {
|
|
1210
|
+
localVarQueryParameter['paginationToken'] = paginationToken;
|
|
1211
|
+
}
|
|
1212
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1213
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1214
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1215
|
+
return {
|
|
1216
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1217
|
+
options: localVarRequestOptions,
|
|
1218
|
+
};
|
|
1219
|
+
},
|
|
1220
|
+
/**
|
|
1221
|
+
* Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1222
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1223
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1224
|
+
* @param {number} [pageSize] The number of pallets to return in the response matching the given query.
|
|
1225
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1226
|
+
* @param {*} [options] Override http request option.
|
|
1227
|
+
* @throws {RequiredError}
|
|
1228
|
+
*/
|
|
1229
|
+
listShipmentPallets: async (inboundPlanId, shipmentId, pageSize, paginationToken, options = {}) => {
|
|
1230
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1231
|
+
(0, common_1.assertParamExists)('listShipmentPallets', 'inboundPlanId', inboundPlanId);
|
|
1232
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1233
|
+
(0, common_1.assertParamExists)('listShipmentPallets', 'shipmentId', shipmentId);
|
|
1234
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/pallets`
|
|
1235
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1236
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1237
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1238
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1239
|
+
let baseOptions;
|
|
1240
|
+
if (configuration) {
|
|
1241
|
+
baseOptions = configuration.baseOptions;
|
|
1242
|
+
}
|
|
1243
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
1244
|
+
const localVarHeaderParameter = {};
|
|
1245
|
+
const localVarQueryParameter = {};
|
|
1246
|
+
if (pageSize !== undefined) {
|
|
1247
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
1248
|
+
}
|
|
1249
|
+
if (paginationToken !== undefined) {
|
|
1250
|
+
localVarQueryParameter['paginationToken'] = paginationToken;
|
|
1251
|
+
}
|
|
1252
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1253
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1254
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1255
|
+
return {
|
|
1256
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1257
|
+
options: localVarRequestOptions,
|
|
1258
|
+
};
|
|
1259
|
+
},
|
|
1260
|
+
/**
|
|
1261
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1262
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
825
1263
|
* @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
|
|
826
1264
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
827
|
-
* @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
828
|
-
* @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
1265
|
+
* @param {string} [placementOptionId] The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.
|
|
1266
|
+
* @param {string} [shipmentId] The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.
|
|
829
1267
|
* @param {*} [options] Override http request option.
|
|
830
1268
|
* @throws {RequiredError}
|
|
831
1269
|
*/
|
|
@@ -864,10 +1302,10 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
864
1302
|
};
|
|
865
1303
|
},
|
|
866
1304
|
/**
|
|
867
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
868
|
-
* @param {string} inboundPlanId Identifier
|
|
869
|
-
* @param {string} shipmentId Identifier
|
|
870
|
-
* @param {string} slotId
|
|
1305
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1306
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1307
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1308
|
+
* @param {string} slotId An identifier to a self-ship appointment slot.
|
|
871
1309
|
* @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`.
|
|
872
1310
|
* @param {*} [options] Override http request option.
|
|
873
1311
|
* @throws {RequiredError}
|
|
@@ -905,8 +1343,8 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
905
1343
|
};
|
|
906
1344
|
},
|
|
907
1345
|
/**
|
|
908
|
-
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
|
|
909
|
-
* @param {string} inboundPlanId Identifier
|
|
1346
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1347
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
910
1348
|
* @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`.
|
|
911
1349
|
* @param {*} [options] Override http request option.
|
|
912
1350
|
* @throws {RequiredError}
|
|
@@ -938,7 +1376,40 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
938
1376
|
};
|
|
939
1377
|
},
|
|
940
1378
|
/**
|
|
941
|
-
*
|
|
1379
|
+
* 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 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).
|
|
1380
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1381
|
+
* @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`.
|
|
1382
|
+
* @param {*} [options] Override http request option.
|
|
1383
|
+
* @throws {RequiredError}
|
|
1384
|
+
*/
|
|
1385
|
+
updateInboundPlanName: async (inboundPlanId, body, options = {}) => {
|
|
1386
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1387
|
+
(0, common_1.assertParamExists)('updateInboundPlanName', 'inboundPlanId', inboundPlanId);
|
|
1388
|
+
// verify required parameter 'body' is not null or undefined
|
|
1389
|
+
(0, common_1.assertParamExists)('updateInboundPlanName', 'body', body);
|
|
1390
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/name`
|
|
1391
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)));
|
|
1392
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1393
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1394
|
+
let baseOptions;
|
|
1395
|
+
if (configuration) {
|
|
1396
|
+
baseOptions = configuration.baseOptions;
|
|
1397
|
+
}
|
|
1398
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1399
|
+
const localVarHeaderParameter = {};
|
|
1400
|
+
const localVarQueryParameter = {};
|
|
1401
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1402
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1403
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1404
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1405
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
1406
|
+
return {
|
|
1407
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1408
|
+
options: localVarRequestOptions,
|
|
1409
|
+
};
|
|
1410
|
+
},
|
|
1411
|
+
/**
|
|
1412
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
942
1413
|
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
943
1414
|
* @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`.
|
|
944
1415
|
* @param {*} [options] Override http request option.
|
|
@@ -973,21 +1444,21 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
973
1444
|
};
|
|
974
1445
|
},
|
|
975
1446
|
/**
|
|
976
|
-
*
|
|
977
|
-
* @param {string} inboundPlanId Identifier
|
|
978
|
-
* @param {string} shipmentId Identifier
|
|
979
|
-
* @param {
|
|
1447
|
+
* Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1448
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1449
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1450
|
+
* @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`.
|
|
980
1451
|
* @param {*} [options] Override http request option.
|
|
981
1452
|
* @throws {RequiredError}
|
|
982
1453
|
*/
|
|
983
|
-
|
|
1454
|
+
updateShipmentName: async (inboundPlanId, shipmentId, body, options = {}) => {
|
|
984
1455
|
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
985
|
-
(0, common_1.assertParamExists)('
|
|
1456
|
+
(0, common_1.assertParamExists)('updateShipmentName', 'inboundPlanId', inboundPlanId);
|
|
986
1457
|
// verify required parameter 'shipmentId' is not null or undefined
|
|
987
|
-
(0, common_1.assertParamExists)('
|
|
1458
|
+
(0, common_1.assertParamExists)('updateShipmentName', 'shipmentId', shipmentId);
|
|
988
1459
|
// verify required parameter 'body' is not null or undefined
|
|
989
|
-
(0, common_1.assertParamExists)('
|
|
990
|
-
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/
|
|
1460
|
+
(0, common_1.assertParamExists)('updateShipmentName', 'body', body);
|
|
1461
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/name`
|
|
991
1462
|
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
992
1463
|
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
993
1464
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -996,7 +1467,44 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
996
1467
|
if (configuration) {
|
|
997
1468
|
baseOptions = configuration.baseOptions;
|
|
998
1469
|
}
|
|
999
|
-
const localVarRequestOptions = { method: '
|
|
1470
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1471
|
+
const localVarHeaderParameter = {};
|
|
1472
|
+
const localVarQueryParameter = {};
|
|
1473
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
1474
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
1475
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1476
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
1477
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(body, localVarRequestOptions, configuration);
|
|
1478
|
+
return {
|
|
1479
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
1480
|
+
options: localVarRequestOptions,
|
|
1481
|
+
};
|
|
1482
|
+
},
|
|
1483
|
+
/**
|
|
1484
|
+
* Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1485
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1486
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1487
|
+
* @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`.
|
|
1488
|
+
* @param {*} [options] Override http request option.
|
|
1489
|
+
* @throws {RequiredError}
|
|
1490
|
+
*/
|
|
1491
|
+
updateShipmentSourceAddress: async (inboundPlanId, shipmentId, body, options = {}) => {
|
|
1492
|
+
// verify required parameter 'inboundPlanId' is not null or undefined
|
|
1493
|
+
(0, common_1.assertParamExists)('updateShipmentSourceAddress', 'inboundPlanId', inboundPlanId);
|
|
1494
|
+
// verify required parameter 'shipmentId' is not null or undefined
|
|
1495
|
+
(0, common_1.assertParamExists)('updateShipmentSourceAddress', 'shipmentId', shipmentId);
|
|
1496
|
+
// verify required parameter 'body' is not null or undefined
|
|
1497
|
+
(0, common_1.assertParamExists)('updateShipmentSourceAddress', 'body', body);
|
|
1498
|
+
const localVarPath = `/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}/sourceAddress`
|
|
1499
|
+
.replace(`{${"inboundPlanId"}}`, encodeURIComponent(String(inboundPlanId)))
|
|
1500
|
+
.replace(`{${"shipmentId"}}`, encodeURIComponent(String(shipmentId)));
|
|
1501
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1502
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
1503
|
+
let baseOptions;
|
|
1504
|
+
if (configuration) {
|
|
1505
|
+
baseOptions = configuration.baseOptions;
|
|
1506
|
+
}
|
|
1507
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
1000
1508
|
const localVarHeaderParameter = {};
|
|
1001
1509
|
const localVarQueryParameter = {};
|
|
1002
1510
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
@@ -1010,9 +1518,9 @@ const FbaInboundApiAxiosParamCreator = function (configuration) {
|
|
|
1010
1518
|
};
|
|
1011
1519
|
},
|
|
1012
1520
|
/**
|
|
1013
|
-
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1014
|
-
* @param {string} inboundPlanId Identifier
|
|
1015
|
-
* @param {string} shipmentId Identifier
|
|
1521
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1522
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1523
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1016
1524
|
* @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`.
|
|
1017
1525
|
* @param {*} [options] Override http request option.
|
|
1018
1526
|
* @throws {RequiredError}
|
|
@@ -1057,8 +1565,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1057
1565
|
const localVarAxiosParamCreator = (0, exports.FbaInboundApiAxiosParamCreator)(configuration);
|
|
1058
1566
|
return {
|
|
1059
1567
|
/**
|
|
1060
|
-
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
|
|
1061
|
-
* @param {string} inboundPlanId Identifier
|
|
1568
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1569
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1062
1570
|
* @param {*} [options] Override http request option.
|
|
1063
1571
|
* @throws {RequiredError}
|
|
1064
1572
|
*/
|
|
@@ -1069,24 +1577,37 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1069
1577
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1070
1578
|
},
|
|
1071
1579
|
/**
|
|
1072
|
-
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1073
|
-
* @param {string} inboundPlanId Identifier
|
|
1074
|
-
* @param {string} shipmentId Identifier
|
|
1075
|
-
* @param {
|
|
1076
|
-
* @param {
|
|
1580
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1581
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1582
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1583
|
+
* @param {CancelSelfShipAppointmentRequest} body The body of the request to `cancelSelfShipAppointment`.
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
*/
|
|
1587
|
+
async cancelSelfShipAppointment(inboundPlanId, shipmentId, body, options) {
|
|
1588
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.cancelSelfShipAppointment(inboundPlanId, shipmentId, body, options);
|
|
1589
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1590
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.cancelSelfShipAppointment']?.[localVarOperationServerIndex]?.url;
|
|
1591
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1592
|
+
},
|
|
1593
|
+
/**
|
|
1594
|
+
* Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1595
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1596
|
+
* @param {string} shipmentId The shipment to confirm the delivery window option for.
|
|
1597
|
+
* @param {string} deliveryWindowOptionId The id of the delivery window option to be confirmed.
|
|
1077
1598
|
* @param {*} [options] Override http request option.
|
|
1078
1599
|
* @throws {RequiredError}
|
|
1079
1600
|
*/
|
|
1080
|
-
async
|
|
1081
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
1601
|
+
async confirmDeliveryWindowOptions(inboundPlanId, shipmentId, deliveryWindowOptionId, options) {
|
|
1602
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmDeliveryWindowOptions(inboundPlanId, shipmentId, deliveryWindowOptionId, options);
|
|
1082
1603
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1083
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.
|
|
1604
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.confirmDeliveryWindowOptions']?.[localVarOperationServerIndex]?.url;
|
|
1084
1605
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1085
1606
|
},
|
|
1086
1607
|
/**
|
|
1087
|
-
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1088
|
-
* @param {string} inboundPlanId Identifier
|
|
1089
|
-
* @param {string} packingOptionId Identifier
|
|
1608
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1609
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1610
|
+
* @param {string} packingOptionId Identifier of a packing option.
|
|
1090
1611
|
* @param {*} [options] Override http request option.
|
|
1091
1612
|
* @throws {RequiredError}
|
|
1092
1613
|
*/
|
|
@@ -1097,9 +1618,9 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1097
1618
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1098
1619
|
},
|
|
1099
1620
|
/**
|
|
1100
|
-
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1101
|
-
* @param {string} inboundPlanId Identifier
|
|
1102
|
-
* @param {string} placementOptionId
|
|
1621
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1622
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1623
|
+
* @param {string} placementOptionId The identifier of a placement option. A placement option represents the shipment splits and destinations of SKUs.
|
|
1103
1624
|
* @param {*} [options] Override http request option.
|
|
1104
1625
|
* @throws {RequiredError}
|
|
1105
1626
|
*/
|
|
@@ -1110,8 +1631,22 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1110
1631
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1111
1632
|
},
|
|
1112
1633
|
/**
|
|
1113
|
-
*
|
|
1114
|
-
* @param {string} inboundPlanId Identifier
|
|
1634
|
+
* Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1635
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1636
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1637
|
+
* @param {string} contentUpdatePreviewId Identifier of a content update preview.
|
|
1638
|
+
* @param {*} [options] Override http request option.
|
|
1639
|
+
* @throws {RequiredError}
|
|
1640
|
+
*/
|
|
1641
|
+
async confirmShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options) {
|
|
1642
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options);
|
|
1643
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1644
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.confirmShipmentContentUpdatePreview']?.[localVarOperationServerIndex]?.url;
|
|
1645
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1646
|
+
},
|
|
1647
|
+
/**
|
|
1648
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1649
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1115
1650
|
* @param {ConfirmTransportationOptionsRequest} body The body of the request to `confirmTransportationOptions`.
|
|
1116
1651
|
* @param {*} [options] Override http request option.
|
|
1117
1652
|
* @throws {RequiredError}
|
|
@@ -1123,7 +1658,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1123
1658
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1124
1659
|
},
|
|
1125
1660
|
/**
|
|
1126
|
-
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1661
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1127
1662
|
* @param {CreateInboundPlanRequest} body The body of the request to `createInboundPlan`.
|
|
1128
1663
|
* @param {*} [options] Override http request option.
|
|
1129
1664
|
* @throws {RequiredError}
|
|
@@ -1135,8 +1670,33 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1135
1670
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1136
1671
|
},
|
|
1137
1672
|
/**
|
|
1138
|
-
*
|
|
1139
|
-
* @param {
|
|
1673
|
+
* For a given marketplace - creates labels for a list of mskus. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1674
|
+
* @param {CreateMarketplaceItemLabelsRequest} body The body of the request to `createMarketplaceItemLabels`.
|
|
1675
|
+
* @param {*} [options] Override http request option.
|
|
1676
|
+
* @throws {RequiredError}
|
|
1677
|
+
*/
|
|
1678
|
+
async createMarketplaceItemLabels(body, options) {
|
|
1679
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createMarketplaceItemLabels(body, options);
|
|
1680
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1681
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.createMarketplaceItemLabels']?.[localVarOperationServerIndex]?.url;
|
|
1682
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1683
|
+
},
|
|
1684
|
+
/**
|
|
1685
|
+
* Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1686
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1687
|
+
* @param {string} shipmentId The shipment to generate delivery window options for.
|
|
1688
|
+
* @param {*} [options] Override http request option.
|
|
1689
|
+
* @throws {RequiredError}
|
|
1690
|
+
*/
|
|
1691
|
+
async generateDeliveryWindowOptions(inboundPlanId, shipmentId, options) {
|
|
1692
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateDeliveryWindowOptions(inboundPlanId, shipmentId, options);
|
|
1693
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1694
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.generateDeliveryWindowOptions']?.[localVarOperationServerIndex]?.url;
|
|
1695
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1696
|
+
},
|
|
1697
|
+
/**
|
|
1698
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1699
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1140
1700
|
* @param {*} [options] Override http request option.
|
|
1141
1701
|
* @throws {RequiredError}
|
|
1142
1702
|
*/
|
|
@@ -1147,8 +1707,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1147
1707
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1148
1708
|
},
|
|
1149
1709
|
/**
|
|
1150
|
-
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1151
|
-
* @param {string} inboundPlanId Identifier
|
|
1710
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1711
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1152
1712
|
* @param {GeneratePlacementOptionsRequest} body The body of the request to `generatePlacementOptions`.
|
|
1153
1713
|
* @param {*} [options] Override http request option.
|
|
1154
1714
|
* @throws {RequiredError}
|
|
@@ -1160,10 +1720,10 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1160
1720
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1161
1721
|
},
|
|
1162
1722
|
/**
|
|
1163
|
-
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1164
|
-
* @param {string} inboundPlanId Identifier
|
|
1165
|
-
* @param {string} shipmentId Identifier
|
|
1166
|
-
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request `generateSelfShipAppointmentSlots`.
|
|
1723
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1724
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1725
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1726
|
+
* @param {GenerateSelfShipAppointmentSlotsRequest} body The body of the request to `generateSelfShipAppointmentSlots`.
|
|
1167
1727
|
* @param {*} [options] Override http request option.
|
|
1168
1728
|
* @throws {RequiredError}
|
|
1169
1729
|
*/
|
|
@@ -1174,8 +1734,22 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1174
1734
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1175
1735
|
},
|
|
1176
1736
|
/**
|
|
1177
|
-
*
|
|
1178
|
-
* @param {string} inboundPlanId Identifier
|
|
1737
|
+
* Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1738
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1739
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1740
|
+
* @param {GenerateShipmentContentUpdatePreviewsRequest} body The body of the request to `generateShipmentContentUpdatePreviews`.
|
|
1741
|
+
* @param {*} [options] Override http request option.
|
|
1742
|
+
* @throws {RequiredError}
|
|
1743
|
+
*/
|
|
1744
|
+
async generateShipmentContentUpdatePreviews(inboundPlanId, shipmentId, body, options) {
|
|
1745
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateShipmentContentUpdatePreviews(inboundPlanId, shipmentId, body, options);
|
|
1746
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1747
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.generateShipmentContentUpdatePreviews']?.[localVarOperationServerIndex]?.url;
|
|
1748
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1749
|
+
},
|
|
1750
|
+
/**
|
|
1751
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1752
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1179
1753
|
* @param {GenerateTransportationOptionsRequest} body The body of the request to `generateTransportationOptions`.
|
|
1180
1754
|
* @param {*} [options] Override http request option.
|
|
1181
1755
|
* @throws {RequiredError}
|
|
@@ -1187,9 +1761,9 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1187
1761
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1188
1762
|
},
|
|
1189
1763
|
/**
|
|
1190
|
-
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1191
|
-
* @param {string} inboundPlanId Identifier
|
|
1192
|
-
* @param {string} shipmentId Identifier
|
|
1764
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1765
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1766
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1193
1767
|
* @param {*} [options] Override http request option.
|
|
1194
1768
|
* @throws {RequiredError}
|
|
1195
1769
|
*/
|
|
@@ -1200,8 +1774,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1200
1774
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1201
1775
|
},
|
|
1202
1776
|
/**
|
|
1203
|
-
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1204
|
-
* @param {string} operationId Identifier
|
|
1777
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1778
|
+
* @param {string} operationId Identifier of an asynchronous operation.
|
|
1205
1779
|
* @param {*} [options] Override http request option.
|
|
1206
1780
|
* @throws {RequiredError}
|
|
1207
1781
|
*/
|
|
@@ -1212,8 +1786,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1212
1786
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1213
1787
|
},
|
|
1214
1788
|
/**
|
|
1215
|
-
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1216
|
-
* @param {string} inboundPlanId Identifier
|
|
1789
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1790
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1217
1791
|
* @param {*} [options] Override http request option.
|
|
1218
1792
|
* @throws {RequiredError}
|
|
1219
1793
|
*/
|
|
@@ -1224,9 +1798,9 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1224
1798
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1225
1799
|
},
|
|
1226
1800
|
/**
|
|
1227
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1228
|
-
* @param {string} inboundPlanId Identifier
|
|
1229
|
-
* @param {string} shipmentId Identifier
|
|
1801
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1802
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1803
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1230
1804
|
* @param {number} [pageSize] The number of self ship appointment slots to return in the response matching the given query.
|
|
1231
1805
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1232
1806
|
* @param {*} [options] Override http request option.
|
|
@@ -1239,9 +1813,9 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1239
1813
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1240
1814
|
},
|
|
1241
1815
|
/**
|
|
1242
|
-
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1243
|
-
* @param {string} inboundPlanId Identifier
|
|
1244
|
-
* @param {string} shipmentId Identifier
|
|
1816
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1817
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1818
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1245
1819
|
* @param {*} [options] Override http request option.
|
|
1246
1820
|
* @throws {RequiredError}
|
|
1247
1821
|
*/
|
|
@@ -1252,8 +1826,37 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1252
1826
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1253
1827
|
},
|
|
1254
1828
|
/**
|
|
1255
|
-
*
|
|
1256
|
-
* @param {string} inboundPlanId Identifier
|
|
1829
|
+
* Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1830
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1831
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1832
|
+
* @param {string} contentUpdatePreviewId Identifier of a content update preview.
|
|
1833
|
+
* @param {*} [options] Override http request option.
|
|
1834
|
+
* @throws {RequiredError}
|
|
1835
|
+
*/
|
|
1836
|
+
async getShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options) {
|
|
1837
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getShipmentContentUpdatePreview(inboundPlanId, shipmentId, contentUpdatePreviewId, options);
|
|
1838
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1839
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.getShipmentContentUpdatePreview']?.[localVarOperationServerIndex]?.url;
|
|
1840
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1841
|
+
},
|
|
1842
|
+
/**
|
|
1843
|
+
* Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1844
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1845
|
+
* @param {string} shipmentId The shipment to get delivery window options for.
|
|
1846
|
+
* @param {number} [pageSize] The number of delivery window options to return in the response matching the given query.
|
|
1847
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1848
|
+
* @param {*} [options] Override http request option.
|
|
1849
|
+
* @throws {RequiredError}
|
|
1850
|
+
*/
|
|
1851
|
+
async listDeliveryWindowOptions(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
|
|
1852
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDeliveryWindowOptions(inboundPlanId, shipmentId, pageSize, paginationToken, options);
|
|
1853
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1854
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listDeliveryWindowOptions']?.[localVarOperationServerIndex]?.url;
|
|
1855
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1856
|
+
},
|
|
1857
|
+
/**
|
|
1858
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1859
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1257
1860
|
* @param {number} [pageSize] The number of boxes to return in the response matching the given query.
|
|
1258
1861
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1259
1862
|
* @param {*} [options] Override http request option.
|
|
@@ -1266,8 +1869,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1266
1869
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1267
1870
|
},
|
|
1268
1871
|
/**
|
|
1269
|
-
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1270
|
-
* @param {string} inboundPlanId Identifier
|
|
1872
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1873
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1271
1874
|
* @param {number} [pageSize] The number of items to return in the response matching the given query.
|
|
1272
1875
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1273
1876
|
* @param {*} [options] Override http request option.
|
|
@@ -1280,8 +1883,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1280
1883
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1281
1884
|
},
|
|
1282
1885
|
/**
|
|
1283
|
-
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1284
|
-
* @param {string} inboundPlanId Identifier
|
|
1886
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1887
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1285
1888
|
* @param {number} [pageSize] The number of pallets to return in the response matching the given query.
|
|
1286
1889
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1287
1890
|
* @param {*} [options] Override http request option.
|
|
@@ -1294,7 +1897,7 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1294
1897
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1295
1898
|
},
|
|
1296
1899
|
/**
|
|
1297
|
-
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1900
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1298
1901
|
* @param {number} [pageSize] The number of inbound plans to return in the response matching the given query.
|
|
1299
1902
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1300
1903
|
* @param {ListInboundPlansStatusEnum} [status] The status of an inbound plan.
|
|
@@ -1310,8 +1913,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1310
1913
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1311
1914
|
},
|
|
1312
1915
|
/**
|
|
1313
|
-
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1314
|
-
* @param {Array<string>} mskus List of merchant SKUs
|
|
1916
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1917
|
+
* @param {Array<string>} mskus List of merchant SKUs - a merchant-supplied identifier for a specific SKU.
|
|
1315
1918
|
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
1316
1919
|
* @param {*} [options] Override http request option.
|
|
1317
1920
|
* @throws {RequiredError}
|
|
@@ -1323,24 +1926,38 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1323
1926
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1324
1927
|
},
|
|
1325
1928
|
/**
|
|
1326
|
-
* Retrieves a
|
|
1327
|
-
* @param {string} inboundPlanId Identifier
|
|
1328
|
-
* @param {string}
|
|
1329
|
-
* @param {
|
|
1929
|
+
* Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1930
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1931
|
+
* @param {string} packingGroupId Identifier of a packing group.
|
|
1932
|
+
* @param {number} [pageSize] The number of packing group boxes to return in the response matching the given query.
|
|
1933
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1934
|
+
* @param {*} [options] Override http request option.
|
|
1935
|
+
* @throws {RequiredError}
|
|
1936
|
+
*/
|
|
1937
|
+
async listPackingGroupBoxes(inboundPlanId, packingGroupId, pageSize, paginationToken, options) {
|
|
1938
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupBoxes(inboundPlanId, packingGroupId, pageSize, paginationToken, options);
|
|
1939
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1940
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listPackingGroupBoxes']?.[localVarOperationServerIndex]?.url;
|
|
1941
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1942
|
+
},
|
|
1943
|
+
/**
|
|
1944
|
+
* Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1945
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1946
|
+
* @param {string} packingGroupId Identifier of a packing group.
|
|
1330
1947
|
* @param {number} [pageSize] The number of packing group items to return in the response matching the given query.
|
|
1331
1948
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1332
1949
|
* @param {*} [options] Override http request option.
|
|
1333
1950
|
* @throws {RequiredError}
|
|
1334
1951
|
*/
|
|
1335
|
-
async listPackingGroupItems(inboundPlanId,
|
|
1336
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupItems(inboundPlanId,
|
|
1952
|
+
async listPackingGroupItems(inboundPlanId, packingGroupId, pageSize, paginationToken, options) {
|
|
1953
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPackingGroupItems(inboundPlanId, packingGroupId, pageSize, paginationToken, options);
|
|
1337
1954
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1338
1955
|
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listPackingGroupItems']?.[localVarOperationServerIndex]?.url;
|
|
1339
1956
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1340
1957
|
},
|
|
1341
1958
|
/**
|
|
1342
|
-
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding
|
|
1343
|
-
* @param {string} inboundPlanId Identifier
|
|
1959
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1960
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1344
1961
|
* @param {number} [pageSize] The number of packing options to return in the response matching the given query.
|
|
1345
1962
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1346
1963
|
* @param {*} [options] Override http request option.
|
|
@@ -1353,8 +1970,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1353
1970
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1354
1971
|
},
|
|
1355
1972
|
/**
|
|
1356
|
-
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding
|
|
1357
|
-
* @param {string} inboundPlanId Identifier
|
|
1973
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1974
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1358
1975
|
* @param {number} [pageSize] The number of placement options to return in the response matching the given query.
|
|
1359
1976
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1360
1977
|
* @param {*} [options] Override http request option.
|
|
@@ -1367,12 +1984,72 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1367
1984
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1368
1985
|
},
|
|
1369
1986
|
/**
|
|
1370
|
-
*
|
|
1371
|
-
* @param {string} inboundPlanId Identifier
|
|
1987
|
+
* Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1988
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1989
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1990
|
+
* @param {number} [pageSize] The number of boxes to return in the response matching the given query.
|
|
1991
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1992
|
+
* @param {*} [options] Override http request option.
|
|
1993
|
+
* @throws {RequiredError}
|
|
1994
|
+
*/
|
|
1995
|
+
async listShipmentBoxes(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
|
|
1996
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentBoxes(inboundPlanId, shipmentId, pageSize, paginationToken, options);
|
|
1997
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1998
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listShipmentBoxes']?.[localVarOperationServerIndex]?.url;
|
|
1999
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2000
|
+
},
|
|
2001
|
+
/**
|
|
2002
|
+
* Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2003
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2004
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2005
|
+
* @param {number} [pageSize] The number of content update previews to return.
|
|
2006
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
2007
|
+
* @param {*} [options] Override http request option.
|
|
2008
|
+
* @throws {RequiredError}
|
|
2009
|
+
*/
|
|
2010
|
+
async listShipmentContentUpdatePreviews(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
|
|
2011
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentContentUpdatePreviews(inboundPlanId, shipmentId, pageSize, paginationToken, options);
|
|
2012
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2013
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listShipmentContentUpdatePreviews']?.[localVarOperationServerIndex]?.url;
|
|
2014
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2015
|
+
},
|
|
2016
|
+
/**
|
|
2017
|
+
* Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2018
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2019
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2020
|
+
* @param {number} [pageSize] The number of items to return in the response matching the given query.
|
|
2021
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
2022
|
+
* @param {*} [options] Override http request option.
|
|
2023
|
+
* @throws {RequiredError}
|
|
2024
|
+
*/
|
|
2025
|
+
async listShipmentItems(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
|
|
2026
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentItems(inboundPlanId, shipmentId, pageSize, paginationToken, options);
|
|
2027
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2028
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listShipmentItems']?.[localVarOperationServerIndex]?.url;
|
|
2029
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2030
|
+
},
|
|
2031
|
+
/**
|
|
2032
|
+
* Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2033
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2034
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2035
|
+
* @param {number} [pageSize] The number of pallets to return in the response matching the given query.
|
|
2036
|
+
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
2037
|
+
* @param {*} [options] Override http request option.
|
|
2038
|
+
* @throws {RequiredError}
|
|
2039
|
+
*/
|
|
2040
|
+
async listShipmentPallets(inboundPlanId, shipmentId, pageSize, paginationToken, options) {
|
|
2041
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listShipmentPallets(inboundPlanId, shipmentId, pageSize, paginationToken, options);
|
|
2042
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2043
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.listShipmentPallets']?.[localVarOperationServerIndex]?.url;
|
|
2044
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2045
|
+
},
|
|
2046
|
+
/**
|
|
2047
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
2048
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1372
2049
|
* @param {number} [pageSize] The number of transportation options to return in the response matching the given query.
|
|
1373
2050
|
* @param {string} [paginationToken] A token to fetch a certain page when there are multiple pages worth of results. The value of this token is fetched from the `pagination` returned in the API response. In the absence of the token value from the query parameter the API returns the first page of the result.
|
|
1374
|
-
* @param {string} [placementOptionId] The placement option to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
1375
|
-
* @param {string} [shipmentId] The shipment to get transportation options for. Either placementOptionId or shipmentId must be specified.
|
|
2051
|
+
* @param {string} [placementOptionId] The placement option to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.
|
|
2052
|
+
* @param {string} [shipmentId] The shipment to get transportation options for. Either `placementOptionId` or `shipmentId` must be specified.
|
|
1376
2053
|
* @param {*} [options] Override http request option.
|
|
1377
2054
|
* @throws {RequiredError}
|
|
1378
2055
|
*/
|
|
@@ -1383,10 +2060,10 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1383
2060
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1384
2061
|
},
|
|
1385
2062
|
/**
|
|
1386
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1387
|
-
* @param {string} inboundPlanId Identifier
|
|
1388
|
-
* @param {string} shipmentId Identifier
|
|
1389
|
-
* @param {string} slotId
|
|
2063
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
2064
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2065
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2066
|
+
* @param {string} slotId An identifier to a self-ship appointment slot.
|
|
1390
2067
|
* @param {ScheduleSelfShipAppointmentRequest} body The body of the request to `scheduleSelfShipAppointment`.
|
|
1391
2068
|
* @param {*} [options] Override http request option.
|
|
1392
2069
|
* @throws {RequiredError}
|
|
@@ -1398,8 +2075,8 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1398
2075
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1399
2076
|
},
|
|
1400
2077
|
/**
|
|
1401
|
-
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
|
|
1402
|
-
* @param {string} inboundPlanId Identifier
|
|
2078
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
2079
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
1403
2080
|
* @param {SetPackingInformationRequest} body The body of the request to `setPackingInformation`.
|
|
1404
2081
|
* @param {*} [options] Override http request option.
|
|
1405
2082
|
* @throws {RequiredError}
|
|
@@ -1411,7 +2088,20 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1411
2088
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1412
2089
|
},
|
|
1413
2090
|
/**
|
|
1414
|
-
*
|
|
2091
|
+
* 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 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).
|
|
2092
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2093
|
+
* @param {UpdateInboundPlanNameRequest} body The body of the request to `updateInboundPlanName`.
|
|
2094
|
+
* @param {*} [options] Override http request option.
|
|
2095
|
+
* @throws {RequiredError}
|
|
2096
|
+
*/
|
|
2097
|
+
async updateInboundPlanName(inboundPlanId, body, options) {
|
|
2098
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateInboundPlanName(inboundPlanId, body, options);
|
|
2099
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2100
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.updateInboundPlanName']?.[localVarOperationServerIndex]?.url;
|
|
2101
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2102
|
+
},
|
|
2103
|
+
/**
|
|
2104
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1415
2105
|
* @param {string} marketplaceId The Marketplace ID. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for a list of possible values.
|
|
1416
2106
|
* @param {UpdateItemComplianceDetailsRequest} body The body of the request to `updateItemComplianceDetails`.
|
|
1417
2107
|
* @param {*} [options] Override http request option.
|
|
@@ -1424,23 +2114,37 @@ const FbaInboundApiFp = function (configuration) {
|
|
|
1424
2114
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1425
2115
|
},
|
|
1426
2116
|
/**
|
|
1427
|
-
*
|
|
1428
|
-
* @param {string} inboundPlanId Identifier
|
|
1429
|
-
* @param {string} shipmentId Identifier
|
|
1430
|
-
* @param {
|
|
2117
|
+
* Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2118
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2119
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2120
|
+
* @param {UpdateShipmentNameRequest} body The body of the request to `updateShipmentName`.
|
|
2121
|
+
* @param {*} [options] Override http request option.
|
|
2122
|
+
* @throws {RequiredError}
|
|
2123
|
+
*/
|
|
2124
|
+
async updateShipmentName(inboundPlanId, shipmentId, body, options) {
|
|
2125
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentName(inboundPlanId, shipmentId, body, options);
|
|
2126
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2127
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.updateShipmentName']?.[localVarOperationServerIndex]?.url;
|
|
2128
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2129
|
+
},
|
|
2130
|
+
/**
|
|
2131
|
+
* Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2132
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2133
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
2134
|
+
* @param {UpdateShipmentSourceAddressRequest} body The body of the request to `updateShipmentSourceAddress`.
|
|
1431
2135
|
* @param {*} [options] Override http request option.
|
|
1432
2136
|
* @throws {RequiredError}
|
|
1433
2137
|
*/
|
|
1434
|
-
async
|
|
1435
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
2138
|
+
async updateShipmentSourceAddress(inboundPlanId, shipmentId, body, options) {
|
|
2139
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateShipmentSourceAddress(inboundPlanId, shipmentId, body, options);
|
|
1436
2140
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1437
|
-
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.
|
|
2141
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['FbaInboundApi.updateShipmentSourceAddress']?.[localVarOperationServerIndex]?.url;
|
|
1438
2142
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1439
2143
|
},
|
|
1440
2144
|
/**
|
|
1441
|
-
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
1442
|
-
* @param {string} inboundPlanId Identifier
|
|
1443
|
-
* @param {string} shipmentId Identifier
|
|
2145
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
2146
|
+
* @param {string} inboundPlanId Identifier of an inbound plan.
|
|
2147
|
+
* @param {string} shipmentId Identifier of a shipment. A shipment contains the boxes and units being inbounded.
|
|
1444
2148
|
* @param {UpdateShipmentTrackingDetailsRequest} body The body of the request to `updateShipmentTrackingDetails`.
|
|
1445
2149
|
* @param {*} [options] Override http request option.
|
|
1446
2150
|
* @throws {RequiredError}
|
|
@@ -1462,7 +2166,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1462
2166
|
const localVarFp = (0, exports.FbaInboundApiFp)(configuration);
|
|
1463
2167
|
return {
|
|
1464
2168
|
/**
|
|
1465
|
-
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
|
|
2169
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1466
2170
|
* @param {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
|
|
1467
2171
|
* @param {*} [options] Override http request option.
|
|
1468
2172
|
* @throws {RequiredError}
|
|
@@ -1471,16 +2175,25 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1471
2175
|
return localVarFp.cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
1472
2176
|
},
|
|
1473
2177
|
/**
|
|
1474
|
-
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2178
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1475
2179
|
* @param {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
1476
2180
|
* @param {*} [options] Override http request option.
|
|
1477
2181
|
* @throws {RequiredError}
|
|
1478
2182
|
*/
|
|
1479
2183
|
cancelSelfShipAppointment(requestParameters, options) {
|
|
1480
|
-
return localVarFp.cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.
|
|
2184
|
+
return localVarFp.cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2185
|
+
},
|
|
2186
|
+
/**
|
|
2187
|
+
* Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2188
|
+
* @param {FbaInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters.
|
|
2189
|
+
* @param {*} [options] Override http request option.
|
|
2190
|
+
* @throws {RequiredError}
|
|
2191
|
+
*/
|
|
2192
|
+
confirmDeliveryWindowOptions(requestParameters, options) {
|
|
2193
|
+
return localVarFp.confirmDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.deliveryWindowOptionId, options).then((request) => request(axios, basePath));
|
|
1481
2194
|
},
|
|
1482
2195
|
/**
|
|
1483
|
-
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2196
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1484
2197
|
* @param {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
|
|
1485
2198
|
* @param {*} [options] Override http request option.
|
|
1486
2199
|
* @throws {RequiredError}
|
|
@@ -1489,7 +2202,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1489
2202
|
return localVarFp.confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(axios, basePath));
|
|
1490
2203
|
},
|
|
1491
2204
|
/**
|
|
1492
|
-
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2205
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1493
2206
|
* @param {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
|
|
1494
2207
|
* @param {*} [options] Override http request option.
|
|
1495
2208
|
* @throws {RequiredError}
|
|
@@ -1498,7 +2211,16 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1498
2211
|
return localVarFp.confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(axios, basePath));
|
|
1499
2212
|
},
|
|
1500
2213
|
/**
|
|
1501
|
-
*
|
|
2214
|
+
* Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2215
|
+
* @param {FbaInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
|
|
2216
|
+
* @param {*} [options] Override http request option.
|
|
2217
|
+
* @throws {RequiredError}
|
|
2218
|
+
*/
|
|
2219
|
+
confirmShipmentContentUpdatePreview(requestParameters, options) {
|
|
2220
|
+
return localVarFp.confirmShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(axios, basePath));
|
|
2221
|
+
},
|
|
2222
|
+
/**
|
|
2223
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1502
2224
|
* @param {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
|
|
1503
2225
|
* @param {*} [options] Override http request option.
|
|
1504
2226
|
* @throws {RequiredError}
|
|
@@ -1507,7 +2229,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1507
2229
|
return localVarFp.confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1508
2230
|
},
|
|
1509
2231
|
/**
|
|
1510
|
-
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2232
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1511
2233
|
* @param {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
|
|
1512
2234
|
* @param {*} [options] Override http request option.
|
|
1513
2235
|
* @throws {RequiredError}
|
|
@@ -1516,7 +2238,25 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1516
2238
|
return localVarFp.createInboundPlan(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1517
2239
|
},
|
|
1518
2240
|
/**
|
|
1519
|
-
*
|
|
2241
|
+
* For a given marketplace - creates labels for a list of mskus. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2242
|
+
* @param {FbaInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters.
|
|
2243
|
+
* @param {*} [options] Override http request option.
|
|
2244
|
+
* @throws {RequiredError}
|
|
2245
|
+
*/
|
|
2246
|
+
createMarketplaceItemLabels(requestParameters, options) {
|
|
2247
|
+
return localVarFp.createMarketplaceItemLabels(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2248
|
+
},
|
|
2249
|
+
/**
|
|
2250
|
+
* Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2251
|
+
* @param {FbaInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters.
|
|
2252
|
+
* @param {*} [options] Override http request option.
|
|
2253
|
+
* @throws {RequiredError}
|
|
2254
|
+
*/
|
|
2255
|
+
generateDeliveryWindowOptions(requestParameters, options) {
|
|
2256
|
+
return localVarFp.generateDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
2257
|
+
},
|
|
2258
|
+
/**
|
|
2259
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1520
2260
|
* @param {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
|
|
1521
2261
|
* @param {*} [options] Override http request option.
|
|
1522
2262
|
* @throws {RequiredError}
|
|
@@ -1525,7 +2265,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1525
2265
|
return localVarFp.generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
1526
2266
|
},
|
|
1527
2267
|
/**
|
|
1528
|
-
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2268
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1529
2269
|
* @param {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
|
|
1530
2270
|
* @param {*} [options] Override http request option.
|
|
1531
2271
|
* @throws {RequiredError}
|
|
@@ -1534,7 +2274,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1534
2274
|
return localVarFp.generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1535
2275
|
},
|
|
1536
2276
|
/**
|
|
1537
|
-
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2277
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1538
2278
|
* @param {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1539
2279
|
* @param {*} [options] Override http request option.
|
|
1540
2280
|
* @throws {RequiredError}
|
|
@@ -1543,7 +2283,16 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1543
2283
|
return localVarFp.generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1544
2284
|
},
|
|
1545
2285
|
/**
|
|
1546
|
-
*
|
|
2286
|
+
* Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2287
|
+
* @param {FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
|
|
2288
|
+
* @param {*} [options] Override http request option.
|
|
2289
|
+
* @throws {RequiredError}
|
|
2290
|
+
*/
|
|
2291
|
+
generateShipmentContentUpdatePreviews(requestParameters, options) {
|
|
2292
|
+
return localVarFp.generateShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2293
|
+
},
|
|
2294
|
+
/**
|
|
2295
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1547
2296
|
* @param {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
|
|
1548
2297
|
* @param {*} [options] Override http request option.
|
|
1549
2298
|
* @throws {RequiredError}
|
|
@@ -1552,7 +2301,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1552
2301
|
return localVarFp.generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1553
2302
|
},
|
|
1554
2303
|
/**
|
|
1555
|
-
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2304
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1556
2305
|
* @param {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
|
|
1557
2306
|
* @param {*} [options] Override http request option.
|
|
1558
2307
|
* @throws {RequiredError}
|
|
@@ -1561,7 +2310,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1561
2310
|
return localVarFp.getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1562
2311
|
},
|
|
1563
2312
|
/**
|
|
1564
|
-
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2313
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1565
2314
|
* @param {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
|
|
1566
2315
|
* @param {*} [options] Override http request option.
|
|
1567
2316
|
* @throws {RequiredError}
|
|
@@ -1570,7 +2319,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1570
2319
|
return localVarFp.getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(axios, basePath));
|
|
1571
2320
|
},
|
|
1572
2321
|
/**
|
|
1573
|
-
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2322
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1574
2323
|
* @param {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters.
|
|
1575
2324
|
* @param {*} [options] Override http request option.
|
|
1576
2325
|
* @throws {RequiredError}
|
|
@@ -1579,7 +2328,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1579
2328
|
return localVarFp.getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(axios, basePath));
|
|
1580
2329
|
},
|
|
1581
2330
|
/**
|
|
1582
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2331
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1583
2332
|
* @param {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1584
2333
|
* @param {*} [options] Override http request option.
|
|
1585
2334
|
* @throws {RequiredError}
|
|
@@ -1588,7 +2337,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1588
2337
|
return localVarFp.getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1589
2338
|
},
|
|
1590
2339
|
/**
|
|
1591
|
-
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2340
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1592
2341
|
* @param {FbaInboundApiGetShipmentRequest} requestParameters Request parameters.
|
|
1593
2342
|
* @param {*} [options] Override http request option.
|
|
1594
2343
|
* @throws {RequiredError}
|
|
@@ -1597,7 +2346,25 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1597
2346
|
return localVarFp.getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1598
2347
|
},
|
|
1599
2348
|
/**
|
|
1600
|
-
*
|
|
2349
|
+
* Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2350
|
+
* @param {FbaInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
|
|
2351
|
+
* @param {*} [options] Override http request option.
|
|
2352
|
+
* @throws {RequiredError}
|
|
2353
|
+
*/
|
|
2354
|
+
getShipmentContentUpdatePreview(requestParameters, options) {
|
|
2355
|
+
return localVarFp.getShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(axios, basePath));
|
|
2356
|
+
},
|
|
2357
|
+
/**
|
|
2358
|
+
* Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2359
|
+
* @param {FbaInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters.
|
|
2360
|
+
* @param {*} [options] Override http request option.
|
|
2361
|
+
* @throws {RequiredError}
|
|
2362
|
+
*/
|
|
2363
|
+
listDeliveryWindowOptions(requestParameters, options) {
|
|
2364
|
+
return localVarFp.listDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2365
|
+
},
|
|
2366
|
+
/**
|
|
2367
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1601
2368
|
* @param {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
|
|
1602
2369
|
* @param {*} [options] Override http request option.
|
|
1603
2370
|
* @throws {RequiredError}
|
|
@@ -1606,7 +2373,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1606
2373
|
return localVarFp.listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1607
2374
|
},
|
|
1608
2375
|
/**
|
|
1609
|
-
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2376
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1610
2377
|
* @param {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
|
|
1611
2378
|
* @param {*} [options] Override http request option.
|
|
1612
2379
|
* @throws {RequiredError}
|
|
@@ -1615,7 +2382,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1615
2382
|
return localVarFp.listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1616
2383
|
},
|
|
1617
2384
|
/**
|
|
1618
|
-
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2385
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1619
2386
|
* @param {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
|
|
1620
2387
|
* @param {*} [options] Override http request option.
|
|
1621
2388
|
* @throws {RequiredError}
|
|
@@ -1624,7 +2391,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1624
2391
|
return localVarFp.listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1625
2392
|
},
|
|
1626
2393
|
/**
|
|
1627
|
-
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2394
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1628
2395
|
* @param {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters.
|
|
1629
2396
|
* @param {*} [options] Override http request option.
|
|
1630
2397
|
* @throws {RequiredError}
|
|
@@ -1633,7 +2400,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1633
2400
|
return localVarFp.listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(axios, basePath));
|
|
1634
2401
|
},
|
|
1635
2402
|
/**
|
|
1636
|
-
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2403
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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
2404
|
* @param {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
1638
2405
|
* @param {*} [options] Override http request option.
|
|
1639
2406
|
* @throws {RequiredError}
|
|
@@ -1642,16 +2409,25 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1642
2409
|
return localVarFp.listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
1643
2410
|
},
|
|
1644
2411
|
/**
|
|
1645
|
-
* Retrieves a
|
|
2412
|
+
* Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2413
|
+
* @param {FbaInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters.
|
|
2414
|
+
* @param {*} [options] Override http request option.
|
|
2415
|
+
* @throws {RequiredError}
|
|
2416
|
+
*/
|
|
2417
|
+
listPackingGroupBoxes(requestParameters, options) {
|
|
2418
|
+
return localVarFp.listPackingGroupBoxes(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2419
|
+
},
|
|
2420
|
+
/**
|
|
2421
|
+
* Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1646
2422
|
* @param {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
|
|
1647
2423
|
* @param {*} [options] Override http request option.
|
|
1648
2424
|
* @throws {RequiredError}
|
|
1649
2425
|
*/
|
|
1650
2426
|
listPackingGroupItems(requestParameters, options) {
|
|
1651
|
-
return localVarFp.listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.
|
|
2427
|
+
return localVarFp.listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1652
2428
|
},
|
|
1653
2429
|
/**
|
|
1654
|
-
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding
|
|
2430
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1655
2431
|
* @param {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters.
|
|
1656
2432
|
* @param {*} [options] Override http request option.
|
|
1657
2433
|
* @throws {RequiredError}
|
|
@@ -1660,7 +2436,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1660
2436
|
return localVarFp.listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1661
2437
|
},
|
|
1662
2438
|
/**
|
|
1663
|
-
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding
|
|
2439
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1664
2440
|
* @param {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
|
|
1665
2441
|
* @param {*} [options] Override http request option.
|
|
1666
2442
|
* @throws {RequiredError}
|
|
@@ -1669,7 +2445,43 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1669
2445
|
return localVarFp.listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
1670
2446
|
},
|
|
1671
2447
|
/**
|
|
1672
|
-
*
|
|
2448
|
+
* Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2449
|
+
* @param {FbaInboundApiListShipmentBoxesRequest} requestParameters Request parameters.
|
|
2450
|
+
* @param {*} [options] Override http request option.
|
|
2451
|
+
* @throws {RequiredError}
|
|
2452
|
+
*/
|
|
2453
|
+
listShipmentBoxes(requestParameters, options) {
|
|
2454
|
+
return localVarFp.listShipmentBoxes(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2455
|
+
},
|
|
2456
|
+
/**
|
|
2457
|
+
* Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2458
|
+
* @param {FbaInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
|
|
2459
|
+
* @param {*} [options] Override http request option.
|
|
2460
|
+
* @throws {RequiredError}
|
|
2461
|
+
*/
|
|
2462
|
+
listShipmentContentUpdatePreviews(requestParameters, options) {
|
|
2463
|
+
return localVarFp.listShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2464
|
+
},
|
|
2465
|
+
/**
|
|
2466
|
+
* Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2467
|
+
* @param {FbaInboundApiListShipmentItemsRequest} requestParameters Request parameters.
|
|
2468
|
+
* @param {*} [options] Override http request option.
|
|
2469
|
+
* @throws {RequiredError}
|
|
2470
|
+
*/
|
|
2471
|
+
listShipmentItems(requestParameters, options) {
|
|
2472
|
+
return localVarFp.listShipmentItems(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2473
|
+
},
|
|
2474
|
+
/**
|
|
2475
|
+
* Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2476
|
+
* @param {FbaInboundApiListShipmentPalletsRequest} requestParameters Request parameters.
|
|
2477
|
+
* @param {*} [options] Override http request option.
|
|
2478
|
+
* @throws {RequiredError}
|
|
2479
|
+
*/
|
|
2480
|
+
listShipmentPallets(requestParameters, options) {
|
|
2481
|
+
return localVarFp.listShipmentPallets(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(axios, basePath));
|
|
2482
|
+
},
|
|
2483
|
+
/**
|
|
2484
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1673
2485
|
* @param {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
|
|
1674
2486
|
* @param {*} [options] Override http request option.
|
|
1675
2487
|
* @throws {RequiredError}
|
|
@@ -1678,7 +2490,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1678
2490
|
return localVarFp.listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1679
2491
|
},
|
|
1680
2492
|
/**
|
|
1681
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2493
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1682
2494
|
* @param {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
1683
2495
|
* @param {*} [options] Override http request option.
|
|
1684
2496
|
* @throws {RequiredError}
|
|
@@ -1687,7 +2499,7 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1687
2499
|
return localVarFp.scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1688
2500
|
},
|
|
1689
2501
|
/**
|
|
1690
|
-
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
|
|
2502
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1691
2503
|
* @param {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters.
|
|
1692
2504
|
* @param {*} [options] Override http request option.
|
|
1693
2505
|
* @throws {RequiredError}
|
|
@@ -1696,7 +2508,16 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1696
2508
|
return localVarFp.setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1697
2509
|
},
|
|
1698
2510
|
/**
|
|
1699
|
-
*
|
|
2511
|
+
* 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 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).
|
|
2512
|
+
* @param {FbaInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
|
|
2513
|
+
* @param {*} [options] Override http request option.
|
|
2514
|
+
* @throws {RequiredError}
|
|
2515
|
+
*/
|
|
2516
|
+
updateInboundPlanName(requestParameters, options) {
|
|
2517
|
+
return localVarFp.updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2518
|
+
},
|
|
2519
|
+
/**
|
|
2520
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1700
2521
|
* @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
1701
2522
|
* @param {*} [options] Override http request option.
|
|
1702
2523
|
* @throws {RequiredError}
|
|
@@ -1705,16 +2526,25 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
1705
2526
|
return localVarFp.updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1706
2527
|
},
|
|
1707
2528
|
/**
|
|
1708
|
-
*
|
|
1709
|
-
* @param {
|
|
2529
|
+
* Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2530
|
+
* @param {FbaInboundApiUpdateShipmentNameRequest} requestParameters Request parameters.
|
|
2531
|
+
* @param {*} [options] Override http request option.
|
|
2532
|
+
* @throws {RequiredError}
|
|
2533
|
+
*/
|
|
2534
|
+
updateShipmentName(requestParameters, options) {
|
|
2535
|
+
return localVarFp.updateShipmentName(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
2536
|
+
},
|
|
2537
|
+
/**
|
|
2538
|
+
* Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2539
|
+
* @param {FbaInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters.
|
|
1710
2540
|
* @param {*} [options] Override http request option.
|
|
1711
2541
|
* @throws {RequiredError}
|
|
1712
2542
|
*/
|
|
1713
|
-
|
|
1714
|
-
return localVarFp.
|
|
2543
|
+
updateShipmentSourceAddress(requestParameters, options) {
|
|
2544
|
+
return localVarFp.updateShipmentSourceAddress(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1715
2545
|
},
|
|
1716
2546
|
/**
|
|
1717
|
-
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2547
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1718
2548
|
* @param {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
|
|
1719
2549
|
* @param {*} [options] Override http request option.
|
|
1720
2550
|
* @throws {RequiredError}
|
|
@@ -1733,7 +2563,7 @@ exports.FbaInboundApiFactory = FbaInboundApiFactory;
|
|
|
1733
2563
|
*/
|
|
1734
2564
|
class FbaInboundApi extends base_1.BaseAPI {
|
|
1735
2565
|
/**
|
|
1736
|
-
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window
|
|
2566
|
+
* Cancels an Inbound Plan. Charges may apply if the cancellation is performed outside of a void window. The window for Amazon Partnered Carriers is 24 hours for Small Parcel Delivery (SPD) and one hour for Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1737
2567
|
* @param {FbaInboundApiCancelInboundPlanRequest} requestParameters Request parameters.
|
|
1738
2568
|
* @param {*} [options] Override http request option.
|
|
1739
2569
|
* @throws {RequiredError}
|
|
@@ -1743,17 +2573,27 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1743
2573
|
return (0, exports.FbaInboundApiFp)(this.configuration).cancelInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
1744
2574
|
}
|
|
1745
2575
|
/**
|
|
1746
|
-
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2576
|
+
* Cancels a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1747
2577
|
* @param {FbaInboundApiCancelSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
1748
2578
|
* @param {*} [options] Override http request option.
|
|
1749
2579
|
* @throws {RequiredError}
|
|
1750
2580
|
* @memberof FbaInboundApi
|
|
1751
2581
|
*/
|
|
1752
2582
|
cancelSelfShipAppointment(requestParameters, options) {
|
|
1753
|
-
return (0, exports.FbaInboundApiFp)(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.
|
|
2583
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).cancelSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2584
|
+
}
|
|
2585
|
+
/**
|
|
2586
|
+
* Confirms the delivery window option for chosen shipment within an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new delivery window options cannot be generated, but the chosen delivery window option can be updated before shipment closure. The window is used to provide the expected time when a shipment will arrive at the warehouse. All transportation options which have the program `CONFIRMED_DELIVERY_WINDOW` require a delivery window to be confirmed prior to transportation option confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2587
|
+
* @param {FbaInboundApiConfirmDeliveryWindowOptionsRequest} requestParameters Request parameters.
|
|
2588
|
+
* @param {*} [options] Override http request option.
|
|
2589
|
+
* @throws {RequiredError}
|
|
2590
|
+
* @memberof FbaInboundApi
|
|
2591
|
+
*/
|
|
2592
|
+
confirmDeliveryWindowOptions(requestParameters, options) {
|
|
2593
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).confirmDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.deliveryWindowOptionId, options).then((request) => request(this.axios, this.basePath));
|
|
1754
2594
|
}
|
|
1755
2595
|
/**
|
|
1756
|
-
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2596
|
+
* Confirms the packing option for an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1757
2597
|
* @param {FbaInboundApiConfirmPackingOptionRequest} requestParameters Request parameters.
|
|
1758
2598
|
* @param {*} [options] Override http request option.
|
|
1759
2599
|
* @throws {RequiredError}
|
|
@@ -1763,7 +2603,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1763
2603
|
return (0, exports.FbaInboundApiFp)(this.configuration).confirmPackingOption(requestParameters.inboundPlanId, requestParameters.packingOptionId, options).then((request) => request(this.axios, this.basePath));
|
|
1764
2604
|
}
|
|
1765
2605
|
/**
|
|
1766
|
-
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2606
|
+
* Confirms the placement option for an inbound plan. Once confirmed, it cannot be changed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1767
2607
|
* @param {FbaInboundApiConfirmPlacementOptionRequest} requestParameters Request parameters.
|
|
1768
2608
|
* @param {*} [options] Override http request option.
|
|
1769
2609
|
* @throws {RequiredError}
|
|
@@ -1773,7 +2613,17 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1773
2613
|
return (0, exports.FbaInboundApiFp)(this.configuration).confirmPlacementOption(requestParameters.inboundPlanId, requestParameters.placementOptionId, options).then((request) => request(this.axios, this.basePath));
|
|
1774
2614
|
}
|
|
1775
2615
|
/**
|
|
1776
|
-
*
|
|
2616
|
+
* Confirm a shipment content update preview and accept the changes in transportation cost. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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
|
+
* @param {FbaInboundApiConfirmShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
|
|
2618
|
+
* @param {*} [options] Override http request option.
|
|
2619
|
+
* @throws {RequiredError}
|
|
2620
|
+
* @memberof FbaInboundApi
|
|
2621
|
+
*/
|
|
2622
|
+
confirmShipmentContentUpdatePreview(requestParameters, options) {
|
|
2623
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).confirmShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath));
|
|
2624
|
+
}
|
|
2625
|
+
/**
|
|
2626
|
+
* Confirms all the transportation options for an inbound plan. A placement option must be confirmed prior to use of this API. Once confirmed, new transportation options can not be generated or confirmed for the Inbound Plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1777
2627
|
* @param {FbaInboundApiConfirmTransportationOptionsRequest} requestParameters Request parameters.
|
|
1778
2628
|
* @param {*} [options] Override http request option.
|
|
1779
2629
|
* @throws {RequiredError}
|
|
@@ -1783,7 +2633,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1783
2633
|
return (0, exports.FbaInboundApiFp)(this.configuration).confirmTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1784
2634
|
}
|
|
1785
2635
|
/**
|
|
1786
|
-
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2636
|
+
* Creates an inbound plan. An inbound plan contains all the necessary information to send shipments into Amazon\'s fufillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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
2637
|
* @param {FbaInboundApiCreateInboundPlanRequest} requestParameters Request parameters.
|
|
1788
2638
|
* @param {*} [options] Override http request option.
|
|
1789
2639
|
* @throws {RequiredError}
|
|
@@ -1793,7 +2643,27 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1793
2643
|
return (0, exports.FbaInboundApiFp)(this.configuration).createInboundPlan(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1794
2644
|
}
|
|
1795
2645
|
/**
|
|
1796
|
-
*
|
|
2646
|
+
* For a given marketplace - creates labels for a list of mskus. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2647
|
+
* @param {FbaInboundApiCreateMarketplaceItemLabelsRequest} requestParameters Request parameters.
|
|
2648
|
+
* @param {*} [options] Override http request option.
|
|
2649
|
+
* @throws {RequiredError}
|
|
2650
|
+
* @memberof FbaInboundApi
|
|
2651
|
+
*/
|
|
2652
|
+
createMarketplaceItemLabels(requestParameters, options) {
|
|
2653
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).createMarketplaceItemLabels(requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2654
|
+
}
|
|
2655
|
+
/**
|
|
2656
|
+
* Generates available delivery window options for a given shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2657
|
+
* @param {FbaInboundApiGenerateDeliveryWindowOptionsRequest} requestParameters Request parameters.
|
|
2658
|
+
* @param {*} [options] Override http request option.
|
|
2659
|
+
* @throws {RequiredError}
|
|
2660
|
+
* @memberof FbaInboundApi
|
|
2661
|
+
*/
|
|
2662
|
+
generateDeliveryWindowOptions(requestParameters, options) {
|
|
2663
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).generateDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
2664
|
+
}
|
|
2665
|
+
/**
|
|
2666
|
+
* Generates available packing options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1797
2667
|
* @param {FbaInboundApiGeneratePackingOptionsRequest} requestParameters Request parameters.
|
|
1798
2668
|
* @param {*} [options] Override http request option.
|
|
1799
2669
|
* @throws {RequiredError}
|
|
@@ -1803,7 +2673,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1803
2673
|
return (0, exports.FbaInboundApiFp)(this.configuration).generatePackingOptions(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
1804
2674
|
}
|
|
1805
2675
|
/**
|
|
1806
|
-
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2676
|
+
* Generates placement options for the inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1807
2677
|
* @param {FbaInboundApiGeneratePlacementOptionsRequest} requestParameters Request parameters.
|
|
1808
2678
|
* @param {*} [options] Override http request option.
|
|
1809
2679
|
* @throws {RequiredError}
|
|
@@ -1813,7 +2683,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1813
2683
|
return (0, exports.FbaInboundApiFp)(this.configuration).generatePlacementOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1814
2684
|
}
|
|
1815
2685
|
/**
|
|
1816
|
-
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2686
|
+
* Initiates the process of generating the appointment slots list. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1817
2687
|
* @param {FbaInboundApiGenerateSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1818
2688
|
* @param {*} [options] Override http request option.
|
|
1819
2689
|
* @throws {RequiredError}
|
|
@@ -1823,7 +2693,17 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1823
2693
|
return (0, exports.FbaInboundApiFp)(this.configuration).generateSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1824
2694
|
}
|
|
1825
2695
|
/**
|
|
1826
|
-
*
|
|
2696
|
+
* Generate a shipment content update preview given a set of intended boxes and/or items for a shipment with a confirmed carrier. The shipment content update preview will be viewable with the updated costs and contents prior to confirmation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2697
|
+
* @param {FbaInboundApiGenerateShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
|
|
2698
|
+
* @param {*} [options] Override http request option.
|
|
2699
|
+
* @throws {RequiredError}
|
|
2700
|
+
* @memberof FbaInboundApi
|
|
2701
|
+
*/
|
|
2702
|
+
generateShipmentContentUpdatePreviews(requestParameters, options) {
|
|
2703
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).generateShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2704
|
+
}
|
|
2705
|
+
/**
|
|
2706
|
+
* Generates available transportation options for a given placement option. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1827
2707
|
* @param {FbaInboundApiGenerateTransportationOptionsRequest} requestParameters Request parameters.
|
|
1828
2708
|
* @param {*} [options] Override http request option.
|
|
1829
2709
|
* @throws {RequiredError}
|
|
@@ -1833,7 +2713,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1833
2713
|
return (0, exports.FbaInboundApiFp)(this.configuration).generateTransportationOptions(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1834
2714
|
}
|
|
1835
2715
|
/**
|
|
1836
|
-
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2716
|
+
* Provide delivery challan document for PCP transportation in IN marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1837
2717
|
* @param {FbaInboundApiGetDeliveryChallanDocumentRequest} requestParameters Request parameters.
|
|
1838
2718
|
* @param {*} [options] Override http request option.
|
|
1839
2719
|
* @throws {RequiredError}
|
|
@@ -1843,7 +2723,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1843
2723
|
return (0, exports.FbaInboundApiFp)(this.configuration).getDeliveryChallanDocument(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
1844
2724
|
}
|
|
1845
2725
|
/**
|
|
1846
|
-
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2726
|
+
* Gets the status of the processing of an asynchronous API call. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1847
2727
|
* @param {FbaInboundApiGetInboundOperationStatusRequest} requestParameters Request parameters.
|
|
1848
2728
|
* @param {*} [options] Override http request option.
|
|
1849
2729
|
* @throws {RequiredError}
|
|
@@ -1853,7 +2733,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1853
2733
|
return (0, exports.FbaInboundApiFp)(this.configuration).getInboundOperationStatus(requestParameters.operationId, options).then((request) => request(this.axios, this.basePath));
|
|
1854
2734
|
}
|
|
1855
2735
|
/**
|
|
1856
|
-
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2736
|
+
* Fetches the top level information about an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1857
2737
|
* @param {FbaInboundApiGetInboundPlanRequest} requestParameters Request parameters.
|
|
1858
2738
|
* @param {*} [options] Override http request option.
|
|
1859
2739
|
* @throws {RequiredError}
|
|
@@ -1863,7 +2743,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1863
2743
|
return (0, exports.FbaInboundApiFp)(this.configuration).getInboundPlan(requestParameters.inboundPlanId, options).then((request) => request(this.axios, this.basePath));
|
|
1864
2744
|
}
|
|
1865
2745
|
/**
|
|
1866
|
-
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2746
|
+
* Retrieves a list of available self-ship appointment slots used to drop off a shipment at a warehouse. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1867
2747
|
* @param {FbaInboundApiGetSelfShipAppointmentSlotsRequest} requestParameters Request parameters.
|
|
1868
2748
|
* @param {*} [options] Override http request option.
|
|
1869
2749
|
* @throws {RequiredError}
|
|
@@ -1873,7 +2753,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1873
2753
|
return (0, exports.FbaInboundApiFp)(this.configuration).getSelfShipAppointmentSlots(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1874
2754
|
}
|
|
1875
2755
|
/**
|
|
1876
|
-
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2756
|
+
* Provides the full details for a specific shipment within an inbound plan. The `transportationOptionId` inside `acceptedTransportationSelection` can be used to retrieve the transportation details for the shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1877
2757
|
* @param {FbaInboundApiGetShipmentRequest} requestParameters Request parameters.
|
|
1878
2758
|
* @param {*} [options] Override http request option.
|
|
1879
2759
|
* @throws {RequiredError}
|
|
@@ -1883,7 +2763,27 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1883
2763
|
return (0, exports.FbaInboundApiFp)(this.configuration).getShipment(requestParameters.inboundPlanId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
1884
2764
|
}
|
|
1885
2765
|
/**
|
|
1886
|
-
*
|
|
2766
|
+
* Retrieve a shipment content update preview which provides a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2767
|
+
* @param {FbaInboundApiGetShipmentContentUpdatePreviewRequest} requestParameters Request parameters.
|
|
2768
|
+
* @param {*} [options] Override http request option.
|
|
2769
|
+
* @throws {RequiredError}
|
|
2770
|
+
* @memberof FbaInboundApi
|
|
2771
|
+
*/
|
|
2772
|
+
getShipmentContentUpdatePreview(requestParameters, options) {
|
|
2773
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).getShipmentContentUpdatePreview(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.contentUpdatePreviewId, options).then((request) => request(this.axios, this.basePath));
|
|
2774
|
+
}
|
|
2775
|
+
/**
|
|
2776
|
+
* Retrieves all delivery window options for a shipment. Delivery window options must first be generated by the `generateDeliveryWindowOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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
|
+
* @param {FbaInboundApiListDeliveryWindowOptionsRequest} requestParameters Request parameters.
|
|
2778
|
+
* @param {*} [options] Override http request option.
|
|
2779
|
+
* @throws {RequiredError}
|
|
2780
|
+
* @memberof FbaInboundApi
|
|
2781
|
+
*/
|
|
2782
|
+
listDeliveryWindowOptions(requestParameters, options) {
|
|
2783
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listDeliveryWindowOptions(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2784
|
+
}
|
|
2785
|
+
/**
|
|
2786
|
+
* Provides a paginated list of box packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1887
2787
|
* @param {FbaInboundApiListInboundPlanBoxesRequest} requestParameters Request parameters.
|
|
1888
2788
|
* @param {*} [options] Override http request option.
|
|
1889
2789
|
* @throws {RequiredError}
|
|
@@ -1893,7 +2793,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1893
2793
|
return (0, exports.FbaInboundApiFp)(this.configuration).listInboundPlanBoxes(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1894
2794
|
}
|
|
1895
2795
|
/**
|
|
1896
|
-
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2796
|
+
* Provides a paginated list of item packages in an inbound plan. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1897
2797
|
* @param {FbaInboundApiListInboundPlanItemsRequest} requestParameters Request parameters.
|
|
1898
2798
|
* @param {*} [options] Override http request option.
|
|
1899
2799
|
* @throws {RequiredError}
|
|
@@ -1903,7 +2803,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1903
2803
|
return (0, exports.FbaInboundApiFp)(this.configuration).listInboundPlanItems(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1904
2804
|
}
|
|
1905
2805
|
/**
|
|
1906
|
-
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2806
|
+
* Provides a paginated list of pallet packages in an inbound plan. An inbound plan will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1907
2807
|
* @param {FbaInboundApiListInboundPlanPalletsRequest} requestParameters Request parameters.
|
|
1908
2808
|
* @param {*} [options] Override http request option.
|
|
1909
2809
|
* @throws {RequiredError}
|
|
@@ -1913,7 +2813,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1913
2813
|
return (0, exports.FbaInboundApiFp)(this.configuration).listInboundPlanPallets(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1914
2814
|
}
|
|
1915
2815
|
/**
|
|
1916
|
-
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2816
|
+
* Provides a list of inbound plans with minimal information. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1917
2817
|
* @param {FbaInboundApiListInboundPlansRequest} requestParameters Request parameters.
|
|
1918
2818
|
* @param {*} [options] Override http request option.
|
|
1919
2819
|
* @throws {RequiredError}
|
|
@@ -1923,7 +2823,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1923
2823
|
return (0, exports.FbaInboundApiFp)(this.configuration).listInboundPlans(requestParameters.pageSize, requestParameters.paginationToken, requestParameters.status, requestParameters.sortBy, requestParameters.sortOrder, options).then((request) => request(this.axios, this.basePath));
|
|
1924
2824
|
}
|
|
1925
2825
|
/**
|
|
1926
|
-
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2826
|
+
* List the inbound compliance details for MSKUs in a given marketplace. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1927
2827
|
* @param {FbaInboundApiListItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
1928
2828
|
* @param {*} [options] Override http request option.
|
|
1929
2829
|
* @throws {RequiredError}
|
|
@@ -1933,17 +2833,27 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1933
2833
|
return (0, exports.FbaInboundApiFp)(this.configuration).listItemComplianceDetails(requestParameters.mskus, requestParameters.marketplaceId, options).then((request) => request(this.axios, this.basePath));
|
|
1934
2834
|
}
|
|
1935
2835
|
/**
|
|
1936
|
-
* Retrieves a
|
|
2836
|
+
* Retrieves a page of boxes from a given packing group. These boxes were previously provided through the `setPackingInformation` operation. This API is used for workflows where boxes are packed before Amazon determines shipment splits. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2837
|
+
* @param {FbaInboundApiListPackingGroupBoxesRequest} requestParameters Request parameters.
|
|
2838
|
+
* @param {*} [options] Override http request option.
|
|
2839
|
+
* @throws {RequiredError}
|
|
2840
|
+
* @memberof FbaInboundApi
|
|
2841
|
+
*/
|
|
2842
|
+
listPackingGroupBoxes(requestParameters, options) {
|
|
2843
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listPackingGroupBoxes(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2844
|
+
}
|
|
2845
|
+
/**
|
|
2846
|
+
* Retrieves a page of items in a given packing group. Packing options must first be generated by the corresponding operation before packing group items can be listed. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
1937
2847
|
* @param {FbaInboundApiListPackingGroupItemsRequest} requestParameters Request parameters.
|
|
1938
2848
|
* @param {*} [options] Override http request option.
|
|
1939
2849
|
* @throws {RequiredError}
|
|
1940
2850
|
* @memberof FbaInboundApi
|
|
1941
2851
|
*/
|
|
1942
2852
|
listPackingGroupItems(requestParameters, options) {
|
|
1943
|
-
return (0, exports.FbaInboundApiFp)(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.
|
|
2853
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listPackingGroupItems(requestParameters.inboundPlanId, requestParameters.packingGroupId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1944
2854
|
}
|
|
1945
2855
|
/**
|
|
1946
|
-
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding
|
|
2856
|
+
* Retrieves a list of all packing options for an inbound plan. Packing options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1947
2857
|
* @param {FbaInboundApiListPackingOptionsRequest} requestParameters Request parameters.
|
|
1948
2858
|
* @param {*} [options] Override http request option.
|
|
1949
2859
|
* @throws {RequiredError}
|
|
@@ -1953,7 +2863,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1953
2863
|
return (0, exports.FbaInboundApiFp)(this.configuration).listPackingOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1954
2864
|
}
|
|
1955
2865
|
/**
|
|
1956
|
-
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding
|
|
2866
|
+
* Provides a list of all placement options for an inbound plan. Placement options must first be generated by the corresponding operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1957
2867
|
* @param {FbaInboundApiListPlacementOptionsRequest} requestParameters Request parameters.
|
|
1958
2868
|
* @param {*} [options] Override http request option.
|
|
1959
2869
|
* @throws {RequiredError}
|
|
@@ -1963,7 +2873,47 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1963
2873
|
return (0, exports.FbaInboundApiFp)(this.configuration).listPlacementOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
1964
2874
|
}
|
|
1965
2875
|
/**
|
|
1966
|
-
*
|
|
2876
|
+
* Provides a paginated list of box packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2877
|
+
* @param {FbaInboundApiListShipmentBoxesRequest} requestParameters Request parameters.
|
|
2878
|
+
* @param {*} [options] Override http request option.
|
|
2879
|
+
* @throws {RequiredError}
|
|
2880
|
+
* @memberof FbaInboundApi
|
|
2881
|
+
*/
|
|
2882
|
+
listShipmentBoxes(requestParameters, options) {
|
|
2883
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listShipmentBoxes(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2884
|
+
}
|
|
2885
|
+
/**
|
|
2886
|
+
* Retrieve a paginated list of shipment content update previews for a given shipment. The shipment content update preview is a summary of the requested shipment content changes along with the transportation cost implications of the change that can only be confirmed prior to the expiry date specified. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2887
|
+
* @param {FbaInboundApiListShipmentContentUpdatePreviewsRequest} requestParameters Request parameters.
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
* @memberof FbaInboundApi
|
|
2891
|
+
*/
|
|
2892
|
+
listShipmentContentUpdatePreviews(requestParameters, options) {
|
|
2893
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listShipmentContentUpdatePreviews(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2894
|
+
}
|
|
2895
|
+
/**
|
|
2896
|
+
* Provides a paginated list of item packages in a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2897
|
+
* @param {FbaInboundApiListShipmentItemsRequest} requestParameters Request parameters.
|
|
2898
|
+
* @param {*} [options] Override http request option.
|
|
2899
|
+
* @throws {RequiredError}
|
|
2900
|
+
* @memberof FbaInboundApi
|
|
2901
|
+
*/
|
|
2902
|
+
listShipmentItems(requestParameters, options) {
|
|
2903
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listShipmentItems(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2904
|
+
}
|
|
2905
|
+
/**
|
|
2906
|
+
* Provides a paginated list of pallet packages in a shipment. A palletized shipment will have pallets when the related details are provided after generating Less-Than-Truckload (LTL) carrier shipments. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2907
|
+
* @param {FbaInboundApiListShipmentPalletsRequest} requestParameters Request parameters.
|
|
2908
|
+
* @param {*} [options] Override http request option.
|
|
2909
|
+
* @throws {RequiredError}
|
|
2910
|
+
* @memberof FbaInboundApi
|
|
2911
|
+
*/
|
|
2912
|
+
listShipmentPallets(requestParameters, options) {
|
|
2913
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).listShipmentPallets(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.pageSize, requestParameters.paginationToken, options).then((request) => request(this.axios, this.basePath));
|
|
2914
|
+
}
|
|
2915
|
+
/**
|
|
2916
|
+
* Retrieves all transportation options for a shipment. Transportation options must first be generated by the `generateTransportationOptions` operation before becoming available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 6 | 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).
|
|
1967
2917
|
* @param {FbaInboundApiListTransportationOptionsRequest} requestParameters Request parameters.
|
|
1968
2918
|
* @param {*} [options] Override http request option.
|
|
1969
2919
|
* @throws {RequiredError}
|
|
@@ -1973,7 +2923,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1973
2923
|
return (0, exports.FbaInboundApiFp)(this.configuration).listTransportationOptions(requestParameters.inboundPlanId, requestParameters.pageSize, requestParameters.paginationToken, requestParameters.placementOptionId, requestParameters.shipmentId, options).then((request) => request(this.axios, this.basePath));
|
|
1974
2924
|
}
|
|
1975
2925
|
/**
|
|
1976
|
-
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2926
|
+
* Confirms or reschedules a self-ship appointment slot against a shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1977
2927
|
* @param {FbaInboundApiScheduleSelfShipAppointmentRequest} requestParameters Request parameters.
|
|
1978
2928
|
* @param {*} [options] Override http request option.
|
|
1979
2929
|
* @throws {RequiredError}
|
|
@@ -1983,7 +2933,7 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1983
2933
|
return (0, exports.FbaInboundApiFp)(this.configuration).scheduleSelfShipAppointment(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.slotId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1984
2934
|
}
|
|
1985
2935
|
/**
|
|
1986
|
-
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate
|
|
2936
|
+
* Sets packing information for an inbound plan. This should be called after an inbound plan is created to populate the box level information required for planning and transportation estimates. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1987
2937
|
* @param {FbaInboundApiSetPackingInformationRequest} requestParameters Request parameters.
|
|
1988
2938
|
* @param {*} [options] Override http request option.
|
|
1989
2939
|
* @throws {RequiredError}
|
|
@@ -1993,7 +2943,17 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
1993
2943
|
return (0, exports.FbaInboundApiFp)(this.configuration).setPackingInformation(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
1994
2944
|
}
|
|
1995
2945
|
/**
|
|
1996
|
-
*
|
|
2946
|
+
* 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 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).
|
|
2947
|
+
* @param {FbaInboundApiUpdateInboundPlanNameRequest} requestParameters Request parameters.
|
|
2948
|
+
* @param {*} [options] Override http request option.
|
|
2949
|
+
* @throws {RequiredError}
|
|
2950
|
+
* @memberof FbaInboundApi
|
|
2951
|
+
*/
|
|
2952
|
+
updateInboundPlanName(requestParameters, options) {
|
|
2953
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).updateInboundPlanName(requestParameters.inboundPlanId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2954
|
+
}
|
|
2955
|
+
/**
|
|
2956
|
+
* Update compliance details for list of MSKUs. The details provided here are only used for the IN marketplace compliance validation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
1997
2957
|
* @param {FbaInboundApiUpdateItemComplianceDetailsRequest} requestParameters Request parameters.
|
|
1998
2958
|
* @param {*} [options] Override http request option.
|
|
1999
2959
|
* @throws {RequiredError}
|
|
@@ -2003,17 +2963,27 @@ class FbaInboundApi extends base_1.BaseAPI {
|
|
|
2003
2963
|
return (0, exports.FbaInboundApiFp)(this.configuration).updateItemComplianceDetails(requestParameters.marketplaceId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2004
2964
|
}
|
|
2005
2965
|
/**
|
|
2006
|
-
*
|
|
2007
|
-
* @param {
|
|
2966
|
+
* Updates the name of an existing shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2967
|
+
* @param {FbaInboundApiUpdateShipmentNameRequest} requestParameters Request parameters.
|
|
2968
|
+
* @param {*} [options] Override http request option.
|
|
2969
|
+
* @throws {RequiredError}
|
|
2970
|
+
* @memberof FbaInboundApi
|
|
2971
|
+
*/
|
|
2972
|
+
updateShipmentName(requestParameters, options) {
|
|
2973
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).updateShipmentName(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2974
|
+
}
|
|
2975
|
+
/**
|
|
2976
|
+
* Updates the source address of an existing shipment. The shipment source address can only be updated prior to the confirmation of the shipment carriers. As a result of the updated source address, existing transportation options will be invalidated and will need to be regenerated to capture the potential difference in transportation options and quotes due to the new source address. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, 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).
|
|
2977
|
+
* @param {FbaInboundApiUpdateShipmentSourceAddressRequest} requestParameters Request parameters.
|
|
2008
2978
|
* @param {*} [options] Override http request option.
|
|
2009
2979
|
* @throws {RequiredError}
|
|
2010
2980
|
* @memberof FbaInboundApi
|
|
2011
2981
|
*/
|
|
2012
|
-
|
|
2013
|
-
return (0, exports.FbaInboundApiFp)(this.configuration).
|
|
2982
|
+
updateShipmentSourceAddress(requestParameters, options) {
|
|
2983
|
+
return (0, exports.FbaInboundApiFp)(this.configuration).updateShipmentSourceAddress(requestParameters.inboundPlanId, requestParameters.shipmentId, requestParameters.body, options).then((request) => request(this.axios, this.basePath));
|
|
2014
2984
|
}
|
|
2015
2985
|
/**
|
|
2016
|
-
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | |
|
|
2986
|
+
* Updates a shipment\'s tracking details. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 2 | 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).
|
|
2017
2987
|
* @param {FbaInboundApiUpdateShipmentTrackingDetailsRequest} requestParameters Request parameters.
|
|
2018
2988
|
* @param {*} [options] Override http request option.
|
|
2019
2989
|
* @throws {RequiredError}
|