Get a single shipment

GET
/shipments/{shipmentID}

Roles

At least one of the roles below is required to access this endpoint

FullAccess
ShipmentAdmin
ShipmentReader

Parameters

NameTypeDescriptionPossible Values
shipmentIDstringID of the shipment.---

Response Body

PropertyTypeFormatMax LengthPossible Values
IDstring---100 characters---
BuyerIDstring---------
Shipperstring---------

DateShippedstringdate-time------

DateDeliveredstringdate-time------
TrackingNumberstring---3000 characters---
Costnumberfloat------

OwnerIDstring---------

xpobject---------
Accountstring---------
FromAddressIDstring---------

ToAddressIDstring---------
FromAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------
ToAddress
Read Only
object---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---100 characters---
DateCreated
Read Only
stringdate-time------
CompanyName
Read Only
string---100 characters---
FirstName
Read Only
string---100 characters---
LastName
Read Only
string---100 characters---
Street1
Read Only
string---100 characters---
Street2
Read Only
string---100 characters---
City
Read Only
string---100 characters---
State
Read Only
string---100 characters---
Zip
Read Only
string---100 characters---
Country
Read Only
string---2 characters---
Phone
Read Only
string---100 characters---
AddressName
Read Only
string---100 characters---
xp
Read Only
object---------