[OPTIONAL] Orders

Creating a Basic Order

You can use the Order Object to add greater detail to your shipments. Below are the parameters necessary to add order details:

Parameter	Type	Description
PickupStopReference	String	The external reference to pickup "Stop".
DeliveryStopReference	String	The external Reference to Delivery "Stop".
OrderNumber	String	The external order reference number. Max Length: 50.

Parameter

Type

Description

PickupStopReference

String

The external reference to pickup "Stop".

DeliveryStopReference

String

The external Reference to Delivery "Stop".

OrderNumber

String

The external order reference number.

Max Length: 50.

Here is an example of a basic Order JSON Object:

{
  "PickupStopReference" : "1",
  "DeliveryStopReference" : "2",
  "OrderNumber" : "DEGN92575474"
}

Additional Options

Below are some additional data points that can be added on an order:

Parameter	Type	Description
CustomerName	String	The name of the customer account. Max Length: 50.
CustomerReference	String	The external customer account reference. When supplied, a new customer account associated with the freight provider will be created, if it doesn’t already exist, with ‘CustomerReference’ and ‘CustomerName’. MaxLength: 50.
Commodity	Object
OrderDateTime	Date/Time	Optional date/time field for date information that the customer needs to provide on a order.
OrderTypeName	String	Additional order parameter to be used if additional order naming is needed.
ServiceLevel	String	Service level for order.
OrderReference	String	Additional order reference value.

Here is an example of an Order JSON Object with the additional optional parameters:

{
  "PickupStopReference" : "1",
  "DeliveryStopReference" : "2",
  "OrderNumber" : "DEGN92575474",
  "CustomerName":"BYRNE BROTHERS",
  "CustomerReference":"BYRNE002",
  "OrderDateTime": "11/17/2021 9:30",
  "OrderTypeName": "Custom2",
  "ServiceLevel": "Urgent2",
  "OrderReference": "2073524REF2" 
}

Complete Order Object

Below are shipment examples using the basic and additional order information in use.

{
  "FreightProviderReferenceNumber":"989898",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"Origin",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234
    },
    {
      "StopReference":"Destination",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543
    }
  ],
  "Orders": 
  [
    {
      "PickupStopReference" : "Origin",
      "DeliveryStopReference" : "Destination",
      "OrderNumber" : "JUSTANORDERNARYORDER"
    }
  ]
}

{
  "FreightProviderReferenceNumber":"898989",
  "CarrierScac":"TEST",
  "Stops":
  [
    {
      "StopReference":"Origin",
      "StopScheduledDatePart":"2018-08-11",
      "StopSequence":1,
      "StopType":1,
      "Latitude":50.1234,
      "Longitude":-45.1234
    },
    {
      "StopReference":"Destination",
      "StopScheduledDatePart":"2018-08-12",
      "StopSequence":2,
      "StopType":3,
      "Latitude":50.4920,
      "Longitude":-44.5543
    }
  ],
  "Orders": 
  [
    {
      "PickupStopReference" : "Origin",
      "DeliveryStopReference" : "Destination",
      "OrderNumber" : "JUSTANORDERNARYORDER",
      "CustomerName":"Jonesy",
	    "CustomerReference":"APICUSTOMERGUYORGAL"
      "OrderDateTime": "11/17/2021 9:30",
      "OrderTypeName": "Custom2",
      "ServiceLevel": "Urgent2",
      "OrderReference": "2073524REF2",  
    }
  ]
}

Updated about 2 months ago

What’s Next

[OPTIONAL] Commodities