@sp-api-sdk/fulfillment-inbound-api-v0 1.10.3 → 1.10.4
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 +51 -79
- package/dist/cjs/src/api-model/base.js +1 -3
- package/dist/cjs/src/api-model/common.js +2 -0
- package/dist/es/src/api-model/api/fba-inbound-api.js +51 -79
- package/dist/es/src/api-model/base.js +1 -3
- package/dist/es/src/api-model/common.js +2 -0
- package/dist/types/src/api-model/api/fba-inbound-api.d.ts +36 -64
- package/dist/types/src/api-model/base.d.ts +2 -3
- package/dist/types/src/api-model/common.d.ts +3 -3
- package/package.json +3 -3
|
@@ -873,184 +873,156 @@ const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
873
873
|
return {
|
|
874
874
|
/**
|
|
875
875
|
* Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the 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.
|
|
876
|
-
* @param {
|
|
877
|
-
* @param {string} needByDate Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.
|
|
878
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace the shipment is tied to.
|
|
876
|
+
* @param {FbaInboundApiConfirmPreorderRequest} requestParameters Request parameters.
|
|
879
877
|
* @param {*} [options] Override http request option.
|
|
880
878
|
* @throws {RequiredError}
|
|
881
879
|
*/
|
|
882
|
-
confirmPreorder(
|
|
883
|
-
return localVarFp.confirmPreorder(shipmentId, needByDate, marketplaceId, options).then((request) => request(axios, basePath));
|
|
880
|
+
confirmPreorder(requestParameters, options) {
|
|
881
|
+
return localVarFp.confirmPreorder(requestParameters.shipmentId, requestParameters.needByDate, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
884
882
|
},
|
|
885
883
|
/**
|
|
886
884
|
* 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.
|
|
887
|
-
* @param {
|
|
885
|
+
* @param {FbaInboundApiConfirmTransportRequest} requestParameters Request parameters.
|
|
888
886
|
* @param {*} [options] Override http request option.
|
|
889
887
|
* @throws {RequiredError}
|
|
890
888
|
*/
|
|
891
|
-
confirmTransport(
|
|
892
|
-
return localVarFp.confirmTransport(shipmentId, options).then((request) => request(axios, basePath));
|
|
889
|
+
confirmTransport(requestParameters, options) {
|
|
890
|
+
return localVarFp.confirmTransport(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
893
891
|
},
|
|
894
892
|
/**
|
|
895
893
|
* 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.
|
|
896
|
-
* @param {
|
|
897
|
-
* @param {InboundShipmentRequest} body
|
|
894
|
+
* @param {FbaInboundApiCreateInboundShipmentRequest} requestParameters Request parameters.
|
|
898
895
|
* @param {*} [options] Override http request option.
|
|
899
896
|
* @throws {RequiredError}
|
|
900
897
|
*/
|
|
901
|
-
createInboundShipment(
|
|
902
|
-
return localVarFp.createInboundShipment(shipmentId, body, options).then((request) => request(axios, basePath));
|
|
898
|
+
createInboundShipment(requestParameters, options) {
|
|
899
|
+
return localVarFp.createInboundShipment(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
903
900
|
},
|
|
904
901
|
/**
|
|
905
902
|
* 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.
|
|
906
|
-
* @param {
|
|
903
|
+
* @param {FbaInboundApiCreateInboundShipmentPlanRequest} requestParameters Request parameters.
|
|
907
904
|
* @param {*} [options] Override http request option.
|
|
908
905
|
* @throws {RequiredError}
|
|
909
906
|
*/
|
|
910
|
-
createInboundShipmentPlan(
|
|
911
|
-
return localVarFp.createInboundShipmentPlan(body, options).then((request) => request(axios, basePath));
|
|
907
|
+
createInboundShipmentPlan(requestParameters, options) {
|
|
908
|
+
return localVarFp.createInboundShipmentPlan(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
912
909
|
},
|
|
913
910
|
/**
|
|
914
911
|
* 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.
|
|
915
|
-
* @param {
|
|
912
|
+
* @param {FbaInboundApiEstimateTransportRequest} requestParameters Request parameters.
|
|
916
913
|
* @param {*} [options] Override http request option.
|
|
917
914
|
* @throws {RequiredError}
|
|
918
915
|
*/
|
|
919
|
-
estimateTransport(
|
|
920
|
-
return localVarFp.estimateTransport(shipmentId, options).then((request) => request(axios, basePath));
|
|
916
|
+
estimateTransport(requestParameters, options) {
|
|
917
|
+
return localVarFp.estimateTransport(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
921
918
|
},
|
|
922
919
|
/**
|
|
923
920
|
* 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.
|
|
924
|
-
* @param {
|
|
921
|
+
* @param {FbaInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
925
922
|
* @param {*} [options] Override http request option.
|
|
926
923
|
* @throws {RequiredError}
|
|
927
924
|
*/
|
|
928
|
-
getBillOfLading(
|
|
929
|
-
return localVarFp.getBillOfLading(shipmentId, options).then((request) => request(axios, basePath));
|
|
925
|
+
getBillOfLading(requestParameters, options) {
|
|
926
|
+
return localVarFp.getBillOfLading(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
930
927
|
},
|
|
931
928
|
/**
|
|
932
929
|
* 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.
|
|
933
|
-
* @param {
|
|
934
|
-
* @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon\'s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
|
|
935
|
-
* @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon\'s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
|
|
930
|
+
* @param {FbaInboundApiGetInboundGuidanceRequest} requestParameters Request parameters.
|
|
936
931
|
* @param {*} [options] Override http request option.
|
|
937
932
|
* @throws {RequiredError}
|
|
938
933
|
*/
|
|
939
|
-
getInboundGuidance(
|
|
940
|
-
return localVarFp.getInboundGuidance(marketplaceId, sellerSKUList, aSINList, options).then((request) => request(axios, basePath));
|
|
934
|
+
getInboundGuidance(requestParameters, options) {
|
|
935
|
+
return localVarFp.getInboundGuidance(requestParameters.marketplaceId, requestParameters.sellerSKUList, requestParameters.aSINList, options).then((request) => request(axios, basePath));
|
|
941
936
|
},
|
|
942
937
|
/**
|
|
943
938
|
* 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.
|
|
944
|
-
* @param {
|
|
945
|
-
* @param {'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'} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
|
|
946
|
-
* @param {'BARCODE_2D' | 'UNIQUE' | 'PALLET'} labelType The type of labels requested.
|
|
947
|
-
* @param {number} [numberOfPackages] The number of packages in the shipment.
|
|
948
|
-
* @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.
|
|
949
|
-
* @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
|
|
950
|
-
* @param {number} [pageSize] The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
|
|
951
|
-
* @param {number} [pageStartIndex] The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments.
|
|
939
|
+
* @param {FbaInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
952
940
|
* @param {*} [options] Override http request option.
|
|
953
941
|
* @throws {RequiredError}
|
|
954
942
|
*/
|
|
955
|
-
getLabels(
|
|
956
|
-
return localVarFp.getLabels(shipmentId, pageType, labelType, numberOfPackages, packageLabelsToPrint, numberOfPallets, pageSize, pageStartIndex, options).then((request) => request(axios, basePath));
|
|
943
|
+
getLabels(requestParameters, options) {
|
|
944
|
+
return localVarFp.getLabels(requestParameters.shipmentId, requestParameters.pageType, requestParameters.labelType, requestParameters.numberOfPackages, requestParameters.packageLabelsToPrint, requestParameters.numberOfPallets, requestParameters.pageSize, requestParameters.pageStartIndex, options).then((request) => request(axios, basePath));
|
|
957
945
|
},
|
|
958
946
|
/**
|
|
959
947
|
* 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.
|
|
960
|
-
* @param {
|
|
961
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace the shipment is tied to.
|
|
948
|
+
* @param {FbaInboundApiGetPreorderInfoRequest} requestParameters Request parameters.
|
|
962
949
|
* @param {*} [options] Override http request option.
|
|
963
950
|
* @throws {RequiredError}
|
|
964
951
|
*/
|
|
965
|
-
getPreorderInfo(
|
|
966
|
-
return localVarFp.getPreorderInfo(shipmentId, marketplaceId, options).then((request) => request(axios, basePath));
|
|
952
|
+
getPreorderInfo(requestParameters, options) {
|
|
953
|
+
return localVarFp.getPreorderInfo(requestParameters.shipmentId, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
967
954
|
},
|
|
968
955
|
/**
|
|
969
956
|
* 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.
|
|
970
|
-
* @param {
|
|
971
|
-
* @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
|
|
972
|
-
* @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
|
|
957
|
+
* @param {FbaInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
973
958
|
* @param {*} [options] Override http request option.
|
|
974
959
|
* @throws {RequiredError}
|
|
975
960
|
*/
|
|
976
|
-
getPrepInstructions(
|
|
977
|
-
return localVarFp.getPrepInstructions(shipToCountryCode, sellerSKUList, aSINList, options).then((request) => request(axios, basePath));
|
|
961
|
+
getPrepInstructions(requestParameters, options) {
|
|
962
|
+
return localVarFp.getPrepInstructions(requestParameters.shipToCountryCode, requestParameters.sellerSKUList, requestParameters.aSINList, options).then((request) => request(axios, basePath));
|
|
978
963
|
},
|
|
979
964
|
/**
|
|
980
965
|
* 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.
|
|
981
|
-
* @param {
|
|
982
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
983
|
-
* @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.
|
|
984
|
-
* @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.
|
|
985
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
966
|
+
* @param {FbaInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
986
967
|
* @param {*} [options] Override http request option.
|
|
987
968
|
* @throws {RequiredError}
|
|
988
969
|
*/
|
|
989
|
-
getShipmentItems(
|
|
990
|
-
return localVarFp.getShipmentItems(queryType, marketplaceId, lastUpdatedAfter, lastUpdatedBefore, nextToken, options).then((request) => request(axios, basePath));
|
|
970
|
+
getShipmentItems(requestParameters, options) {
|
|
971
|
+
return localVarFp.getShipmentItems(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
991
972
|
},
|
|
992
973
|
/**
|
|
993
974
|
* 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.
|
|
994
|
-
* @param {
|
|
995
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
975
|
+
* @param {FbaInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
996
976
|
* @param {*} [options] Override http request option.
|
|
997
977
|
* @throws {RequiredError}
|
|
998
978
|
*/
|
|
999
|
-
getShipmentItemsByShipmentId(
|
|
1000
|
-
return localVarFp.getShipmentItemsByShipmentId(shipmentId, marketplaceId, options).then((request) => request(axios, basePath));
|
|
979
|
+
getShipmentItemsByShipmentId(requestParameters, options) {
|
|
980
|
+
return localVarFp.getShipmentItemsByShipmentId(requestParameters.shipmentId, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
1001
981
|
},
|
|
1002
982
|
/**
|
|
1003
983
|
* 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.
|
|
1004
|
-
* @param {
|
|
1005
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
1006
|
-
* @param {Array<'WORKING' | 'READY_TO_SHIP' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
|
|
1007
|
-
* @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.
|
|
1008
|
-
* @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.
|
|
1009
|
-
* @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.
|
|
1010
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
984
|
+
* @param {FbaInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
1011
985
|
* @param {*} [options] Override http request option.
|
|
1012
986
|
* @throws {RequiredError}
|
|
1013
987
|
*/
|
|
1014
|
-
getShipments(
|
|
1015
|
-
return localVarFp.getShipments(queryType, marketplaceId, shipmentStatusList, shipmentIdList, lastUpdatedAfter, lastUpdatedBefore, nextToken, options).then((request) => request(axios, basePath));
|
|
988
|
+
getShipments(requestParameters, options) {
|
|
989
|
+
return localVarFp.getShipments(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.shipmentStatusList, requestParameters.shipmentIdList, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
1016
990
|
},
|
|
1017
991
|
/**
|
|
1018
992
|
* 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.
|
|
1019
|
-
* @param {
|
|
993
|
+
* @param {FbaInboundApiGetTransportDetailsRequest} requestParameters Request parameters.
|
|
1020
994
|
* @param {*} [options] Override http request option.
|
|
1021
995
|
* @throws {RequiredError}
|
|
1022
996
|
*/
|
|
1023
|
-
getTransportDetails(
|
|
1024
|
-
return localVarFp.getTransportDetails(shipmentId, options).then((request) => request(axios, basePath));
|
|
997
|
+
getTransportDetails(requestParameters, options) {
|
|
998
|
+
return localVarFp.getTransportDetails(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1025
999
|
},
|
|
1026
1000
|
/**
|
|
1027
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.
|
|
1028
|
-
* @param {
|
|
1029
|
-
* @param {PutTransportDetailsRequest} body
|
|
1002
|
+
* @param {FbaInboundApiPutTransportDetailsRequest} requestParameters Request parameters.
|
|
1030
1003
|
* @param {*} [options] Override http request option.
|
|
1031
1004
|
* @throws {RequiredError}
|
|
1032
1005
|
*/
|
|
1033
|
-
putTransportDetails(
|
|
1034
|
-
return localVarFp.putTransportDetails(shipmentId, body, options).then((request) => request(axios, basePath));
|
|
1006
|
+
putTransportDetails(requestParameters, options) {
|
|
1007
|
+
return localVarFp.putTransportDetails(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1035
1008
|
},
|
|
1036
1009
|
/**
|
|
1037
1010
|
* 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.
|
|
1038
|
-
* @param {
|
|
1039
|
-
* @param {InboundShipmentRequest} body
|
|
1011
|
+
* @param {FbaInboundApiUpdateInboundShipmentRequest} requestParameters Request parameters.
|
|
1040
1012
|
* @param {*} [options] Override http request option.
|
|
1041
1013
|
* @throws {RequiredError}
|
|
1042
1014
|
*/
|
|
1043
|
-
updateInboundShipment(
|
|
1044
|
-
return localVarFp.updateInboundShipment(shipmentId, body, options).then((request) => request(axios, basePath));
|
|
1015
|
+
updateInboundShipment(requestParameters, options) {
|
|
1016
|
+
return localVarFp.updateInboundShipment(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1045
1017
|
},
|
|
1046
1018
|
/**
|
|
1047
1019
|
* 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.
|
|
1048
|
-
* @param {
|
|
1020
|
+
* @param {FbaInboundApiVoidTransportRequest} requestParameters Request parameters.
|
|
1049
1021
|
* @param {*} [options] Override http request option.
|
|
1050
1022
|
* @throws {RequiredError}
|
|
1051
1023
|
*/
|
|
1052
|
-
voidTransport(
|
|
1053
|
-
return localVarFp.voidTransport(shipmentId, options).then((request) => request(axios, basePath));
|
|
1024
|
+
voidTransport(requestParameters, options) {
|
|
1025
|
+
return localVarFp.voidTransport(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1054
1026
|
},
|
|
1055
1027
|
};
|
|
1056
1028
|
};
|
|
@@ -15,8 +15,6 @@
|
|
|
15
15
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
16
|
exports.RequiredError = exports.BaseAPI = exports.COLLECTION_FORMATS = exports.BASE_PATH = void 0;
|
|
17
17
|
const tslib_1 = require("tslib");
|
|
18
|
-
// Some imports not used depending on template conditions
|
|
19
|
-
// @ts-ignore
|
|
20
18
|
const axios_1 = tslib_1.__importDefault(require("axios"));
|
|
21
19
|
exports.BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
22
20
|
/**
|
|
@@ -57,10 +55,10 @@ exports.BaseAPI = BaseAPI;
|
|
|
57
55
|
*/
|
|
58
56
|
class RequiredError extends Error {
|
|
59
57
|
field;
|
|
60
|
-
name = "RequiredError";
|
|
61
58
|
constructor(field, msg) {
|
|
62
59
|
super(msg);
|
|
63
60
|
this.field = field;
|
|
61
|
+
this.name = "RequiredError";
|
|
64
62
|
}
|
|
65
63
|
}
|
|
66
64
|
exports.RequiredError = RequiredError;
|
|
@@ -81,6 +81,8 @@ const setOAuthToObject = async function (object, name, scopes, configuration) {
|
|
|
81
81
|
};
|
|
82
82
|
exports.setOAuthToObject = setOAuthToObject;
|
|
83
83
|
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
84
|
+
if (parameter == null)
|
|
85
|
+
return;
|
|
84
86
|
if (typeof parameter === "object") {
|
|
85
87
|
if (Array.isArray(parameter)) {
|
|
86
88
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
|
|
@@ -867,184 +867,156 @@ export const FbaInboundApiFactory = function (configuration, basePath, axios) {
|
|
|
867
867
|
return {
|
|
868
868
|
/**
|
|
869
869
|
* Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the 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.
|
|
870
|
-
* @param {
|
|
871
|
-
* @param {string} needByDate Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.
|
|
872
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace the shipment is tied to.
|
|
870
|
+
* @param {FbaInboundApiConfirmPreorderRequest} requestParameters Request parameters.
|
|
873
871
|
* @param {*} [options] Override http request option.
|
|
874
872
|
* @throws {RequiredError}
|
|
875
873
|
*/
|
|
876
|
-
confirmPreorder(
|
|
877
|
-
return localVarFp.confirmPreorder(shipmentId, needByDate, marketplaceId, options).then((request) => request(axios, basePath));
|
|
874
|
+
confirmPreorder(requestParameters, options) {
|
|
875
|
+
return localVarFp.confirmPreorder(requestParameters.shipmentId, requestParameters.needByDate, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
878
876
|
},
|
|
879
877
|
/**
|
|
880
878
|
* 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.
|
|
881
|
-
* @param {
|
|
879
|
+
* @param {FbaInboundApiConfirmTransportRequest} requestParameters Request parameters.
|
|
882
880
|
* @param {*} [options] Override http request option.
|
|
883
881
|
* @throws {RequiredError}
|
|
884
882
|
*/
|
|
885
|
-
confirmTransport(
|
|
886
|
-
return localVarFp.confirmTransport(shipmentId, options).then((request) => request(axios, basePath));
|
|
883
|
+
confirmTransport(requestParameters, options) {
|
|
884
|
+
return localVarFp.confirmTransport(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
887
885
|
},
|
|
888
886
|
/**
|
|
889
887
|
* 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.
|
|
890
|
-
* @param {
|
|
891
|
-
* @param {InboundShipmentRequest} body
|
|
888
|
+
* @param {FbaInboundApiCreateInboundShipmentRequest} requestParameters Request parameters.
|
|
892
889
|
* @param {*} [options] Override http request option.
|
|
893
890
|
* @throws {RequiredError}
|
|
894
891
|
*/
|
|
895
|
-
createInboundShipment(
|
|
896
|
-
return localVarFp.createInboundShipment(shipmentId, body, options).then((request) => request(axios, basePath));
|
|
892
|
+
createInboundShipment(requestParameters, options) {
|
|
893
|
+
return localVarFp.createInboundShipment(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
897
894
|
},
|
|
898
895
|
/**
|
|
899
896
|
* 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.
|
|
900
|
-
* @param {
|
|
897
|
+
* @param {FbaInboundApiCreateInboundShipmentPlanRequest} requestParameters Request parameters.
|
|
901
898
|
* @param {*} [options] Override http request option.
|
|
902
899
|
* @throws {RequiredError}
|
|
903
900
|
*/
|
|
904
|
-
createInboundShipmentPlan(
|
|
905
|
-
return localVarFp.createInboundShipmentPlan(body, options).then((request) => request(axios, basePath));
|
|
901
|
+
createInboundShipmentPlan(requestParameters, options) {
|
|
902
|
+
return localVarFp.createInboundShipmentPlan(requestParameters.body, options).then((request) => request(axios, basePath));
|
|
906
903
|
},
|
|
907
904
|
/**
|
|
908
905
|
* 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.
|
|
909
|
-
* @param {
|
|
906
|
+
* @param {FbaInboundApiEstimateTransportRequest} requestParameters Request parameters.
|
|
910
907
|
* @param {*} [options] Override http request option.
|
|
911
908
|
* @throws {RequiredError}
|
|
912
909
|
*/
|
|
913
|
-
estimateTransport(
|
|
914
|
-
return localVarFp.estimateTransport(shipmentId, options).then((request) => request(axios, basePath));
|
|
910
|
+
estimateTransport(requestParameters, options) {
|
|
911
|
+
return localVarFp.estimateTransport(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
915
912
|
},
|
|
916
913
|
/**
|
|
917
914
|
* 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.
|
|
918
|
-
* @param {
|
|
915
|
+
* @param {FbaInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
919
916
|
* @param {*} [options] Override http request option.
|
|
920
917
|
* @throws {RequiredError}
|
|
921
918
|
*/
|
|
922
|
-
getBillOfLading(
|
|
923
|
-
return localVarFp.getBillOfLading(shipmentId, options).then((request) => request(axios, basePath));
|
|
919
|
+
getBillOfLading(requestParameters, options) {
|
|
920
|
+
return localVarFp.getBillOfLading(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
924
921
|
},
|
|
925
922
|
/**
|
|
926
923
|
* 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.
|
|
927
|
-
* @param {
|
|
928
|
-
* @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon\'s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
|
|
929
|
-
* @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon\'s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
|
|
924
|
+
* @param {FbaInboundApiGetInboundGuidanceRequest} requestParameters Request parameters.
|
|
930
925
|
* @param {*} [options] Override http request option.
|
|
931
926
|
* @throws {RequiredError}
|
|
932
927
|
*/
|
|
933
|
-
getInboundGuidance(
|
|
934
|
-
return localVarFp.getInboundGuidance(marketplaceId, sellerSKUList, aSINList, options).then((request) => request(axios, basePath));
|
|
928
|
+
getInboundGuidance(requestParameters, options) {
|
|
929
|
+
return localVarFp.getInboundGuidance(requestParameters.marketplaceId, requestParameters.sellerSKUList, requestParameters.aSINList, options).then((request) => request(axios, basePath));
|
|
935
930
|
},
|
|
936
931
|
/**
|
|
937
932
|
* 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.
|
|
938
|
-
* @param {
|
|
939
|
-
* @param {'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'} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
|
|
940
|
-
* @param {'BARCODE_2D' | 'UNIQUE' | 'PALLET'} labelType The type of labels requested.
|
|
941
|
-
* @param {number} [numberOfPackages] The number of packages in the shipment.
|
|
942
|
-
* @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.
|
|
943
|
-
* @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
|
|
944
|
-
* @param {number} [pageSize] The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
|
|
945
|
-
* @param {number} [pageStartIndex] The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments.
|
|
933
|
+
* @param {FbaInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
946
934
|
* @param {*} [options] Override http request option.
|
|
947
935
|
* @throws {RequiredError}
|
|
948
936
|
*/
|
|
949
|
-
getLabels(
|
|
950
|
-
return localVarFp.getLabels(shipmentId, pageType, labelType, numberOfPackages, packageLabelsToPrint, numberOfPallets, pageSize, pageStartIndex, options).then((request) => request(axios, basePath));
|
|
937
|
+
getLabels(requestParameters, options) {
|
|
938
|
+
return localVarFp.getLabels(requestParameters.shipmentId, requestParameters.pageType, requestParameters.labelType, requestParameters.numberOfPackages, requestParameters.packageLabelsToPrint, requestParameters.numberOfPallets, requestParameters.pageSize, requestParameters.pageStartIndex, options).then((request) => request(axios, basePath));
|
|
951
939
|
},
|
|
952
940
|
/**
|
|
953
941
|
* 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
|
-
* @param {
|
|
955
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace the shipment is tied to.
|
|
942
|
+
* @param {FbaInboundApiGetPreorderInfoRequest} requestParameters Request parameters.
|
|
956
943
|
* @param {*} [options] Override http request option.
|
|
957
944
|
* @throws {RequiredError}
|
|
958
945
|
*/
|
|
959
|
-
getPreorderInfo(
|
|
960
|
-
return localVarFp.getPreorderInfo(shipmentId, marketplaceId, options).then((request) => request(axios, basePath));
|
|
946
|
+
getPreorderInfo(requestParameters, options) {
|
|
947
|
+
return localVarFp.getPreorderInfo(requestParameters.shipmentId, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
961
948
|
},
|
|
962
949
|
/**
|
|
963
950
|
* 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.
|
|
964
|
-
* @param {
|
|
965
|
-
* @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
|
|
966
|
-
* @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
|
|
951
|
+
* @param {FbaInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
967
952
|
* @param {*} [options] Override http request option.
|
|
968
953
|
* @throws {RequiredError}
|
|
969
954
|
*/
|
|
970
|
-
getPrepInstructions(
|
|
971
|
-
return localVarFp.getPrepInstructions(shipToCountryCode, sellerSKUList, aSINList, options).then((request) => request(axios, basePath));
|
|
955
|
+
getPrepInstructions(requestParameters, options) {
|
|
956
|
+
return localVarFp.getPrepInstructions(requestParameters.shipToCountryCode, requestParameters.sellerSKUList, requestParameters.aSINList, options).then((request) => request(axios, basePath));
|
|
972
957
|
},
|
|
973
958
|
/**
|
|
974
959
|
* 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.
|
|
975
|
-
* @param {
|
|
976
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
977
|
-
* @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.
|
|
978
|
-
* @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.
|
|
979
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
960
|
+
* @param {FbaInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
980
961
|
* @param {*} [options] Override http request option.
|
|
981
962
|
* @throws {RequiredError}
|
|
982
963
|
*/
|
|
983
|
-
getShipmentItems(
|
|
984
|
-
return localVarFp.getShipmentItems(queryType, marketplaceId, lastUpdatedAfter, lastUpdatedBefore, nextToken, options).then((request) => request(axios, basePath));
|
|
964
|
+
getShipmentItems(requestParameters, options) {
|
|
965
|
+
return localVarFp.getShipmentItems(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
985
966
|
},
|
|
986
967
|
/**
|
|
987
968
|
* 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.
|
|
988
|
-
* @param {
|
|
989
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
969
|
+
* @param {FbaInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
990
970
|
* @param {*} [options] Override http request option.
|
|
991
971
|
* @throws {RequiredError}
|
|
992
972
|
*/
|
|
993
|
-
getShipmentItemsByShipmentId(
|
|
994
|
-
return localVarFp.getShipmentItemsByShipmentId(shipmentId, marketplaceId, options).then((request) => request(axios, basePath));
|
|
973
|
+
getShipmentItemsByShipmentId(requestParameters, options) {
|
|
974
|
+
return localVarFp.getShipmentItemsByShipmentId(requestParameters.shipmentId, requestParameters.marketplaceId, options).then((request) => request(axios, basePath));
|
|
995
975
|
},
|
|
996
976
|
/**
|
|
997
977
|
* 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.
|
|
998
|
-
* @param {
|
|
999
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
1000
|
-
* @param {Array<'WORKING' | 'READY_TO_SHIP' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
|
|
1001
|
-
* @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.
|
|
1002
|
-
* @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.
|
|
1003
|
-
* @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.
|
|
1004
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
978
|
+
* @param {FbaInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
1005
979
|
* @param {*} [options] Override http request option.
|
|
1006
980
|
* @throws {RequiredError}
|
|
1007
981
|
*/
|
|
1008
|
-
getShipments(
|
|
1009
|
-
return localVarFp.getShipments(queryType, marketplaceId, shipmentStatusList, shipmentIdList, lastUpdatedAfter, lastUpdatedBefore, nextToken, options).then((request) => request(axios, basePath));
|
|
982
|
+
getShipments(requestParameters, options) {
|
|
983
|
+
return localVarFp.getShipments(requestParameters.queryType, requestParameters.marketplaceId, requestParameters.shipmentStatusList, requestParameters.shipmentIdList, requestParameters.lastUpdatedAfter, requestParameters.lastUpdatedBefore, requestParameters.nextToken, options).then((request) => request(axios, basePath));
|
|
1010
984
|
},
|
|
1011
985
|
/**
|
|
1012
986
|
* 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.
|
|
1013
|
-
* @param {
|
|
987
|
+
* @param {FbaInboundApiGetTransportDetailsRequest} requestParameters Request parameters.
|
|
1014
988
|
* @param {*} [options] Override http request option.
|
|
1015
989
|
* @throws {RequiredError}
|
|
1016
990
|
*/
|
|
1017
|
-
getTransportDetails(
|
|
1018
|
-
return localVarFp.getTransportDetails(shipmentId, options).then((request) => request(axios, basePath));
|
|
991
|
+
getTransportDetails(requestParameters, options) {
|
|
992
|
+
return localVarFp.getTransportDetails(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1019
993
|
},
|
|
1020
994
|
/**
|
|
1021
995
|
* 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.
|
|
1022
|
-
* @param {
|
|
1023
|
-
* @param {PutTransportDetailsRequest} body
|
|
996
|
+
* @param {FbaInboundApiPutTransportDetailsRequest} requestParameters Request parameters.
|
|
1024
997
|
* @param {*} [options] Override http request option.
|
|
1025
998
|
* @throws {RequiredError}
|
|
1026
999
|
*/
|
|
1027
|
-
putTransportDetails(
|
|
1028
|
-
return localVarFp.putTransportDetails(shipmentId, body, options).then((request) => request(axios, basePath));
|
|
1000
|
+
putTransportDetails(requestParameters, options) {
|
|
1001
|
+
return localVarFp.putTransportDetails(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1029
1002
|
},
|
|
1030
1003
|
/**
|
|
1031
1004
|
* 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.
|
|
1032
|
-
* @param {
|
|
1033
|
-
* @param {InboundShipmentRequest} body
|
|
1005
|
+
* @param {FbaInboundApiUpdateInboundShipmentRequest} requestParameters Request parameters.
|
|
1034
1006
|
* @param {*} [options] Override http request option.
|
|
1035
1007
|
* @throws {RequiredError}
|
|
1036
1008
|
*/
|
|
1037
|
-
updateInboundShipment(
|
|
1038
|
-
return localVarFp.updateInboundShipment(shipmentId, body, options).then((request) => request(axios, basePath));
|
|
1009
|
+
updateInboundShipment(requestParameters, options) {
|
|
1010
|
+
return localVarFp.updateInboundShipment(requestParameters.shipmentId, requestParameters.body, options).then((request) => request(axios, basePath));
|
|
1039
1011
|
},
|
|
1040
1012
|
/**
|
|
1041
1013
|
* 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.
|
|
1042
|
-
* @param {
|
|
1014
|
+
* @param {FbaInboundApiVoidTransportRequest} requestParameters Request parameters.
|
|
1043
1015
|
* @param {*} [options] Override http request option.
|
|
1044
1016
|
* @throws {RequiredError}
|
|
1045
1017
|
*/
|
|
1046
|
-
voidTransport(
|
|
1047
|
-
return localVarFp.voidTransport(shipmentId, options).then((request) => request(axios, basePath));
|
|
1018
|
+
voidTransport(requestParameters, options) {
|
|
1019
|
+
return localVarFp.voidTransport(requestParameters.shipmentId, options).then((request) => request(axios, basePath));
|
|
1048
1020
|
},
|
|
1049
1021
|
};
|
|
1050
1022
|
};
|
|
@@ -11,8 +11,6 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
// Some imports not used depending on template conditions
|
|
15
|
-
// @ts-ignore
|
|
16
14
|
import globalAxios from 'axios';
|
|
17
15
|
export const BASE_PATH = "https://sellingpartnerapi-na.amazon.com".replace(/\/+$/, "");
|
|
18
16
|
/**
|
|
@@ -52,9 +50,9 @@ export class BaseAPI {
|
|
|
52
50
|
*/
|
|
53
51
|
export class RequiredError extends Error {
|
|
54
52
|
field;
|
|
55
|
-
name = "RequiredError";
|
|
56
53
|
constructor(field, msg) {
|
|
57
54
|
super(msg);
|
|
58
55
|
this.field = field;
|
|
56
|
+
this.name = "RequiredError";
|
|
59
57
|
}
|
|
60
58
|
}
|
|
@@ -73,6 +73,8 @@ export const setOAuthToObject = async function (object, name, scopes, configurat
|
|
|
73
73
|
}
|
|
74
74
|
};
|
|
75
75
|
function setFlattenedQueryParams(urlSearchParams, parameter, key = "") {
|
|
76
|
+
if (parameter == null)
|
|
77
|
+
return;
|
|
76
78
|
if (typeof parameter === "object") {
|
|
77
79
|
if (Array.isArray(parameter)) {
|
|
78
80
|
parameter.forEach(item => setFlattenedQueryParams(urlSearchParams, item, key));
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import {
|
|
13
|
-
import {
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { ConfirmPreorderResponse } from '../models';
|
|
16
16
|
import { ConfirmTransportResponse } from '../models';
|
|
@@ -343,151 +343,123 @@ export declare const FbaInboundApiFp: (configuration?: Configuration) => {
|
|
|
343
343
|
export declare const FbaInboundApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
344
344
|
/**
|
|
345
345
|
* Returns information needed to confirm a shipment for pre-order. Call this operation after calling the getPreorderInfo operation to get the NeedByDate value and other pre-order information about the 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.
|
|
346
|
-
* @param {
|
|
347
|
-
* @param {string} needByDate Date that the shipment must arrive at the Amazon fulfillment center to avoid delivery promise breaks for pre-ordered items. Must be in YYYY-MM-DD format. The response to the getPreorderInfo operation returns this value.
|
|
348
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace the shipment is tied to.
|
|
346
|
+
* @param {FbaInboundApiConfirmPreorderRequest} requestParameters Request parameters.
|
|
349
347
|
* @param {*} [options] Override http request option.
|
|
350
348
|
* @throws {RequiredError}
|
|
351
349
|
*/
|
|
352
|
-
confirmPreorder(
|
|
350
|
+
confirmPreorder(requestParameters: FbaInboundApiConfirmPreorderRequest, options?: AxiosRequestConfig): AxiosPromise<ConfirmPreorderResponse>;
|
|
353
351
|
/**
|
|
354
352
|
* 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.
|
|
355
|
-
* @param {
|
|
353
|
+
* @param {FbaInboundApiConfirmTransportRequest} requestParameters Request parameters.
|
|
356
354
|
* @param {*} [options] Override http request option.
|
|
357
355
|
* @throws {RequiredError}
|
|
358
356
|
*/
|
|
359
|
-
confirmTransport(
|
|
357
|
+
confirmTransport(requestParameters: FbaInboundApiConfirmTransportRequest, options?: AxiosRequestConfig): AxiosPromise<ConfirmTransportResponse>;
|
|
360
358
|
/**
|
|
361
359
|
* 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.
|
|
362
|
-
* @param {
|
|
363
|
-
* @param {InboundShipmentRequest} body
|
|
360
|
+
* @param {FbaInboundApiCreateInboundShipmentRequest} requestParameters Request parameters.
|
|
364
361
|
* @param {*} [options] Override http request option.
|
|
365
362
|
* @throws {RequiredError}
|
|
366
363
|
*/
|
|
367
|
-
createInboundShipment(
|
|
364
|
+
createInboundShipment(requestParameters: FbaInboundApiCreateInboundShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<InboundShipmentResponse>;
|
|
368
365
|
/**
|
|
369
366
|
* 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.
|
|
370
|
-
* @param {
|
|
367
|
+
* @param {FbaInboundApiCreateInboundShipmentPlanRequest} requestParameters Request parameters.
|
|
371
368
|
* @param {*} [options] Override http request option.
|
|
372
369
|
* @throws {RequiredError}
|
|
373
370
|
*/
|
|
374
|
-
createInboundShipmentPlan(
|
|
371
|
+
createInboundShipmentPlan(requestParameters: FbaInboundApiCreateInboundShipmentPlanRequest, options?: AxiosRequestConfig): AxiosPromise<CreateInboundShipmentPlanResponse>;
|
|
375
372
|
/**
|
|
376
373
|
* 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.
|
|
377
|
-
* @param {
|
|
374
|
+
* @param {FbaInboundApiEstimateTransportRequest} requestParameters Request parameters.
|
|
378
375
|
* @param {*} [options] Override http request option.
|
|
379
376
|
* @throws {RequiredError}
|
|
380
377
|
*/
|
|
381
|
-
estimateTransport(
|
|
378
|
+
estimateTransport(requestParameters: FbaInboundApiEstimateTransportRequest, options?: AxiosRequestConfig): AxiosPromise<EstimateTransportResponse>;
|
|
382
379
|
/**
|
|
383
380
|
* 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.
|
|
384
|
-
* @param {
|
|
381
|
+
* @param {FbaInboundApiGetBillOfLadingRequest} requestParameters Request parameters.
|
|
385
382
|
* @param {*} [options] Override http request option.
|
|
386
383
|
* @throws {RequiredError}
|
|
387
384
|
*/
|
|
388
|
-
getBillOfLading(
|
|
385
|
+
getBillOfLading(requestParameters: FbaInboundApiGetBillOfLadingRequest, options?: AxiosRequestConfig): AxiosPromise<GetBillOfLadingResponse>;
|
|
389
386
|
/**
|
|
390
387
|
* 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.
|
|
391
|
-
* @param {
|
|
392
|
-
* @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want inbound guidance for shipment to Amazon\'s fulfillment network. Note: SellerSKU is qualified by the SellerId, which is included with every Selling Partner API operation that you submit. If you specify a SellerSKU that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
|
|
393
|
-
* @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want inbound guidance for shipment to Amazon\'s fulfillment network. Note: If you specify a ASIN that identifies a variation parent ASIN, this operation returns an error. A variation parent ASIN represents a generic product that cannot be sold. Variation child ASINs represent products that have specific characteristics (such as size and color) and can be sold.
|
|
388
|
+
* @param {FbaInboundApiGetInboundGuidanceRequest} requestParameters Request parameters.
|
|
394
389
|
* @param {*} [options] Override http request option.
|
|
395
390
|
* @throws {RequiredError}
|
|
396
391
|
*/
|
|
397
|
-
getInboundGuidance(
|
|
392
|
+
getInboundGuidance(requestParameters: FbaInboundApiGetInboundGuidanceRequest, options?: AxiosRequestConfig): AxiosPromise<GetInboundGuidanceResponse>;
|
|
398
393
|
/**
|
|
399
394
|
* 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.
|
|
400
|
-
* @param {
|
|
401
|
-
* @param {'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'} pageType The page type to use to print the labels. Submitting a PageType value that is not supported in your marketplace returns an error.
|
|
402
|
-
* @param {'BARCODE_2D' | 'UNIQUE' | 'PALLET'} labelType The type of labels requested.
|
|
403
|
-
* @param {number} [numberOfPackages] The number of packages in the shipment.
|
|
404
|
-
* @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.
|
|
405
|
-
* @param {number} [numberOfPallets] The number of pallets in the shipment. This returns four identical labels for each pallet.
|
|
406
|
-
* @param {number} [pageSize] The page size for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments. Max value:1000.
|
|
407
|
-
* @param {number} [pageStartIndex] The page start index for paginating through the total packages\' labels. This is a required parameter for Non-Partnered LTL Shipments.
|
|
395
|
+
* @param {FbaInboundApiGetLabelsRequest} requestParameters Request parameters.
|
|
408
396
|
* @param {*} [options] Override http request option.
|
|
409
397
|
* @throws {RequiredError}
|
|
410
398
|
*/
|
|
411
|
-
getLabels(
|
|
399
|
+
getLabels(requestParameters: FbaInboundApiGetLabelsRequest, options?: AxiosRequestConfig): AxiosPromise<GetLabelsResponse>;
|
|
412
400
|
/**
|
|
413
401
|
* 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.
|
|
414
|
-
* @param {
|
|
415
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace the shipment is tied to.
|
|
402
|
+
* @param {FbaInboundApiGetPreorderInfoRequest} requestParameters Request parameters.
|
|
416
403
|
* @param {*} [options] Override http request option.
|
|
417
404
|
* @throws {RequiredError}
|
|
418
405
|
*/
|
|
419
|
-
getPreorderInfo(
|
|
406
|
+
getPreorderInfo(requestParameters: FbaInboundApiGetPreorderInfoRequest, options?: AxiosRequestConfig): AxiosPromise<GetPreorderInfoResponse>;
|
|
420
407
|
/**
|
|
421
408
|
* 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.
|
|
422
|
-
* @param {
|
|
423
|
-
* @param {Array<string>} [sellerSKUList] A list of SellerSKU values. Used to identify items for which you want labeling requirements and item preparation instructions for shipment to Amazon\'s fulfillment network. The SellerSKU is qualified by the Seller ID, which is included with every call to the Seller Partner API. Note: Include seller SKUs that you have used to list items on Amazon\'s retail website. If you include a seller SKU that you have never used to list an item on Amazon\'s retail website, the seller SKU is returned in the InvalidSKUList property in the response.
|
|
424
|
-
* @param {Array<string>} [aSINList] A list of ASIN values. Used to identify items for which you want item preparation instructions to help with item sourcing decisions. Note: ASINs must be included in the product catalog for at least one of the marketplaces that the seller participates in. Any ASIN that is not included in the product catalog for at least one of the marketplaces that the seller participates in is returned in the InvalidASINList property in the response. You can find out which marketplaces a seller participates in by calling the getMarketplaceParticipations operation in the Selling Partner API for Sellers.
|
|
409
|
+
* @param {FbaInboundApiGetPrepInstructionsRequest} requestParameters Request parameters.
|
|
425
410
|
* @param {*} [options] Override http request option.
|
|
426
411
|
* @throws {RequiredError}
|
|
427
412
|
*/
|
|
428
|
-
getPrepInstructions(
|
|
413
|
+
getPrepInstructions(requestParameters: FbaInboundApiGetPrepInstructionsRequest, options?: AxiosRequestConfig): AxiosPromise<GetPrepInstructionsResponse>;
|
|
429
414
|
/**
|
|
430
415
|
* 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.
|
|
431
|
-
* @param {
|
|
432
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
433
|
-
* @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.
|
|
434
|
-
* @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.
|
|
435
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
416
|
+
* @param {FbaInboundApiGetShipmentItemsRequest} requestParameters Request parameters.
|
|
436
417
|
* @param {*} [options] Override http request option.
|
|
437
418
|
* @throws {RequiredError}
|
|
438
419
|
*/
|
|
439
|
-
getShipmentItems(
|
|
420
|
+
getShipmentItems(requestParameters: FbaInboundApiGetShipmentItemsRequest, options?: AxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
|
|
440
421
|
/**
|
|
441
422
|
* 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.
|
|
442
|
-
* @param {
|
|
443
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
423
|
+
* @param {FbaInboundApiGetShipmentItemsByShipmentIdRequest} requestParameters Request parameters.
|
|
444
424
|
* @param {*} [options] Override http request option.
|
|
445
425
|
* @throws {RequiredError}
|
|
446
426
|
*/
|
|
447
|
-
getShipmentItemsByShipmentId(
|
|
427
|
+
getShipmentItemsByShipmentId(requestParameters: FbaInboundApiGetShipmentItemsByShipmentIdRequest, options?: AxiosRequestConfig): AxiosPromise<GetShipmentItemsResponse>;
|
|
448
428
|
/**
|
|
449
429
|
* 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.
|
|
450
|
-
* @param {
|
|
451
|
-
* @param {string} marketplaceId A marketplace identifier. Specifies the marketplace where the product would be stored.
|
|
452
|
-
* @param {Array<'WORKING' | 'READY_TO_SHIP' | 'SHIPPED' | 'RECEIVING' | 'CANCELLED' | 'DELETED' | 'CLOSED' | 'ERROR' | 'IN_TRANSIT' | 'DELIVERED' | 'CHECKED_IN'>} [shipmentStatusList] A list of ShipmentStatus values. Used to select shipments with a current status that matches the status values that you specify.
|
|
453
|
-
* @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.
|
|
454
|
-
* @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.
|
|
455
|
-
* @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.
|
|
456
|
-
* @param {string} [nextToken] A string token returned in the response to your previous request.
|
|
430
|
+
* @param {FbaInboundApiGetShipmentsRequest} requestParameters Request parameters.
|
|
457
431
|
* @param {*} [options] Override http request option.
|
|
458
432
|
* @throws {RequiredError}
|
|
459
433
|
*/
|
|
460
|
-
getShipments(
|
|
434
|
+
getShipments(requestParameters: FbaInboundApiGetShipmentsRequest, options?: AxiosRequestConfig): AxiosPromise<GetShipmentsResponse>;
|
|
461
435
|
/**
|
|
462
436
|
* 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.
|
|
463
|
-
* @param {
|
|
437
|
+
* @param {FbaInboundApiGetTransportDetailsRequest} requestParameters Request parameters.
|
|
464
438
|
* @param {*} [options] Override http request option.
|
|
465
439
|
* @throws {RequiredError}
|
|
466
440
|
*/
|
|
467
|
-
getTransportDetails(
|
|
441
|
+
getTransportDetails(requestParameters: FbaInboundApiGetTransportDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<GetTransportDetailsResponse>;
|
|
468
442
|
/**
|
|
469
443
|
* 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.
|
|
470
|
-
* @param {
|
|
471
|
-
* @param {PutTransportDetailsRequest} body
|
|
444
|
+
* @param {FbaInboundApiPutTransportDetailsRequest} requestParameters Request parameters.
|
|
472
445
|
* @param {*} [options] Override http request option.
|
|
473
446
|
* @throws {RequiredError}
|
|
474
447
|
*/
|
|
475
|
-
putTransportDetails(
|
|
448
|
+
putTransportDetails(requestParameters: FbaInboundApiPutTransportDetailsRequest, options?: AxiosRequestConfig): AxiosPromise<PutTransportDetailsResponse>;
|
|
476
449
|
/**
|
|
477
450
|
* 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.
|
|
478
|
-
* @param {
|
|
479
|
-
* @param {InboundShipmentRequest} body
|
|
451
|
+
* @param {FbaInboundApiUpdateInboundShipmentRequest} requestParameters Request parameters.
|
|
480
452
|
* @param {*} [options] Override http request option.
|
|
481
453
|
* @throws {RequiredError}
|
|
482
454
|
*/
|
|
483
|
-
updateInboundShipment(
|
|
455
|
+
updateInboundShipment(requestParameters: FbaInboundApiUpdateInboundShipmentRequest, options?: AxiosRequestConfig): AxiosPromise<InboundShipmentResponse>;
|
|
484
456
|
/**
|
|
485
457
|
* 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.
|
|
486
|
-
* @param {
|
|
458
|
+
* @param {FbaInboundApiVoidTransportRequest} requestParameters Request parameters.
|
|
487
459
|
* @param {*} [options] Override http request option.
|
|
488
460
|
* @throws {RequiredError}
|
|
489
461
|
*/
|
|
490
|
-
voidTransport(
|
|
462
|
+
voidTransport(requestParameters: FbaInboundApiVoidTransportRequest, options?: AxiosRequestConfig): AxiosPromise<VoidTransportResponse>;
|
|
491
463
|
};
|
|
492
464
|
/**
|
|
493
465
|
* Request parameters for confirmPreorder operation in FbaInboundApi.
|
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import { Configuration } from
|
|
13
|
-
import { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
12
|
+
import type { Configuration } from './configuration';
|
|
13
|
+
import type { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
@@ -50,6 +50,5 @@ export declare class BaseAPI {
|
|
|
50
50
|
*/
|
|
51
51
|
export declare class RequiredError extends Error {
|
|
52
52
|
field: string;
|
|
53
|
-
name: "RequiredError";
|
|
54
53
|
constructor(field: string, msg?: string);
|
|
55
54
|
}
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/// <reference types="node" />
|
|
13
|
-
import { Configuration } from "./configuration";
|
|
14
|
-
import { RequestArgs } from "./base";
|
|
15
|
-
import { AxiosInstance, AxiosResponse } from 'axios';
|
|
13
|
+
import type { Configuration } from "./configuration";
|
|
14
|
+
import type { RequestArgs } from "./base";
|
|
15
|
+
import type { AxiosInstance, AxiosResponse } from 'axios';
|
|
16
16
|
/**
|
|
17
17
|
*
|
|
18
18
|
* @export
|
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.10.
|
|
5
|
+
"version": "1.10.4",
|
|
6
6
|
"main": "dist/cjs/index.js",
|
|
7
7
|
"module": "dist/es/index.js",
|
|
8
8
|
"types": "dist/types/index.d.ts",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"test": "jest"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@sp-api-sdk/common": "^1.9.
|
|
29
|
+
"@sp-api-sdk/common": "^1.9.22",
|
|
30
30
|
"axios": "^0.27.2"
|
|
31
31
|
},
|
|
32
32
|
"repository": {
|
|
@@ -51,5 +51,5 @@
|
|
|
51
51
|
"typedoc": {
|
|
52
52
|
"entryPoint": "./index.ts"
|
|
53
53
|
},
|
|
54
|
-
"gitHead": "
|
|
54
|
+
"gitHead": "19982f06cbbd770bfc7b9f1bc8a42f59b57baead"
|
|
55
55
|
}
|