/Shipments GET

Returns a sortable list of shipping history for the logged in user

URL

/Shipments

Verb

GET

Headers

Header	Data Type	Valid Values	Required	Description
Content-Type	string	application/json	YES	The format your data will be sent to our site.
X-DevKey	string	string	YES	The devkey assigned to the developer.
X-AccessToken	string	string	YES	The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the query string of the request.

Parameter	Data Type	Valid Values	Description
ShipmentDescription	string	Any string	Searches for description of shipment
ShipmentID	integer	positive #	Searches ID of shipment
ToName	string	Any string	Searches for name shipment is being sent to
TrackingNumber	string	Any string	Searches for tracking number of shipment
Sort	integer	0 - Shipment ID Asc 1 - Shipment ID Desc 2 - ToName Asc 3 - ToName Desc 4 - Carrier Asc 5 - Carrier Desc 6 - DateCreated Asc 7 - DateCreated Desc	The order in which the results are returned. Default = 1 - Shipment ID Asc
TimeFrame	integer	1 - AllAvailable 2 - CreatedWithin24Hours 3 - CreatedWithin48Hours 4 - CreatedWithinWeek 5 - CreatedWithin2Weeks 6 - CreatedWithin30Days 7 - CreatedWithin60Days 8 - CreatedWithin90Days	Using this parameter requires a valid X-AccessToken authentication header. This sets the time frame to search for. Default = 6 - CreatedWithin30Days.

Output

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter	Data Type	Valid Values	Description
cancelDate	datetime	datetime	Date when shipment was cancelled
carrier	integer	positive #	Enum belonging to the type of Carrier
dateCreated	datetime	datetime	Date when shipment was created
height	decimal	positive #	Height of the Shipment
form1508Url	string	Fully-qualified URL	The URL for USPS Form 1508 for the shipment (USPS handgun shipments only)
labelUrl	string	Fully-qualified URL	The URL for the shipping label for the shipment
length	decimal	positive #	Length of the Shipment
rackRate	decimal	positive #	Rack rate of the Shipment
shippingCostUser	decimal	positive #	Shipping cost of the Shipment
shipmentDescription	string	string	Description of shipment
shippingClassDisplayName	string	string	Display name for a shipment class based on carrier
shippingClassName	string	string	Class name of shipment
shipmentID	integer	positive #	ID belonging to shipment
toName	string	string	To Name of the shipment
trackingNumber	string	string	Tracking number of shipment
weight	decimal	positive #	Weight of the Shipment
weightUnit	decimal	positive #	Weight Unit of the Shipment
width	decimal	positive #	Width of the Shipment

Links

Rel	Description	Condition
self	The shipment details