Retrieve shipment details

🚧

Important

GetShipmentDetails is only for WePay and collect orders in the North American and EU marketplaces.

You can use the GetShipmentDetails operation to retrieve scheduled pickup and carrier assignment information.

Prerequisites

To complete this tutorial, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API Applications.
• The Vendor Retail Procurement Shipments role assigned to your developer profile.

You must use SubmitShipments or a routing request before shipment details are available. GetShipmentDetails only returns a response after carrier assignment, which occurs either on the same day as the scheduled pickup or one day prior to the pickup date.

The details returned in the response help you efficiently run your shipping process, ensure that the order is packed, and that it's ready for pickup by the carrier on the assigned pickup date. At any time during the shipment lifecycle, you can use this operation to view shipment status and details. This operation is primarily used by WePay vendors.

Business requirements

• The GetShipmentDetails operation only returns a response for shipments with completed carrier assignments. Carrier assignment occurs on the same day as the scheduled pickup or one day prior to the pickup date.

• The GetShipmentDetails operation does not provide details for shipments submitted through Vendor Central.

Get list of shipments

Call the GetShipmentDetails operation to return a list of shipments.