Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

NameStatus
DescriptionGives a query-able list of shipments for a brokerages. All shipments are scoped to the office that the POS user is assigned to. Currently, this endpoint is only supported by the POS.
TypeGET
URL/v9/shipments/status

Long Description

Gives a query-able list of shipments for a brokerages. All shipments are scoped to the office that the POS user is assigned to. Currently, this endpoint is only supported by the POS.

Parameters

Name
Description
Value Type
Required
typeType of the shipment (e.g. Delivery::FedEx)StringOptional
stateState of the shipment (e.g. delivered, in_transit)StringOptional
order_group_idThe Order Group the shipment belongs toIntegerOptional
order_link_idThe Order Link for the brokerageIntegerOptional
tracking_numberThe tracking for the shipmentStringOptional
ship_to_nameThe name of the shipment recipientStringOptional
ship_from_nameThe name of the shipment senderStringOptional
first_event_occurs_atThe ISO-8601 date (e.g. 2013-01-01) for when the first event occurs.
 Can also be refined with a range (e.g.
first_event_occurs_at.gt, first_event_occurs_at.gte
first_event_occurs_at.lt, first_event_occurs_at.lte)
StringOptional
order_byThe column to order results by. Only columns that are filterable can also be order-able.StringOptional
order_directionThe way results should be ordered (e.g. asc, desc)StringOptional

 

Examples

RequestResponse
/v9/shipments/status?first_event_occurs_at.gte=2013-04-10&first_event_occurs_at.lte=2013-04-12&order_by=id&order_direction=desc 
None...
{
   "shipments":[
      {
         "ship_to_name":"Patrick Boston",
         "order_group_id":22173,
         "id":38715,
         "type":"Delivery::FedEx",
         "tracking_number":"799435511652",
         "order_link_id":95430,
         "ship_from_name":null,
         "state":"in_transit",
         "office_id":50,
         "first_event_occurs_at":"2013-04-10T19:00:00Z"
      },
      {
         "ship_to_name":"Thomas Przestwor",
         "order_group_id":22036,
         "id":38577,
         "type":"Delivery::FedEx",
         "tracking_number":"799435479185",
         "order_link_id":95155,
         "ship_from_name":null,
         "state":"in_transit",
         "office_id":50,
         "first_event_occurs_at":"2013-04-10T20:00:00Z"
      },
      {
         "ship_to_name":"Owyn Stephens",
         "order_group_id":21840,
         "id":38380,
         "type":"Delivery::FedEx",
         "tracking_number":"799439801975",
         "order_link_id":94751,
         "ship_from_name":null,
         "state":"in_transit",
         "office_id":50,
         "first_event_occurs_at":"2013-04-11T19:10:00Z"
      }
   ]
}