Sign in
Fulfillment Inbound v2024-03-20

getShipment

Provides the full details for a specific shipment within an inbound plan. The transportationOptionId inside acceptedTransportationSelection can be used to retrieve the transportation details for the shipment.

get/inbound/fba/2024-03-20/inboundPlans/{inboundPlanId}/shipments/{shipmentId}

Path parameters

inboundPlanIdstring required

Identifier of an inbound plan.

shipmentIdstring required

Identifier of a shipment. A shipment contains the boxes and units being inbounded.

Response

GetShipment 200 response

vendorShipmentIdentifierstring required

Unique Transportation ID created by Vendor (Should not be used over the last 365 days).

transactionType'New' | 'Cancel' required

Indicates the type of transportation request (for example, New or Cancel). Each transactionType has a unique set of operations and there are corresponding details to be populated for each operation.

buyerReferenceNumberstring

The buyer Reference Number is a unique identifier generated by buyer for all Collect/WePay shipments when you submit a transportation request. This field is mandatory for Collect/WePay shipments.

transactionDatestring date-time required

Date on which the transportation request was submitted.

currentShipmentStatus'Created' | 'TransportationRequested' | 'CarrierAssigned' | 'Shipped'

Indicates the current shipment status.

currentshipmentStatusDatestring date-time

Date and time when the last status was updated.

shipmentCreateDatestring date-time

The date and time of the shipment request created by vendor.

shipmentConfirmDatestring date-time

The date and time of the departure of the shipment from the vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Buyer destination warehouse, whichever is sooner. Shipped date mentioned in the shipment confirmation should not be in the future.

packageLabelCreateDatestring date-time

The date and time of the package label created for the shipment by buyer.

shipmentFreightTerm'Collect' | 'Prepaid'

Specifies if payment is Collect (WePay) or Prepaid (TheyPay). Required.