Shipment API

Route Planning

Endpoint

Global default server with tenant, region, environment, and version variables

https://...sh.example.com/

Download schema

Get estimated delivery time

GET

https://acme-logistics.us-east-1.prod.sh.example.com/v1

/routes/{originFacilityId}/{destinationFacilityId}/{serviceLevel}/estimate

Get estimated delivery time between two facilities for a specific service level

Get estimated delivery time › path Parameters

serviceLevel

string · enum · required

Service level for the route

Enum values:

ECONOMY

STANDARD

EXPRESS

SAME_DAY

Default: STANDARD

destinationFacilityId

string · required

ID of the destination facility

Example: JFK1

originFacilityId

string · required

ID of the origin facility

Example: LAX1

Get estimated delivery time › Responses

Route estimate retrieved successfully

object

GET/routes/{originFacilityId}/{destinationFacilityId}/{serviceLevel}/estimate

const options = {method: 'GET'};

fetch('https://acme-logistics.us-east-1.prod.sh.example.com/v1/routes/:originFacilityId/:destinationFacilityId/:serviceLevel/estimate', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "estimatedDeliveryTime": {
    "min": 2,
    "max": 3,
    "unit": "DAYS"
  },
  "distance": {
    "value": 2789.4,
    "unit": "MI"
  },
  "route": {
    "transitHubs": [
      "DEN1",
      "CHI1"
    ],
    "transportModes": [
      "GROUND"
    ]
  }
}

json

application/json

Organization Management Other endpoints

Shipment API

Route Planning

Endpoint

Global default server with tenant, region, environment, and version variables

https://...sh.example.com/

Download schema

Get estimated delivery time

GET

https://acme-logistics.us-east-1.prod.sh.example.com/v1

/routes/{originFacilityId}/{destinationFacilityId}/{serviceLevel}/estimate

Get estimated delivery time between two facilities for a specific service level

Get estimated delivery time › path Parameters

serviceLevel

string · enum · required

Service level for the route

Enum values:

ECONOMY

STANDARD

EXPRESS

SAME_DAY

Default: STANDARD

destinationFacilityId

string · required

ID of the destination facility

Example: JFK1

originFacilityId

string · required

ID of the origin facility

Example: LAX1

Get estimated delivery time › Responses

Route estimate retrieved successfully

object

GET/routes/{originFacilityId}/{destinationFacilityId}/{serviceLevel}/estimate

const options = {method: 'GET'};

fetch('https://acme-logistics.us-east-1.prod.sh.example.com/v1/routes/:originFacilityId/:destinationFacilityId/:serviceLevel/estimate', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

Example Responses

{
  "estimatedDeliveryTime": {
    "min": 2,
    "max": 3,
    "unit": "DAYS"
  },
  "distance": {
    "value": 2789.4,
    "unit": "MI"
  },
  "route": {
    "transitHubs": [
      "DEN1",
      "CHI1"
    ],
    "transportModes": [
      "GROUND"
    ]
  }
}

json

application/json

Organization Management Other endpoints