/

[v2.6] Mileage

[v2.6] Mileage

Owned by Megan Stanage

Sept 05, 2024

Overview

This endpoint allows the user to pass information to call out to a mileage calculation solution.

POST /Mileage

Request Body

Property	Data Type	Notes
routeType	enum	Practical Shortest Fastest
distanceUom	enum	Miles Kilometers

shipFrom

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30
latitude	number	double
longitude	number	double

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

shipStops

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30
latitude	number	double
longitude	number	double

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

Response

Property	Data Type	Notes
distanceUom	enum	Miles Kilometers
mileage	number	double

legs

Property	Data Type	Notes
mileage	number	double

fromAddress

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30
latitude	number	double
longitude	number	double

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

toAddress

Property	Data Type	Notes
name	string	max length: 100
company	string	max length: 150
attentionTo	string	max length: 150
addressLines	string
city	string	max length: 150
postalCode	string	max length: 15
stateProvinceCode	string	max length: 5
country	string
countryCode	string	max length: 5
phoneNumber	string	max length: 20
residential	boolean
taxId	string
emailAddress	string	max length: 400
county	string	max length: 30
latitude	number	double
longitude	number	double

identificationNumbers

Property	Data Type	Notes
vat	string
eori	string

Related content

[v2.6] DemandValidation

[v2.6] DemandValidation

Ship + Buy + Tender + Orchestrate

Read with this

[v2.6] DemandPriority

[v2.6] DemandPriority

Ship + Buy + Tender + Orchestrate

Read with this

Feedback

Submit feedback.