Read

You can get a route by its id or by some delivery id that belongs to the route.

Endpoint

GET {{SHIPPIFY_API_URL}}/v1/routes/:id

Request

PropertyTypeDescriptionRequiredConstraints

id

string

Route ID or delivery ID

YES

Response

PropertyTypeDescription

route.id

string

Result code.

route.referenceId

string

Result description.

route.city

object

City data.

route.deliveries

List of all deliveries belonging to the route.

currencyCode

string

Currency Code.

stepIds

array of objects

List in order with the steps of the route.

status

string

Route status

distances.routeDistances

arrray of numbers

Distances at each step

distances.chargedDistances

arrray of numbers

Charged distances at each step

Example

curl --location --request GET 'https://api.shippify.co/v1/routes/r-shiinc-2217499/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Cookie: locale=es'