[v2.6] Routing

Overview

This endpoint compares the information passed in to the defined routing guides in SCC to see if any match the criteria.

If more than one routing guide matches the provided criteria, the system returns the most-specific routing guide as the result.

Request Body

Property	Data Type	Notes
shipToId	string	Partner ID associated with the routing guide.
expectedTransitTime	integer	Desired number of days in transit.
totalWeight	number	Total weight of the shipment.
totalCartonCount	interger	Total number of cartons. Either this OR the pallet count should be filled in.
totalPalletCount	number	Total number of pallets. Either this OR the carton count should be filled in.
orderTag	string	Order attribute that this order is associated to.
customerTag	string	Customer attribute that this order is associated to.
itemTag	string	Item attribute that should be associated to the order.

shipFromAddress

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

shipToAddress

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

Response

routingResults

Property	Data Type	Notes
carrierName	string	The carrier name assigned to the most accurate routing guide.
carrierServiceName	string	The carrier service level assigned to the most accurate routing guide.
carrierGroupName	string	Carrier group to be used for bidding. Note This is only filled out if the above two items are blank.