Amazon Smart Connect - Get Shipment
| Version | Created by | Date | Note |
|---|---|---|---|
| 1.0 | Danail Deltchev | 24.07.2024 | First Publish |
The purpose of this page is to explain how to work with the Get Shipment functionality for the Amazon Smart Connect project
GetShipment is used with the ShipmentID and provides the option to obtain the full information for a single Shipment one at a time
The purpose of using this is to be able to obtain realtime updated info for the Shipment itself. We’d like to use this as a check after every operation we send to the marketplace and as a starter for the Dispatch ID (for more info please check each doc). The idea of the checking is to confirm that an operation has been properly executed on the MP by checking that the status has changed to the one we expect
The getShipment operation is to be ready available for every other script to use and then each other script is to do what it wants with the obtained information.
If getShipment fails on its own (operation isn’t executed or we get an error code from the Marketplace) we are to store the relevant error in Order Error and treat the whole operation as fail!
Each other function (Success or Success with bad data) is described as per the other documents using the getShipment
This operation is done via the GET getShipment
Example call:
https://sellingpartnerapi-na.amazon.com/externalFulfillment/shipments/2021-01-06/shipments/{shipmentId}
Usable parameters:
| Parameter Name | Parameter Description | Type | Required | Hemi Mapping | Hemi Note |
|---|---|---|---|---|---|
| shipmentId | The id of the shipment for which we want to get information | String | Yes | Orders > Marketplace Order ID | Just the first part of it (please refer to how we concat two values in the Amazon Smart Connect - Get Shipments) |
Payload is the same as in getShipments (page is here: Amazon Smart Connect - Get Shipments)
If the call itself is unsuccessful we should store the relevant error in Order Error and not progress the order further. For Dispatch Shipment Validations please refer to the relevant doc