v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB

External Fulfillment Shipping v2024-09-11

getShipment

Get a single shipment with the ID you specify.

get/externalFulfillment/2024-09-11/shipments/{shipmentId}

Path parameters

shipmentIdstring required

The ID of the shipment you want to retrieve.

Response

Success.

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.