@sp-api-sdk/fulfillment-inbound-api-v0 1.6.18 → 1.6.22
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/README.md
CHANGED
|
@@ -2,6 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.
|
|
4
4
|
|
|
5
|
+
[](https://www.npmjs.com/package/@sp-api-sdk/fulfillment-inbound-api-v0)
|
|
6
|
+
[](https://github.com/xojs/xo)
|
|
7
|
+
|
|
8
|
+
## Documentation
|
|
9
|
+
|
|
10
|
+
Learn more about this Selling Partner API by visiting the [official documentation](https://github.com/amzn/selling-partner-api-docs/tree/main/references/fulfillment-inbound-api/fulfillmentInboundV0.md).
|
|
11
|
+
|
|
12
|
+
Also, see the [generated documentation](https://bizon.github.io/selling-partner-api-sdk/modules/_sp_api_sdk_fulfillment_inbound_api_v0.html) for this API client.
|
|
13
|
+
|
|
5
14
|
## Installing
|
|
6
15
|
|
|
7
16
|
```sh
|
|
@@ -19,26 +28,25 @@ import {SellingPartnerApiAuth} from '@sp-api-sdk/auth'
|
|
|
19
28
|
import {FulfillmentInboundApiClient} from '@sp-api-sdk/fulfillment-inbound-api-v0'
|
|
20
29
|
|
|
21
30
|
const auth = new SellingPartnerApiAuth({
|
|
22
|
-
clientId:
|
|
23
|
-
clientSecret:
|
|
24
|
-
refreshToken: '',
|
|
25
|
-
secretAccessKey: '',
|
|
31
|
+
clientId: process.env.LWA_CLIENT_ID,
|
|
32
|
+
clientSecret: process.env.LWA_CLIENT_SECRET,
|
|
33
|
+
refreshToken: 'Atzr|…',
|
|
26
34
|
accessKeyId: '',
|
|
27
|
-
|
|
35
|
+
secretAccessKey: '',
|
|
28
36
|
role: {
|
|
29
|
-
arn: '',
|
|
30
|
-
}
|
|
37
|
+
arn: 'arn:aws:iam::…',
|
|
38
|
+
},
|
|
31
39
|
})
|
|
32
40
|
|
|
33
41
|
const client = new FulfillmentInboundApiClient({
|
|
34
42
|
auth,
|
|
35
|
-
region: 'eu'
|
|
43
|
+
region: 'eu',
|
|
36
44
|
})
|
|
37
45
|
```
|
|
38
46
|
|
|
39
|
-
##
|
|
47
|
+
## Rate Limiting
|
|
40
48
|
|
|
41
|
-
|
|
49
|
+
In order to retry rate limited requests (HTTP 429), you can configure the API client as such:
|
|
42
50
|
|
|
43
51
|
```javascript
|
|
44
52
|
const client = new FulfillmentInboundApiClient({
|
|
@@ -46,13 +54,28 @@ const client = new FulfillmentInboundApiClient({
|
|
|
46
54
|
region: 'eu',
|
|
47
55
|
rateLimiting: {
|
|
48
56
|
retry: true,
|
|
49
|
-
|
|
50
|
-
|
|
57
|
+
// Optionally specify a callback that will be called on every retry.
|
|
58
|
+
onRetry: (retryInfo) => {
|
|
59
|
+
console.log(retryInfo)
|
|
60
|
+
},
|
|
61
|
+
},
|
|
51
62
|
})
|
|
52
63
|
```
|
|
53
64
|
|
|
54
|
-
The
|
|
65
|
+
The rate limits used for each route are specified in the [API documentation]((https://github.com/amzn/selling-partner-api-docs/tree/main/references/fulfillment-inbound-api/fulfillmentInboundV0.md)).
|
|
66
|
+
|
|
67
|
+
## License
|
|
68
|
+
|
|
69
|
+
MIT
|
|
55
70
|
|
|
56
|
-
##
|
|
71
|
+
## Miscellaneous
|
|
57
72
|
|
|
58
|
-
|
|
73
|
+
```
|
|
74
|
+
╚⊙ ⊙╝
|
|
75
|
+
╚═(███)═╝
|
|
76
|
+
╚═(███)═╝
|
|
77
|
+
╚═(███)═╝
|
|
78
|
+
╚═(███)═╝
|
|
79
|
+
╚═(███)═╝
|
|
80
|
+
╚═(███)═╝
|
|
81
|
+
```
|
package/dist/cjs/src/client.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.FulfillmentInboundApiClient = exports.
|
|
3
|
+
exports.FulfillmentInboundApiClient = exports.clientRateLimits = void 0;
|
|
4
4
|
/* eslint-disable prefer-regex-literals */
|
|
5
5
|
const common_1 = require("@sp-api-sdk/common");
|
|
6
6
|
const api_model_1 = require("./api-model");
|
|
7
7
|
const error_1 = require("./error");
|
|
8
|
-
exports.
|
|
8
|
+
exports.clientRateLimits = [
|
|
9
9
|
{
|
|
10
10
|
method: 'get',
|
|
11
11
|
urlRegex: new RegExp('^/fba/inbound/v0/itemsGuidance$'),
|
|
@@ -111,20 +111,23 @@ exports.RATE_LIMITS = [
|
|
|
111
111
|
];
|
|
112
112
|
class FulfillmentInboundApiClient extends api_model_1.FbaInboundApi {
|
|
113
113
|
constructor(parameters) {
|
|
114
|
-
const
|
|
114
|
+
const config = common_1.sellingPartnerRegions[parameters.region];
|
|
115
|
+
if (!config) {
|
|
116
|
+
throw new error_1.FulfillmentInboundApiError(`Unknown region: ${parameters.region}`);
|
|
117
|
+
}
|
|
115
118
|
const { rateLimiting, ...clientParameters } = parameters;
|
|
116
|
-
const axiosParameters = {
|
|
119
|
+
const axiosParameters = {
|
|
120
|
+
...clientParameters,
|
|
121
|
+
region: config.awsRegion,
|
|
122
|
+
};
|
|
117
123
|
if (rateLimiting?.retry) {
|
|
118
|
-
axiosParameters.rateLimits = exports.
|
|
124
|
+
axiosParameters.rateLimits = exports.clientRateLimits;
|
|
119
125
|
axiosParameters.onRetry = rateLimiting.onRetry;
|
|
120
126
|
}
|
|
121
127
|
const axiosInstance = (0, common_1.createAxiosInstance)(axiosParameters);
|
|
122
128
|
const configuration = new api_model_1.Configuration();
|
|
123
129
|
const environment = parameters.sandbox ? 'sandbox' : 'production';
|
|
124
|
-
const endpoint =
|
|
125
|
-
if (!endpoint) {
|
|
126
|
-
throw new error_1.FulfillmentInboundApiError(`Unknown region : ${region}`);
|
|
127
|
-
}
|
|
130
|
+
const endpoint = config.endpoints[environment];
|
|
128
131
|
super(configuration, endpoint, axiosInstance);
|
|
129
132
|
}
|
|
130
133
|
}
|
package/dist/es/src/client.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/* eslint-disable prefer-regex-literals */
|
|
2
|
-
import {
|
|
2
|
+
import { sellingPartnerRegions, createAxiosInstance } from '@sp-api-sdk/common';
|
|
3
3
|
import { Configuration, FbaInboundApi } from './api-model';
|
|
4
4
|
import { FulfillmentInboundApiError } from './error';
|
|
5
|
-
export const
|
|
5
|
+
export const clientRateLimits = [
|
|
6
6
|
{
|
|
7
7
|
method: 'get',
|
|
8
8
|
urlRegex: new RegExp('^/fba/inbound/v0/itemsGuidance$'),
|
|
@@ -108,20 +108,23 @@ export const RATE_LIMITS = [
|
|
|
108
108
|
];
|
|
109
109
|
export class FulfillmentInboundApiClient extends FbaInboundApi {
|
|
110
110
|
constructor(parameters) {
|
|
111
|
-
const
|
|
111
|
+
const config = sellingPartnerRegions[parameters.region];
|
|
112
|
+
if (!config) {
|
|
113
|
+
throw new FulfillmentInboundApiError(`Unknown region: ${parameters.region}`);
|
|
114
|
+
}
|
|
112
115
|
const { rateLimiting, ...clientParameters } = parameters;
|
|
113
|
-
const axiosParameters = {
|
|
116
|
+
const axiosParameters = {
|
|
117
|
+
...clientParameters,
|
|
118
|
+
region: config.awsRegion,
|
|
119
|
+
};
|
|
114
120
|
if (rateLimiting?.retry) {
|
|
115
|
-
axiosParameters.rateLimits =
|
|
121
|
+
axiosParameters.rateLimits = clientRateLimits;
|
|
116
122
|
axiosParameters.onRetry = rateLimiting.onRetry;
|
|
117
123
|
}
|
|
118
124
|
const axiosInstance = createAxiosInstance(axiosParameters);
|
|
119
125
|
const configuration = new Configuration();
|
|
120
126
|
const environment = parameters.sandbox ? 'sandbox' : 'production';
|
|
121
|
-
const endpoint = endpoints[environment]
|
|
122
|
-
if (!endpoint) {
|
|
123
|
-
throw new FulfillmentInboundApiError(`Unknown region : ${region}`);
|
|
124
|
-
}
|
|
127
|
+
const endpoint = config.endpoints[environment];
|
|
125
128
|
super(configuration, endpoint, axiosInstance);
|
|
126
129
|
}
|
|
127
130
|
}
|
|
@@ -892,7 +892,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
892
892
|
* @throws {RequiredError}
|
|
893
893
|
* @memberof FbaInboundApi
|
|
894
894
|
*/
|
|
895
|
-
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?: any): Promise<import("axios").AxiosResponse<ConfirmPreorderResponse>>;
|
|
895
|
+
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?: any): Promise<import("axios").AxiosResponse<ConfirmPreorderResponse, any>>;
|
|
896
896
|
/**
|
|
897
897
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
898
898
|
* @param {FbaInboundApiConfirmTransportRequest} requestParameters Request parameters.
|
|
@@ -900,7 +900,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
900
900
|
* @throws {RequiredError}
|
|
901
901
|
* @memberof FbaInboundApi
|
|
902
902
|
*/
|
|
903
|
-
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?: any): Promise<import("axios").AxiosResponse<ConfirmTransportResponse>>;
|
|
903
|
+
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?: any): Promise<import("axios").AxiosResponse<ConfirmTransportResponse, any>>;
|
|
904
904
|
/**
|
|
905
905
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
906
906
|
* @param {FbaInboundApiCreateInboundShipmentRequest} requestParameters Request parameters.
|
|
@@ -908,7 +908,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
908
908
|
* @throws {RequiredError}
|
|
909
909
|
* @memberof FbaInboundApi
|
|
910
910
|
*/
|
|
911
|
-
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<InboundShipmentResponse>>;
|
|
911
|
+
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<InboundShipmentResponse, any>>;
|
|
912
912
|
/**
|
|
913
913
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
914
914
|
* @param {FbaInboundApiCreateInboundShipmentPlanRequest} requestParameters Request parameters.
|
|
@@ -916,7 +916,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
916
916
|
* @throws {RequiredError}
|
|
917
917
|
* @memberof FbaInboundApi
|
|
918
918
|
*/
|
|
919
|
-
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?: any): Promise<import("axios").AxiosResponse<CreateInboundShipmentPlanResponse>>;
|
|
919
|
+
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?: any): Promise<import("axios").AxiosResponse<CreateInboundShipmentPlanResponse, any>>;
|
|
920
920
|
/**
|
|
921
921
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
922
922
|
* @param {FbaInboundApiEstimateTransportRequest} requestParameters Request parameters.
|
|
@@ -924,7 +924,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
924
924
|
* @throws {RequiredError}
|
|
925
925
|
* @memberof FbaInboundApi
|
|
926
926
|
*/
|
|
927
|
-
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?: any): Promise<import("axios").AxiosResponse<EstimateTransportResponse>>;
|
|
927
|
+
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?: any): Promise<import("axios").AxiosResponse<EstimateTransportResponse, any>>;
|
|
928
928
|
/**
|
|
929
929
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
930
930
|
* @param {FbaInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
@@ -932,7 +932,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
932
932
|
* @throws {RequiredError}
|
|
933
933
|
* @memberof FbaInboundApi
|
|
934
934
|
*/
|
|
935
|
-
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?: any): Promise<import("axios").AxiosResponse<GetBillOfLadingResponse>>;
|
|
935
|
+
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?: any): Promise<import("axios").AxiosResponse<GetBillOfLadingResponse, any>>;
|
|
936
936
|
/**
|
|
937
937
|
* Returns information that lets a seller know if Amazon recommends sending an item to a given marketplace. In some cases, Amazon provides guidance for why a given SellerSKU or ASIN is not recommended for shipment to Amazon\'s fulfillment network. Sellers may still ship items that are not recommended, at their discretion. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
938
938
|
* @param {FbaInboundApiGetInboundGuidanceRequest} requestParameters Request parameters.
|
|
@@ -940,7 +940,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
940
940
|
* @throws {RequiredError}
|
|
941
941
|
* @memberof FbaInboundApi
|
|
942
942
|
*/
|
|
943
|
-
getInboundGuidance(requestParameters: FbaInboundApiGetInboundGuidanceRequest, options?: any): Promise<import("axios").AxiosResponse<GetInboundGuidanceResponse>>;
|
|
943
|
+
getInboundGuidance(requestParameters: FbaInboundApiGetInboundGuidanceRequest, options?: any): Promise<import("axios").AxiosResponse<GetInboundGuidanceResponse, any>>;
|
|
944
944
|
/**
|
|
945
945
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
946
946
|
* @param {FbaInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
@@ -948,7 +948,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
948
948
|
* @throws {RequiredError}
|
|
949
949
|
* @memberof FbaInboundApi
|
|
950
950
|
*/
|
|
951
|
-
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<GetLabelsResponse>>;
|
|
951
|
+
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?: any): Promise<import("axios").AxiosResponse<GetLabelsResponse, any>>;
|
|
952
952
|
/**
|
|
953
953
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
954
954
|
* @param {FbaInboundApiGetPreorderInfoRequest} requestParameters Request parameters.
|
|
@@ -956,7 +956,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
956
956
|
* @throws {RequiredError}
|
|
957
957
|
* @memberof FbaInboundApi
|
|
958
958
|
*/
|
|
959
|
-
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetPreorderInfoResponse>>;
|
|
959
|
+
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?: any): Promise<import("axios").AxiosResponse<GetPreorderInfoResponse, any>>;
|
|
960
960
|
/**
|
|
961
961
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
962
962
|
* @param {FbaInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
@@ -964,7 +964,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
964
964
|
* @throws {RequiredError}
|
|
965
965
|
* @memberof FbaInboundApi
|
|
966
966
|
*/
|
|
967
|
-
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPrepInstructionsResponse>>;
|
|
967
|
+
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?: any): Promise<import("axios").AxiosResponse<GetPrepInstructionsResponse, any>>;
|
|
968
968
|
/**
|
|
969
969
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
970
970
|
* @param {FbaInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
@@ -972,7 +972,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
972
972
|
* @throws {RequiredError}
|
|
973
973
|
* @memberof FbaInboundApi
|
|
974
974
|
*/
|
|
975
|
-
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentItemsResponse>>;
|
|
975
|
+
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentItemsResponse, any>>;
|
|
976
976
|
/**
|
|
977
977
|
* Returns a list of items in a specified inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
978
978
|
* @param {FbaInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
@@ -980,7 +980,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
980
980
|
* @throws {RequiredError}
|
|
981
981
|
* @memberof FbaInboundApi
|
|
982
982
|
*/
|
|
983
|
-
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentItemsResponse>>;
|
|
983
|
+
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentItemsResponse, any>>;
|
|
984
984
|
/**
|
|
985
985
|
* Returns a list of inbound shipments based on criteria that you specify. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
986
986
|
* @param {FbaInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
@@ -988,7 +988,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
988
988
|
* @throws {RequiredError}
|
|
989
989
|
* @memberof FbaInboundApi
|
|
990
990
|
*/
|
|
991
|
-
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentsResponse>>;
|
|
991
|
+
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?: any): Promise<import("axios").AxiosResponse<GetShipmentsResponse, any>>;
|
|
992
992
|
/**
|
|
993
993
|
* Returns current transportation information about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
994
994
|
* @param {FbaInboundApiGetTransportDetailsRequest} requestParameters Request parameters.
|
|
@@ -996,7 +996,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
996
996
|
* @throws {RequiredError}
|
|
997
997
|
* @memberof FbaInboundApi
|
|
998
998
|
*/
|
|
999
|
-
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<GetTransportDetailsResponse>>;
|
|
999
|
+
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<GetTransportDetailsResponse, any>>;
|
|
1000
1000
|
/**
|
|
1001
1001
|
* Sends transportation information to Amazon about an inbound shipment. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 2 | 30 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
1002
1002
|
* @param {FbaInboundApiPutTransportDetailsRequest} requestParameters Request parameters.
|
|
@@ -1004,7 +1004,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
1004
1004
|
* @throws {RequiredError}
|
|
1005
1005
|
* @memberof FbaInboundApi
|
|
1006
1006
|
*/
|
|
1007
|
-
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<PutTransportDetailsResponse>>;
|
|
1007
|
+
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?: any): Promise<import("axios").AxiosResponse<PutTransportDetailsResponse, any>>;
|
|
1008
1008
|
/**
|
|
1009
1009
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
1010
1010
|
* @param {FbaInboundApiUpdateInboundShipmentRequest} requestParameters Request parameters.
|
|
@@ -1012,7 +1012,7 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
1012
1012
|
* @throws {RequiredError}
|
|
1013
1013
|
* @memberof FbaInboundApi
|
|
1014
1014
|
*/
|
|
1015
|
-
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<InboundShipmentResponse>>;
|
|
1015
|
+
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?: any): Promise<import("axios").AxiosResponse<InboundShipmentResponse, any>>;
|
|
1016
1016
|
/**
|
|
1017
1017
|
* 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 | For more information, see \"Usage Plans and Rate Limits\" in the Selling Partner API documentation.
|
|
1018
1018
|
* @param {FbaInboundApiVoidTransportRequest} requestParameters Request parameters.
|
|
@@ -1020,5 +1020,5 @@ export declare class FbaInboundApi extends BaseAPI {
|
|
|
1020
1020
|
* @throws {RequiredError}
|
|
1021
1021
|
* @memberof FbaInboundApi
|
|
1022
1022
|
*/
|
|
1023
|
-
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?: any): Promise<import("axios").AxiosResponse<VoidTransportResponse>>;
|
|
1023
|
+
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?: any): Promise<import("axios").AxiosResponse<VoidTransportResponse, any>>;
|
|
1024
1024
|
}
|
|
@@ -62,4 +62,4 @@ export declare const toPathString: (url: URL) => string;
|
|
|
62
62
|
*
|
|
63
63
|
* @export
|
|
64
64
|
*/
|
|
65
|
-
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any>>;
|
|
65
|
+
export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration | undefined) => (axios?: AxiosInstance, basePath?: string) => Promise<import("axios").AxiosResponse<any, any>>;
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import type { ClientConfiguration, RateLimit } from '@sp-api-sdk/common';
|
|
1
|
+
import type { ClientConfiguration, SellingPartnerRegion, RateLimit, OnRetryHandler } from '@sp-api-sdk/common';
|
|
3
2
|
import { FbaInboundApi } from './api-model';
|
|
4
|
-
export declare const
|
|
3
|
+
export declare const clientRateLimits: RateLimit[];
|
|
5
4
|
export interface ClientParameters extends Omit<ClientConfiguration, 'rateLimits' | 'onRetry'> {
|
|
5
|
+
region: SellingPartnerRegion;
|
|
6
6
|
rateLimiting?: {
|
|
7
7
|
retry: boolean;
|
|
8
|
-
onRetry?:
|
|
8
|
+
onRetry?: OnRetryHandler;
|
|
9
9
|
};
|
|
10
10
|
}
|
|
11
11
|
export declare class FulfillmentInboundApiClient extends FbaInboundApi {
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@sp-api-sdk/fulfillment-inbound-api-v0",
|
|
3
3
|
"author": "Vincent Mesquita <vincent.mesquita@bizon.solutions>",
|
|
4
4
|
"description": "The Selling Partner API for Fulfillment Inbound lets you create applications that create and update inbound shipments of inventory to Amazon's fulfillment network.",
|
|
5
|
-
"version": "1.6.
|
|
5
|
+
"version": "1.6.22",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -25,9 +25,9 @@
|
|
|
25
25
|
"test": "NODE_ENV='test' yarn jest"
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
|
-
"@sp-api-sdk/auth": "^1.9.
|
|
29
|
-
"@sp-api-sdk/common": "^1.7.
|
|
30
|
-
"axios": "^0.
|
|
28
|
+
"@sp-api-sdk/auth": "^1.9.6",
|
|
29
|
+
"@sp-api-sdk/common": "^1.7.8",
|
|
30
|
+
"axios": "^0.24.0"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
33
33
|
"type": "git",
|
|
@@ -48,5 +48,5 @@
|
|
|
48
48
|
"sp sdk",
|
|
49
49
|
"fulfillment inbound api"
|
|
50
50
|
],
|
|
51
|
-
"gitHead": "
|
|
51
|
+
"gitHead": "f21b5cb511abd110bf1f07843558719993f36187"
|
|
52
52
|
}
|