@sp-api-sdk/fulfillment-inbound-api-v0 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/src/api-model/api/fba-inbound-api.js +116 -28
- package/dist/cjs/src/api-model/base.js +7 -2
- package/dist/cjs/src/api-model/common.js +1 -1
- package/dist/cjs/src/api-model/configuration.js +8 -0
- package/dist/es/src/api-model/api/fba-inbound-api.js +116 -28
- package/dist/es/src/api-model/base.js +6 -1
- package/dist/es/src/api-model/common.js +1 -1
- package/dist/es/src/api-model/configuration.js +8 -0
- package/dist/types/src/api-model/api/fba-inbound-api.d.ts +159 -98
- package/dist/types/src/api-model/base.d.ts +14 -2
- package/dist/types/src/api-model/configuration.d.ts +8 -0
- package/dist/types/src/api-model/models/amazon-prep-fees-details.d.ts +2 -2
- package/dist/types/src/api-model/models/amount.d.ts +1 -1
- package/dist/types/src/api-model/models/asininbound-guidance.d.ts +2 -2
- package/dist/types/src/api-model/models/asinprep-instructions.d.ts +3 -3
- package/dist/types/src/api-model/models/box-contents-fee-details.d.ts +1 -1
- package/dist/types/src/api-model/models/common-transport-result.d.ts +1 -1
- package/dist/types/src/api-model/models/confirm-preorder-response.d.ts +1 -1
- package/dist/types/src/api-model/models/confirm-transport-response.d.ts +1 -1
- package/dist/types/src/api-model/models/create-inbound-shipment-plan-request.d.ts +3 -3
- package/dist/types/src/api-model/models/create-inbound-shipment-plan-response.d.ts +1 -1
- package/dist/types/src/api-model/models/create-inbound-shipment-plan-result.d.ts +1 -1
- package/dist/types/src/api-model/models/dimensions.d.ts +1 -1
- package/dist/types/src/api-model/models/estimate-transport-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-bill-of-lading-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-inbound-guidance-result.d.ts +4 -4
- package/dist/types/src/api-model/models/get-labels-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-preorder-info-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-prep-instructions-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-prep-instructions-result.d.ts +4 -4
- package/dist/types/src/api-model/models/get-shipment-items-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-shipment-items-result.d.ts +1 -1
- package/dist/types/src/api-model/models/get-shipments-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-shipments-result.d.ts +1 -1
- package/dist/types/src/api-model/models/get-transport-details-response.d.ts +1 -1
- package/dist/types/src/api-model/models/get-transport-details-result.d.ts +1 -1
- package/dist/types/src/api-model/models/inbound-shipment-header.d.ts +4 -4
- package/dist/types/src/api-model/models/inbound-shipment-info.d.ts +5 -5
- package/dist/types/src/api-model/models/inbound-shipment-item.d.ts +1 -1
- package/dist/types/src/api-model/models/inbound-shipment-plan-item.d.ts +1 -1
- package/dist/types/src/api-model/models/inbound-shipment-plan-request-item.d.ts +2 -2
- package/dist/types/src/api-model/models/inbound-shipment-plan.d.ts +4 -4
- package/dist/types/src/api-model/models/inbound-shipment-request.d.ts +2 -2
- package/dist/types/src/api-model/models/inbound-shipment-response.d.ts +1 -1
- package/dist/types/src/api-model/models/invalid-asin.d.ts +1 -1
- package/dist/types/src/api-model/models/invalid-sku.d.ts +1 -1
- package/dist/types/src/api-model/models/non-partnered-small-parcel-data-input.d.ts +1 -1
- package/dist/types/src/api-model/models/non-partnered-small-parcel-data-output.d.ts +1 -1
- package/dist/types/src/api-model/models/non-partnered-small-parcel-package-output.d.ts +1 -1
- package/dist/types/src/api-model/models/pallet.d.ts +2 -2
- package/dist/types/src/api-model/models/partnered-estimate.d.ts +1 -1
- package/dist/types/src/api-model/models/partnered-ltl-data-input.d.ts +5 -5
- package/dist/types/src/api-model/models/partnered-ltl-data-output.d.ts +6 -6
- package/dist/types/src/api-model/models/partnered-small-parcel-data-input.d.ts +1 -1
- package/dist/types/src/api-model/models/partnered-small-parcel-data-output.d.ts +2 -2
- package/dist/types/src/api-model/models/partnered-small-parcel-package-input.d.ts +2 -2
- package/dist/types/src/api-model/models/partnered-small-parcel-package-output.d.ts +3 -3
- package/dist/types/src/api-model/models/prep-details.d.ts +2 -2
- package/dist/types/src/api-model/models/put-transport-details-request.d.ts +2 -2
- package/dist/types/src/api-model/models/put-transport-details-response.d.ts +1 -1
- package/dist/types/src/api-model/models/skuinbound-guidance.d.ts +2 -2
- package/dist/types/src/api-model/models/skuprep-instructions.d.ts +4 -4
- package/dist/types/src/api-model/models/transport-content.d.ts +3 -3
- package/dist/types/src/api-model/models/transport-detail-input.d.ts +4 -4
- package/dist/types/src/api-model/models/transport-detail-output.d.ts +4 -4
- package/dist/types/src/api-model/models/transport-header.d.ts +1 -1
- package/dist/types/src/api-model/models/transport-result.d.ts +1 -1
- package/dist/types/src/api-model/models/void-transport-response.d.ts +1 -1
- package/dist/types/src/api-model/models/weight.d.ts +1 -1
- package/package.json +4 -4
|
@@ -10,26 +10,26 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { Configuration } from '../configuration';
|
|
13
|
-
import type { AxiosPromise, AxiosInstance,
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
16
|
-
import { ConfirmPreorderResponse } from '../models';
|
|
17
|
-
import { ConfirmTransportResponse } from '../models';
|
|
18
|
-
import { CreateInboundShipmentPlanRequest } from '../models';
|
|
19
|
-
import { CreateInboundShipmentPlanResponse } from '../models';
|
|
20
|
-
import { EstimateTransportResponse } from '../models';
|
|
21
|
-
import { GetBillOfLadingResponse } from '../models';
|
|
22
|
-
import { GetLabelsResponse } from '../models';
|
|
23
|
-
import { GetPreorderInfoResponse } from '../models';
|
|
24
|
-
import { GetPrepInstructionsResponse } from '../models';
|
|
25
|
-
import { GetShipmentItemsResponse } from '../models';
|
|
26
|
-
import { GetShipmentsResponse } from '../models';
|
|
27
|
-
import { GetTransportDetailsResponse } from '../models';
|
|
28
|
-
import { InboundShipmentRequest } from '../models';
|
|
29
|
-
import { InboundShipmentResponse } from '../models';
|
|
30
|
-
import { PutTransportDetailsRequest } from '../models';
|
|
31
|
-
import { PutTransportDetailsResponse } from '../models';
|
|
32
|
-
import { VoidTransportResponse } from '../models';
|
|
15
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
16
|
+
import type { ConfirmPreorderResponse } from '../models';
|
|
17
|
+
import type { ConfirmTransportResponse } from '../models';
|
|
18
|
+
import type { CreateInboundShipmentPlanRequest } from '../models';
|
|
19
|
+
import type { CreateInboundShipmentPlanResponse } from '../models';
|
|
20
|
+
import type { EstimateTransportResponse } from '../models';
|
|
21
|
+
import type { GetBillOfLadingResponse } from '../models';
|
|
22
|
+
import type { GetLabelsResponse } from '../models';
|
|
23
|
+
import type { GetPreorderInfoResponse } from '../models';
|
|
24
|
+
import type { GetPrepInstructionsResponse } from '../models';
|
|
25
|
+
import type { GetShipmentItemsResponse } from '../models';
|
|
26
|
+
import type { GetShipmentsResponse } from '../models';
|
|
27
|
+
import type { GetTransportDetailsResponse } from '../models';
|
|
28
|
+
import type { InboundShipmentRequest } from '../models';
|
|
29
|
+
import type { InboundShipmentResponse } from '../models';
|
|
30
|
+
import type { PutTransportDetailsRequest } from '../models';
|
|
31
|
+
import type { PutTransportDetailsResponse } from '../models';
|
|
32
|
+
import type { VoidTransportResponse } from '../models';
|
|
33
33
|
/**
|
|
34
34
|
* FbaInboundApi - axios parameter creator
|
|
35
35
|
* @export
|
|
@@ -44,7 +44,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
44
44
|
* @deprecated
|
|
45
45
|
* @throws {RequiredError}
|
|
46
46
|
*/
|
|
47
|
-
confirmPreorder: (shipmentId: string, needByDate: string, marketplaceId: string, options?:
|
|
47
|
+
confirmPreorder: (shipmentId: string, needByDate: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
48
|
/**
|
|
49
49
|
* Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller\'s account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
50
50
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -52,7 +52,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
52
52
|
* @deprecated
|
|
53
53
|
* @throws {RequiredError}
|
|
54
54
|
*/
|
|
55
|
-
confirmTransport: (shipmentId: string, options?:
|
|
55
|
+
confirmTransport: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
56
|
/**
|
|
57
57
|
* Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
58
58
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -61,7 +61,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
61
61
|
* @deprecated
|
|
62
62
|
* @throws {RequiredError}
|
|
63
63
|
*/
|
|
64
|
-
createInboundShipment: (shipmentId: string, body: InboundShipmentRequest, options?:
|
|
64
|
+
createInboundShipment: (shipmentId: string, body: InboundShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
65
|
/**
|
|
66
66
|
* Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon\'s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
67
67
|
* @param {CreateInboundShipmentPlanRequest} body The request schema for the CreateInboundShipmentPlanRequest operation.
|
|
@@ -69,7 +69,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
69
69
|
* @deprecated
|
|
70
70
|
* @throws {RequiredError}
|
|
71
71
|
*/
|
|
72
|
-
createInboundShipmentPlan: (body: CreateInboundShipmentPlanRequest, options?:
|
|
72
|
+
createInboundShipmentPlan: (body: CreateInboundShipmentPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
73
73
|
/**
|
|
74
74
|
* Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
75
75
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -77,19 +77,19 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
77
77
|
* @deprecated
|
|
78
78
|
* @throws {RequiredError}
|
|
79
79
|
*/
|
|
80
|
-
estimateTransport: (shipmentId: string, options?:
|
|
80
|
+
estimateTransport: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
81
81
|
/**
|
|
82
82
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
83
83
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
84
84
|
* @param {*} [options] Override http request option.
|
|
85
85
|
* @throws {RequiredError}
|
|
86
86
|
*/
|
|
87
|
-
getBillOfLading: (shipmentId: string, options?:
|
|
87
|
+
getBillOfLading: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
88
88
|
/**
|
|
89
89
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
90
90
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
91
|
+
* @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
|
|
92
|
+
* @param {GetLabelsLabelTypeEnum} labelType The type of labels requested.
|
|
93
93
|
* @param {number} [numberOfPackages] The number of packages in the shipment.
|
|
94
94
|
* @param {Array<string>} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.
|
|
95
95
|
* @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
|
|
@@ -98,7 +98,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
|
-
getLabels: (shipmentId: string, pageType:
|
|
101
|
+
getLabels: (shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array<string>, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
102
|
/**
|
|
103
103
|
* Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
104
104
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -107,7 +107,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
107
107
|
* @deprecated
|
|
108
108
|
* @throws {RequiredError}
|
|
109
109
|
*/
|
|
110
|
-
getPreorderInfo: (shipmentId: string, marketplaceId: string, options?:
|
|
110
|
+
getPreorderInfo: (shipmentId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
111
|
/**
|
|
112
112
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
113
113
|
* @param {string} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
|
|
@@ -116,10 +116,10 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
116
116
|
* @param {*} [options] Override http request option.
|
|
117
117
|
* @throws {RequiredError}
|
|
118
118
|
*/
|
|
119
|
-
getPrepInstructions: (shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?:
|
|
119
|
+
getPrepInstructions: (shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
120
120
|
/**
|
|
121
121
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
122
|
-
* @param {
|
|
122
|
+
* @param {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
|
|
123
123
|
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
124
124
|
* @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
125
125
|
* @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
@@ -128,7 +128,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
128
128
|
* @deprecated
|
|
129
129
|
* @throws {RequiredError}
|
|
130
130
|
*/
|
|
131
|
-
getShipmentItems: (queryType:
|
|
131
|
+
getShipmentItems: (queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
132
132
|
/**
|
|
133
133
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
134
134
|
* @param {string} shipmentId A shipment identifier used for selecting items in a specific inbound shipment.
|
|
@@ -137,12 +137,12 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
137
137
|
* @deprecated
|
|
138
138
|
* @throws {RequiredError}
|
|
139
139
|
*/
|
|
140
|
-
getShipmentItemsByShipmentId: (shipmentId: string, marketplaceId: string, options?:
|
|
140
|
+
getShipmentItemsByShipmentId: (shipmentId: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
141
141
|
/**
|
|
142
142
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
143
|
-
* @param {
|
|
143
|
+
* @param {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
|
|
144
144
|
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
145
|
-
* @param {Array<
|
|
145
|
+
* @param {Array<GetShipmentsShipmentStatusListEnum>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
|
|
146
146
|
* @param {Array<string>} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
|
|
147
147
|
* @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
148
148
|
* @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
@@ -151,7 +151,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
151
151
|
* @deprecated
|
|
152
152
|
* @throws {RequiredError}
|
|
153
153
|
*/
|
|
154
|
-
getShipments: (queryType:
|
|
154
|
+
getShipments: (queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
155
155
|
/**
|
|
156
156
|
* Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
157
157
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -159,7 +159,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
159
159
|
* @deprecated
|
|
160
160
|
* @throws {RequiredError}
|
|
161
161
|
*/
|
|
162
|
-
getTransportDetails: (shipmentId: string, options?:
|
|
162
|
+
getTransportDetails: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
163
163
|
/**
|
|
164
164
|
* Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
165
165
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -168,7 +168,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
168
168
|
* @deprecated
|
|
169
169
|
* @throws {RequiredError}
|
|
170
170
|
*/
|
|
171
|
-
putTransportDetails: (shipmentId: string, body: PutTransportDetailsRequest, options?:
|
|
171
|
+
putTransportDetails: (shipmentId: string, body: PutTransportDetailsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
172
172
|
/**
|
|
173
173
|
* Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
174
174
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -177,7 +177,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
177
177
|
* @deprecated
|
|
178
178
|
* @throws {RequiredError}
|
|
179
179
|
*/
|
|
180
|
-
updateInboundShipment: (shipmentId: string, body: InboundShipmentRequest, options?:
|
|
180
|
+
updateInboundShipment: (shipmentId: string, body: InboundShipmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
181
181
|
/**
|
|
182
182
|
* Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
183
183
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -185,7 +185,7 @@ export declare const FbaInboundApiAxiosParamCreator: (configuration?: Configurat
|
|
|
185
185
|
* @deprecated
|
|
186
186
|
* @throws {RequiredError}
|
|
187
187
|
*/
|
|
188
|
-
voidTransport: (shipmentId: string, options?:
|
|
188
|
+
voidTransport: (shipmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
189
189
|
};
|
|
190
190
|
/**
|
|
191
191
|
* FbaInboundApi - functional programming interface
|
|
@@ -201,7 +201,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
201
201
|
* @deprecated
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
204
|
-
confirmPreorder(shipmentId: string, needByDate: string, marketplaceId: string, options?:
|
|
204
|
+
confirmPreorder(shipmentId: string, needByDate: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmPreorderResponse>>;
|
|
205
205
|
/**
|
|
206
206
|
* Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller\'s account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
207
207
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -209,7 +209,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
209
209
|
* @deprecated
|
|
210
210
|
* @throws {RequiredError}
|
|
211
211
|
*/
|
|
212
|
-
confirmTransport(shipmentId: string, options?:
|
|
212
|
+
confirmTransport(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfirmTransportResponse>>;
|
|
213
213
|
/**
|
|
214
214
|
* Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
215
215
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -218,7 +218,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
218
218
|
* @deprecated
|
|
219
219
|
* @throws {RequiredError}
|
|
220
220
|
*/
|
|
221
|
-
createInboundShipment(shipmentId: string, body: InboundShipmentRequest, options?:
|
|
221
|
+
createInboundShipment(shipmentId: string, body: InboundShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundShipmentResponse>>;
|
|
222
222
|
/**
|
|
223
223
|
* Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon\'s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
224
224
|
* @param {CreateInboundShipmentPlanRequest} body The request schema for the CreateInboundShipmentPlanRequest operation.
|
|
@@ -226,7 +226,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
226
226
|
* @deprecated
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
createInboundShipmentPlan(body: CreateInboundShipmentPlanRequest, options?:
|
|
229
|
+
createInboundShipmentPlan(body: CreateInboundShipmentPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateInboundShipmentPlanResponse>>;
|
|
230
230
|
/**
|
|
231
231
|
* Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
232
232
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -234,19 +234,19 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
234
234
|
* @deprecated
|
|
235
235
|
* @throws {RequiredError}
|
|
236
236
|
*/
|
|
237
|
-
estimateTransport(shipmentId: string, options?:
|
|
237
|
+
estimateTransport(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EstimateTransportResponse>>;
|
|
238
238
|
/**
|
|
239
239
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
240
240
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
241
241
|
* @param {*} [options] Override http request option.
|
|
242
242
|
* @throws {RequiredError}
|
|
243
243
|
*/
|
|
244
|
-
getBillOfLading(shipmentId: string, options?:
|
|
244
|
+
getBillOfLading(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBillOfLadingResponse>>;
|
|
245
245
|
/**
|
|
246
246
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
247
247
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
248
|
-
* @param {
|
|
249
|
-
* @param {
|
|
248
|
+
* @param {GetLabelsPageTypeEnum} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
|
|
249
|
+
* @param {GetLabelsLabelTypeEnum} labelType The type of labels requested.
|
|
250
250
|
* @param {number} [numberOfPackages] The number of packages in the shipment.
|
|
251
251
|
* @param {Array<string>} [packageLabelsToPrint] A list of identifiers that specify packages for which you want package labels printed. Must match CartonId values previously passed using the FBA Inbound Shipment Carton Information Feed. If not, the operation returns the IncorrectPackageIdentifier error code.
|
|
252
252
|
* @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
|
|
@@ -255,7 +255,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
255
255
|
* @param {*} [options] Override http request option.
|
|
256
256
|
* @throws {RequiredError}
|
|
257
257
|
*/
|
|
258
|
-
getLabels(shipmentId: string, pageType:
|
|
258
|
+
getLabels(shipmentId: string, pageType: GetLabelsPageTypeEnum, labelType: GetLabelsLabelTypeEnum, numberOfPackages?: number, packageLabelsToPrint?: Array<string>, numberOfPallets?: number, pageSize?: number, pageStartIndex?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLabelsResponse>>;
|
|
259
259
|
/**
|
|
260
260
|
* Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
261
261
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -264,7 +264,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
264
264
|
* @deprecated
|
|
265
265
|
* @throws {RequiredError}
|
|
266
266
|
*/
|
|
267
|
-
getPreorderInfo(shipmentId: string, marketplaceId: string, options?:
|
|
267
|
+
getPreorderInfo(shipmentId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPreorderInfoResponse>>;
|
|
268
268
|
/**
|
|
269
269
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
270
270
|
* @param {string} shipToCountryCode The country code of the country to which the items will be shipped. Note that labeling requirements and item preparation instructions can vary by country.
|
|
@@ -273,10 +273,10 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
273
273
|
* @param {*} [options] Override http request option.
|
|
274
274
|
* @throws {RequiredError}
|
|
275
275
|
*/
|
|
276
|
-
getPrepInstructions(shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?:
|
|
276
|
+
getPrepInstructions(shipToCountryCode: string, sellerSKUList?: Array<string>, aSINList?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPrepInstructionsResponse>>;
|
|
277
277
|
/**
|
|
278
278
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
279
|
-
* @param {
|
|
279
|
+
* @param {GetShipmentItemsQueryTypeEnum} queryType Indicates whether items are returned using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or using NextToken, which continues returning items specified in a previous request.
|
|
280
280
|
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
281
281
|
* @param {string} [lastUpdatedAfter] A date used for selecting inbound shipment items that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
282
282
|
* @param {string} [lastUpdatedBefore] A date used for selecting inbound shipment items that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
@@ -285,7 +285,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
285
285
|
* @deprecated
|
|
286
286
|
* @throws {RequiredError}
|
|
287
287
|
*/
|
|
288
|
-
getShipmentItems(queryType:
|
|
288
|
+
getShipmentItems(queryType: GetShipmentItemsQueryTypeEnum, marketplaceId: string, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentItemsResponse>>;
|
|
289
289
|
/**
|
|
290
290
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
291
291
|
* @param {string} shipmentId A shipment identifier used for selecting items in a specific inbound shipment.
|
|
@@ -294,12 +294,12 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
294
294
|
* @deprecated
|
|
295
295
|
* @throws {RequiredError}
|
|
296
296
|
*/
|
|
297
|
-
getShipmentItemsByShipmentId(shipmentId: string, marketplaceId: string, options?:
|
|
297
|
+
getShipmentItemsByShipmentId(shipmentId: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentItemsResponse>>;
|
|
298
298
|
/**
|
|
299
299
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
300
|
-
* @param {
|
|
300
|
+
* @param {GetShipmentsQueryTypeEnum} queryType Indicates whether shipments are returned using shipment information (by providing the ShipmentStatusList or ShipmentIdList parameters), using a date range (by providing the LastUpdatedAfter and LastUpdatedBefore parameters), or by using NextToken to continue returning items specified in a previous request.
|
|
301
301
|
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
302
|
-
* @param {Array<
|
|
302
|
+
* @param {Array<GetShipmentsShipmentStatusListEnum>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
|
|
303
303
|
* @param {Array<string>} [shipmentIdList] A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
|
|
304
304
|
* @param {string} [lastUpdatedAfter] A date used for selecting inbound shipments that were last updated after (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
305
305
|
* @param {string} [lastUpdatedBefore] A date used for selecting inbound shipments that were last updated before (or at) a specified time. The selection includes updates made by Amazon and by the seller.
|
|
@@ -308,7 +308,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
308
308
|
* @deprecated
|
|
309
309
|
* @throws {RequiredError}
|
|
310
310
|
*/
|
|
311
|
-
getShipments(queryType:
|
|
311
|
+
getShipments(queryType: GetShipmentsQueryTypeEnum, marketplaceId: string, shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>, shipmentIdList?: Array<string>, lastUpdatedAfter?: string, lastUpdatedBefore?: string, nextToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetShipmentsResponse>>;
|
|
312
312
|
/**
|
|
313
313
|
* Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
314
314
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -316,7 +316,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
316
316
|
* @deprecated
|
|
317
317
|
* @throws {RequiredError}
|
|
318
318
|
*/
|
|
319
|
-
getTransportDetails(shipmentId: string, options?:
|
|
319
|
+
getTransportDetails(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTransportDetailsResponse>>;
|
|
320
320
|
/**
|
|
321
321
|
* Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
322
322
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -325,7 +325,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
325
325
|
* @deprecated
|
|
326
326
|
* @throws {RequiredError}
|
|
327
327
|
*/
|
|
328
|
-
putTransportDetails(shipmentId: string, body: PutTransportDetailsRequest, options?:
|
|
328
|
+
putTransportDetails(shipmentId: string, body: PutTransportDetailsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutTransportDetailsResponse>>;
|
|
329
329
|
/**
|
|
330
330
|
* Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
331
331
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -334,7 +334,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
334
334
|
* @deprecated
|
|
335
335
|
* @throws {RequiredError}
|
|
336
336
|
*/
|
|
337
|
-
updateInboundShipment(shipmentId: string, body: InboundShipmentRequest, options?:
|
|
337
|
+
updateInboundShipment(shipmentId: string, body: InboundShipmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InboundShipmentResponse>>;
|
|
338
338
|
/**
|
|
339
339
|
* Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
340
340
|
* @param {string} shipmentId A shipment identifier originally returned by the createInboundShipmentPlan operation.
|
|
@@ -342,7 +342,7 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
342
342
|
* @deprecated
|
|
343
343
|
* @throws {RequiredError}
|
|
344
344
|
*/
|
|
345
|
-
voidTransport(shipmentId: string, options?:
|
|
345
|
+
voidTransport(shipmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VoidTransportResponse>>;
|
|
346
346
|
};
|
|
347
347
|
/**
|
|
348
348
|
* FbaInboundApi - factory interface
|
|
@@ -356,7 +356,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
356
356
|
* @deprecated
|
|
357
357
|
* @throws {RequiredError}
|
|
358
358
|
*/
|
|
359
|
-
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?:
|
|
359
|
+
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmPreorderResponse>;
|
|
360
360
|
/**
|
|
361
361
|
* Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller\'s account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
362
362
|
* @param {FbaInboundApiConfirmTransportRequest} requestParameters Request parameters.
|
|
@@ -364,7 +364,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
364
364
|
* @deprecated
|
|
365
365
|
* @throws {RequiredError}
|
|
366
366
|
*/
|
|
367
|
-
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?:
|
|
367
|
+
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConfirmTransportResponse>;
|
|
368
368
|
/**
|
|
369
369
|
* Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
370
370
|
* @param {FbaInboundApiCreateInboundShipmentRequest} requestParameters Request parameters.
|
|
@@ -372,7 +372,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
372
372
|
* @deprecated
|
|
373
373
|
* @throws {RequiredError}
|
|
374
374
|
*/
|
|
375
|
-
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?:
|
|
375
|
+
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundShipmentResponse>;
|
|
376
376
|
/**
|
|
377
377
|
* Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon\'s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
378
378
|
* @param {FbaInboundApiCreateInboundShipmentPlanRequest} requestParameters Request parameters.
|
|
@@ -380,7 +380,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
380
380
|
* @deprecated
|
|
381
381
|
* @throws {RequiredError}
|
|
382
382
|
*/
|
|
383
|
-
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?:
|
|
383
|
+
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateInboundShipmentPlanResponse>;
|
|
384
384
|
/**
|
|
385
385
|
* Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
386
386
|
* @param {FbaInboundApiEstimateTransportRequest} requestParameters Request parameters.
|
|
@@ -388,21 +388,21 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
388
388
|
* @deprecated
|
|
389
389
|
* @throws {RequiredError}
|
|
390
390
|
*/
|
|
391
|
-
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?:
|
|
391
|
+
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?: RawAxiosRequestConfig): AxiosPromise<EstimateTransportResponse>;
|
|
392
392
|
/**
|
|
393
393
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
394
394
|
* @param {FbaInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
395
395
|
* @param {*} [options] Override http request option.
|
|
396
396
|
* @throws {RequiredError}
|
|
397
397
|
*/
|
|
398
|
-
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?:
|
|
398
|
+
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetBillOfLadingResponse>;
|
|
399
399
|
/**
|
|
400
400
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
401
401
|
* @param {FbaInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
402
402
|
* @param {*} [options] Override http request option.
|
|
403
403
|
* @throws {RequiredError}
|
|
404
404
|
*/
|
|
405
|
-
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?:
|
|
405
|
+
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLabelsResponse>;
|
|
406
406
|
/**
|
|
407
407
|
* Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
408
408
|
* @param {FbaInboundApiGetPreorderInfoRequest} requestParameters Request parameters.
|
|
@@ -410,14 +410,14 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
410
410
|
* @deprecated
|
|
411
411
|
* @throws {RequiredError}
|
|
412
412
|
*/
|
|
413
|
-
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?:
|
|
413
|
+
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPreorderInfoResponse>;
|
|
414
414
|
/**
|
|
415
415
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
416
416
|
* @param {FbaInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
417
417
|
* @param {*} [options] Override http request option.
|
|
418
418
|
* @throws {RequiredError}
|
|
419
419
|
*/
|
|
420
|
-
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?:
|
|
420
|
+
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPrepInstructionsResponse>;
|
|
421
421
|
/**
|
|
422
422
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
423
423
|
* @param {FbaInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
@@ -425,7 +425,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
425
425
|
* @deprecated
|
|
426
426
|
* @throws {RequiredError}
|
|
427
427
|
*/
|
|
428
|
-
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?:
|
|
428
|
+
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
|
|
429
429
|
/**
|
|
430
430
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
431
431
|
* @param {FbaInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
@@ -433,7 +433,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
433
433
|
* @deprecated
|
|
434
434
|
* @throws {RequiredError}
|
|
435
435
|
*/
|
|
436
|
-
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?:
|
|
436
|
+
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
|
|
437
437
|
/**
|
|
438
438
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
439
439
|
* @param {FbaInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
@@ -441,7 +441,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
441
441
|
* @deprecated
|
|
442
442
|
* @throws {RequiredError}
|
|
443
443
|
*/
|
|
444
|
-
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?:
|
|
444
|
+
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetShipmentsResponse>;
|
|
445
445
|
/**
|
|
446
446
|
* Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
447
447
|
* @param {FbaInboundApiGetTransportDetailsRequest} requestParameters Request parameters.
|
|
@@ -449,7 +449,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
449
449
|
* @deprecated
|
|
450
450
|
* @throws {RequiredError}
|
|
451
451
|
*/
|
|
452
|
-
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?:
|
|
452
|
+
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetTransportDetailsResponse>;
|
|
453
453
|
/**
|
|
454
454
|
* Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
455
455
|
* @param {FbaInboundApiPutTransportDetailsRequest} requestParameters Request parameters.
|
|
@@ -457,7 +457,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
457
457
|
* @deprecated
|
|
458
458
|
* @throws {RequiredError}
|
|
459
459
|
*/
|
|
460
|
-
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?:
|
|
460
|
+
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PutTransportDetailsResponse>;
|
|
461
461
|
/**
|
|
462
462
|
* Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
463
463
|
* @param {FbaInboundApiUpdateInboundShipmentRequest} requestParameters Request parameters.
|
|
@@ -465,7 +465,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
465
465
|
* @deprecated
|
|
466
466
|
* @throws {RequiredError}
|
|
467
467
|
*/
|
|
468
|
-
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?:
|
|
468
|
+
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<InboundShipmentResponse>;
|
|
469
469
|
/**
|
|
470
470
|
* Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
471
471
|
* @param {FbaInboundApiVoidTransportRequest} requestParameters Request parameters.
|
|
@@ -473,7 +473,7 @@ export declare const FbaInboundApiFactory: (configuration?: Configuration, baseP
|
|
|
473
473
|
* @deprecated
|
|
474
474
|
* @throws {RequiredError}
|
|
475
475
|
*/
|
|
476
|
-
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?:
|
|
476
|
+
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?: RawAxiosRequestConfig): AxiosPromise<VoidTransportResponse>;
|
|
477
477
|
};
|
|
478
478
|
/**
|
|
479
479
|
* Request parameters for confirmPreorder operation in FbaInboundApi.
|
|
@@ -588,13 +588,13 @@ export interface FbaInboundApiGetLabelsRequest {
|
|
|
588
588
|
* @type {'PackageLabel_Letter_2' | 'PackageLabel_Letter_4' | 'PackageLabel_Letter_6' | 'PackageLabel_Letter_6_CarrierLeft' | 'PackageLabel_A4_2' | 'PackageLabel_A4_4' | 'PackageLabel_Plain_Paper' | 'PackageLabel_Plain_Paper_CarrierBottom' | 'PackageLabel_Thermal' | 'PackageLabel_Thermal_Unified' | 'PackageLabel_Thermal_NonPCP' | 'PackageLabel_Thermal_No_Carrier_Rotation'}
|
|
589
589
|
* @memberof FbaInboundApiGetLabels
|
|
590
590
|
*/
|
|
591
|
-
readonly pageType:
|
|
591
|
+
readonly pageType: GetLabelsPageTypeEnum;
|
|
592
592
|
/**
|
|
593
593
|
* The type of labels requested.
|
|
594
594
|
* @type {'BARCODE_2D' | 'UNIQUE' | 'PALLET'}
|
|
595
595
|
* @memberof FbaInboundApiGetLabels
|
|
596
596
|
*/
|
|
597
|
-
readonly labelType:
|
|
597
|
+
readonly labelType: GetLabelsLabelTypeEnum;
|
|
598
598
|
/**
|
|
599
599
|
* The number of packages in the shipment.
|
|
600
600
|
* @type {number}
|
|
@@ -681,7 +681,7 @@ export interface FbaInboundApiGetShipmentItemsRequest {
|
|
|
681
681
|
* @type {'DATE_RANGE' | 'NEXT_TOKEN'}
|
|
682
682
|
* @memberof FbaInboundApiGetShipmentItems
|
|
683
683
|
*/
|
|
684
|
-
readonly queryType:
|
|
684
|
+
readonly queryType: GetShipmentItemsQueryTypeEnum;
|
|
685
685
|
/**
|
|
686
686
|
* A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
687
687
|
* @type {string}
|
|
@@ -737,7 +737,7 @@ export interface FbaInboundApiGetShipmentsRequest {
|
|
|
737
737
|
* @type {'SHIPMENT' | 'DATE_RANGE' | 'NEXT_TOKEN'}
|
|
738
738
|
* @memberof FbaInboundApiGetShipments
|
|
739
739
|
*/
|
|
740
|
-
readonly queryType:
|
|
740
|
+
readonly queryType: GetShipmentsQueryTypeEnum;
|
|
741
741
|
/**
|
|
742
742
|
* A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
743
743
|
* @type {string}
|
|
@@ -749,7 +749,7 @@ export interface FbaInboundApiGetShipmentsRequest {
|
|
|
749
749
|
* @type {Array<'WORKING' | 'READY_TO_SHIP' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'>}
|
|
750
750
|
* @memberof FbaInboundApiGetShipments
|
|
751
751
|
*/
|
|
752
|
-
readonly shipmentStatusList?: Array<
|
|
752
|
+
readonly shipmentStatusList?: Array<GetShipmentsShipmentStatusListEnum>;
|
|
753
753
|
/**
|
|
754
754
|
* A list of shipment IDs used to select the shipments that you want. If both ShipmentStatusList and ShipmentIdList are specified, only shipments that match both parameters are returned.
|
|
755
755
|
* @type {Array<string>}
|
|
@@ -854,7 +854,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
854
854
|
* @throws {RequiredError}
|
|
855
855
|
* @memberof FbaInboundApi
|
|
856
856
|
*/
|
|
857
|
-
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?:
|
|
857
|
+
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmPreorderResponse, any>>;
|
|
858
858
|
/**
|
|
859
859
|
* Confirms that the seller accepts the Amazon-partnered shipping estimate, agrees to allow Amazon to charge their account for the shipping cost, and requests that the Amazon-partnered carrier ship the inbound shipment. Prior to calling the confirmTransport operation, you should call the getTransportDetails operation to get the Amazon-partnered shipping estimate. Important: After confirming the transportation request, if the seller decides that they do not want the Amazon-partnered carrier to ship the inbound shipment, you can call the voidTransport operation to cancel the transportation request. Note that for a Small Parcel shipment, the seller has 24 hours after confirming a transportation request to void the transportation request. For a Less Than Truckload/Full Truckload (LTL/FTL) shipment, the seller has one hour after confirming a transportation request to void it. After the grace period has expired the seller\'s account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
860
860
|
* @param {FbaInboundApiConfirmTransportRequest} requestParameters Request parameters.
|
|
@@ -863,7 +863,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
863
863
|
* @throws {RequiredError}
|
|
864
864
|
* @memberof FbaInboundApi
|
|
865
865
|
*/
|
|
866
|
-
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?:
|
|
866
|
+
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ConfirmTransportResponse, any>>;
|
|
867
867
|
/**
|
|
868
868
|
* Returns a new inbound shipment based on the specified shipmentId that was returned by the createInboundShipmentPlan operation. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
869
869
|
* @param {FbaInboundApiCreateInboundShipmentRequest} requestParameters Request parameters.
|
|
@@ -872,7 +872,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
872
872
|
* @throws {RequiredError}
|
|
873
873
|
* @memberof FbaInboundApi
|
|
874
874
|
*/
|
|
875
|
-
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?:
|
|
875
|
+
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundShipmentResponse, any>>;
|
|
876
876
|
/**
|
|
877
877
|
* Returns one or more inbound shipment plans, which provide the information you need to create one or more inbound shipments for a set of items that you specify. Multiple inbound shipment plans might be required so that items can be optimally placed in Amazon\'s fulfillment network—for example, positioning inventory closer to the customer. Alternatively, two inbound shipment plans might be created with the same Amazon fulfillment center destination if the two shipment plans require different processing—for example, items that require labels must be shipped separately from stickerless, commingled inventory. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
878
878
|
* @param {FbaInboundApiCreateInboundShipmentPlanRequest} requestParameters Request parameters.
|
|
@@ -881,7 +881,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
881
881
|
* @throws {RequiredError}
|
|
882
882
|
* @memberof FbaInboundApi
|
|
883
883
|
*/
|
|
884
|
-
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?:
|
|
884
|
+
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<CreateInboundShipmentPlanResponse, any>>;
|
|
885
885
|
/**
|
|
886
886
|
* Initiates the process of estimating the shipping cost for an inbound shipment by an Amazon-partnered carrier. Prior to calling the estimateTransport operation, you must call the putTransportDetails operation to provide Amazon with the transportation information for the inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
887
887
|
* @param {FbaInboundApiEstimateTransportRequest} requestParameters Request parameters.
|
|
@@ -890,7 +890,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
890
890
|
* @throws {RequiredError}
|
|
891
891
|
* @memberof FbaInboundApi
|
|
892
892
|
*/
|
|
893
|
-
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?:
|
|
893
|
+
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<EstimateTransportResponse, any>>;
|
|
894
894
|
/**
|
|
895
895
|
* Returns a bill of lading for a Less Than Truckload/Full Truckload (LTL/FTL) shipment. The getBillOfLading operation returns PDF document data for printing a bill of lading for an Amazon-partnered Less Than Truckload/Full Truckload (LTL/FTL) inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
896
896
|
* @param {FbaInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
@@ -898,7 +898,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
898
898
|
* @throws {RequiredError}
|
|
899
899
|
* @memberof FbaInboundApi
|
|
900
900
|
*/
|
|
901
|
-
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?:
|
|
901
|
+
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetBillOfLadingResponse, any>>;
|
|
902
902
|
/**
|
|
903
903
|
* Returns package/pallet labels for faster and more accurate shipment processing at the Amazon fulfillment center. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
904
904
|
* @param {FbaInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
@@ -906,7 +906,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
906
906
|
* @throws {RequiredError}
|
|
907
907
|
* @memberof FbaInboundApi
|
|
908
908
|
*/
|
|
909
|
-
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?:
|
|
909
|
+
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetLabelsResponse, any>>;
|
|
910
910
|
/**
|
|
911
911
|
* Returns pre-order information, including dates, that a seller needs before confirming a shipment for pre-order. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
912
912
|
* @param {FbaInboundApiGetPreorderInfoRequest} requestParameters Request parameters.
|
|
@@ -915,7 +915,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
915
915
|
* @throws {RequiredError}
|
|
916
916
|
* @memberof FbaInboundApi
|
|
917
917
|
*/
|
|
918
|
-
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?:
|
|
918
|
+
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPreorderInfoResponse, any>>;
|
|
919
919
|
/**
|
|
920
920
|
* Returns labeling requirements and item preparation instructions to help prepare items for shipment to Amazon\'s fulfillment network. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
921
921
|
* @param {FbaInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
@@ -923,7 +923,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
923
923
|
* @throws {RequiredError}
|
|
924
924
|
* @memberof FbaInboundApi
|
|
925
925
|
*/
|
|
926
|
-
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?:
|
|
926
|
+
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetPrepInstructionsResponse, any>>;
|
|
927
927
|
/**
|
|
928
928
|
* Returns a list of items in a specified inbound shipment, or a list of items that were updated within a specified time frame. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
929
929
|
* @param {FbaInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
@@ -932,7 +932,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
932
932
|
* @throws {RequiredError}
|
|
933
933
|
* @memberof FbaInboundApi
|
|
934
934
|
*/
|
|
935
|
-
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?:
|
|
935
|
+
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentItemsResponse, any>>;
|
|
936
936
|
/**
|
|
937
937
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
938
938
|
* @param {FbaInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
@@ -941,7 +941,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
941
941
|
* @throws {RequiredError}
|
|
942
942
|
* @memberof FbaInboundApi
|
|
943
943
|
*/
|
|
944
|
-
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?:
|
|
944
|
+
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentItemsResponse, any>>;
|
|
945
945
|
/**
|
|
946
946
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
947
947
|
* @param {FbaInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
@@ -950,7 +950,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
950
950
|
* @throws {RequiredError}
|
|
951
951
|
* @memberof FbaInboundApi
|
|
952
952
|
*/
|
|
953
|
-
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?:
|
|
953
|
+
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetShipmentsResponse, any>>;
|
|
954
954
|
/**
|
|
955
955
|
* Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
956
956
|
* @param {FbaInboundApiGetTransportDetailsRequest} requestParameters Request parameters.
|
|
@@ -959,7 +959,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
959
959
|
* @throws {RequiredError}
|
|
960
960
|
* @memberof FbaInboundApi
|
|
961
961
|
*/
|
|
962
|
-
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?:
|
|
962
|
+
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetTransportDetailsResponse, any>>;
|
|
963
963
|
/**
|
|
964
964
|
* Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
965
965
|
* @param {FbaInboundApiPutTransportDetailsRequest} requestParameters Request parameters.
|
|
@@ -968,7 +968,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
968
968
|
* @throws {RequiredError}
|
|
969
969
|
* @memberof FbaInboundApi
|
|
970
970
|
*/
|
|
971
|
-
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?:
|
|
971
|
+
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PutTransportDetailsResponse, any>>;
|
|
972
972
|
/**
|
|
973
973
|
* Updates or removes items from the inbound shipment identified by the specified shipment identifier. Adding new items is not supported. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
974
974
|
* @param {FbaInboundApiUpdateInboundShipmentRequest} requestParameters Request parameters.
|
|
@@ -977,7 +977,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
977
977
|
* @throws {RequiredError}
|
|
978
978
|
* @memberof FbaInboundApi
|
|
979
979
|
*/
|
|
980
|
-
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?:
|
|
980
|
+
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<InboundShipmentResponse, any>>;
|
|
981
981
|
/**
|
|
982
982
|
* Cancels a previously-confirmed request to ship an inbound shipment using an Amazon-partnered carrier. To be successful, you must call this operation before the VoidDeadline date that is returned by the getTransportDetails operation. Important: The VoidDeadline date is 24 hours after you confirm a Small Parcel shipment transportation request or one hour after you confirm a Less Than Truckload/Full Truckload (LTL/FTL) shipment transportation request. After the void deadline passes, your account will be charged for the shipping 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, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
983
983
|
* @param {FbaInboundApiVoidTransportRequest} requestParameters Request parameters.
|
|
@@ -986,5 +986,66 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
986
986
|
* @throws {RequiredError}
|
|
987
987
|
* @memberof FbaInboundApi
|
|
988
988
|
*/
|
|
989
|
-
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?:
|
|
989
|
+
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<VoidTransportResponse, any>>;
|
|
990
990
|
}
|
|
991
|
+
/**
|
|
992
|
+
* @export
|
|
993
|
+
*/
|
|
994
|
+
export declare const GetLabelsPageTypeEnum: {
|
|
995
|
+
readonly Letter2: "PackageLabel_Letter_2";
|
|
996
|
+
readonly Letter4: "PackageLabel_Letter_4";
|
|
997
|
+
readonly Letter6: "PackageLabel_Letter_6";
|
|
998
|
+
readonly Letter6CarrierLeft: "PackageLabel_Letter_6_CarrierLeft";
|
|
999
|
+
readonly A42: "PackageLabel_A4_2";
|
|
1000
|
+
readonly A44: "PackageLabel_A4_4";
|
|
1001
|
+
readonly PlainPaper: "PackageLabel_Plain_Paper";
|
|
1002
|
+
readonly PlainPaperCarrierBottom: "PackageLabel_Plain_Paper_CarrierBottom";
|
|
1003
|
+
readonly Thermal: "PackageLabel_Thermal";
|
|
1004
|
+
readonly ThermalUnified: "PackageLabel_Thermal_Unified";
|
|
1005
|
+
readonly ThermalNonPcp: "PackageLabel_Thermal_NonPCP";
|
|
1006
|
+
readonly ThermalNoCarrierRotation: "PackageLabel_Thermal_No_Carrier_Rotation";
|
|
1007
|
+
};
|
|
1008
|
+
export type GetLabelsPageTypeEnum = typeof GetLabelsPageTypeEnum[keyof typeof GetLabelsPageTypeEnum];
|
|
1009
|
+
/**
|
|
1010
|
+
* @export
|
|
1011
|
+
*/
|
|
1012
|
+
export declare const GetLabelsLabelTypeEnum: {
|
|
1013
|
+
readonly Barcode2D: "BARCODE_2D";
|
|
1014
|
+
readonly Unique: "UNIQUE";
|
|
1015
|
+
readonly Pallet: "PALLET";
|
|
1016
|
+
};
|
|
1017
|
+
export type GetLabelsLabelTypeEnum = typeof GetLabelsLabelTypeEnum[keyof typeof GetLabelsLabelTypeEnum];
|
|
1018
|
+
/**
|
|
1019
|
+
* @export
|
|
1020
|
+
*/
|
|
1021
|
+
export declare const GetShipmentItemsQueryTypeEnum: {
|
|
1022
|
+
readonly DateRange: "DATE_RANGE";
|
|
1023
|
+
readonly NextToken: "NEXT_TOKEN";
|
|
1024
|
+
};
|
|
1025
|
+
export type GetShipmentItemsQueryTypeEnum = typeof GetShipmentItemsQueryTypeEnum[keyof typeof GetShipmentItemsQueryTypeEnum];
|
|
1026
|
+
/**
|
|
1027
|
+
* @export
|
|
1028
|
+
*/
|
|
1029
|
+
export declare const GetShipmentsQueryTypeEnum: {
|
|
1030
|
+
readonly Shipment: "SHIPMENT";
|
|
1031
|
+
readonly DateRange: "DATE_RANGE";
|
|
1032
|
+
readonly NextToken: "NEXT_TOKEN";
|
|
1033
|
+
};
|
|
1034
|
+
export type GetShipmentsQueryTypeEnum = typeof GetShipmentsQueryTypeEnum[keyof typeof GetShipmentsQueryTypeEnum];
|
|
1035
|
+
/**
|
|
1036
|
+
* @export
|
|
1037
|
+
*/
|
|
1038
|
+
export declare const GetShipmentsShipmentStatusListEnum: {
|
|
1039
|
+
readonly Working: "WORKING";
|
|
1040
|
+
readonly ReadyToShip: "READY_TO_SHIP";
|
|
1041
|
+
readonly Shipped: "SHIPPED";
|
|
1042
|
+
readonly Receiving: "RECEIVING";
|
|
1043
|
+
readonly Cancelled: "CANCELLED";
|
|
1044
|
+
readonly Deleted: "DELETED";
|
|
1045
|
+
readonly Closed: "CLOSED";
|
|
1046
|
+
readonly Error: "ERROR";
|
|
1047
|
+
readonly InTransit: "IN_TRANSIT";
|
|
1048
|
+
readonly Delivered: "DELIVERED";
|
|
1049
|
+
readonly CheckedIn: "CHECKED_IN";
|
|
1050
|
+
};
|
|
1051
|
+
export type GetShipmentsShipmentStatusListEnum = typeof GetShipmentsShipmentStatusListEnum[keyof typeof GetShipmentsShipmentStatusListEnum];
|