Shipment API

Rates & Billing

Endpoint

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

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

Download schema

Endpoints related to calculating shipping rates, billing, and insurance.

Calculate shipping rates

POST

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

/shipments/{shipmentId}/rates

Calculate available shipping rates for a shipment based on service level, destination, and package details

Calculate shipping rates › path Parameters

shipmentId

string · uuid · required

Calculate shipping rates › Request Body

serviceLevel

string · enum · required

Enum values:

ECONOMY

STANDARD

EXPRESS

SAME_DAY

object

Calculate shipping rates › Responses

200

Rates calculated successfully

baseRate

number · float

object[]

totalRate

number · float

currency

string

object

POST/shipments/{shipmentId}/rates

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({serviceLevel: 'STANDARD'})
};

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

Example Request Body

{
  "serviceLevel": "STANDARD"
}

json

application/json

Example Responses

{
  "baseRate": 15.99,
  "fees": [
    {
      "type": "FUEL_SURCHARGE",
      "amount": 1.2,
      "description": "Current fuel surcharge"
    }
  ],
  "totalRate": 17.19,
  "currency": "USD",
  "transitTime": {
    "min": 3,
    "max": 5,
    "unit": "DAYS"
  }
}

json

application/json

Add insurance

POST

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

/shipments/{shipmentId}/insurance

Add or modify insurance coverage for a shipment

Add insurance › path Parameters

shipmentId

string · uuid · required

Add insurance › Request Body

coverage

number · float · required

object[]

Add insurance › Responses

200

Insurance added successfully

premium

number · float

coverage

number · float

policyNumber

string

POST/shipments/{shipmentId}/insurance

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    coverage: 2500,
    items: [
      {description: 'MacBook Pro 16"', value: 2000},
      {description: 'Apple Magic Keyboard', value: 300},
      {description: 'Apple Magic Mouse', value: 200}
    ]
  })
};

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

Example Request Body

{
  "coverage": 2500,
  "items": [
    {
      "description": "MacBook Pro 16\"",
      "value": 2000
    },
    {
      "description": "Apple Magic Keyboard",
      "value": 300
    },
    {
      "description": "Apple Magic Mouse",
      "value": 200
    }
  ]
}

json

application/json

Example Responses

{
  "premium": 75,
  "coverage": 2500,
  "policyNumber": "INS-123456"
}

json

application/json

Notifications International Shipping

Calculate shipping rates

POST

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

/shipments/{shipmentId}/rates

Calculate available shipping rates for a shipment based on service level, destination, and package details

Calculate shipping rates › path Parameters

shipmentId

string · uuid · required

Calculate shipping rates › Request Body

serviceLevel

string · enum · required

Enum values:

ECONOMY

STANDARD

EXPRESS

SAME_DAY

object

Calculate shipping rates › Responses

200

Rates calculated successfully

baseRate

number · float

object[]

totalRate

number · float

currency

string

object

const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: JSON.stringify({serviceLevel: 'STANDARD'}) }; fetch('https://acme-logistics.us-east-1.prod.sh.example.com/v1/shipments/:shipmentId/rates', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "baseRate": 15.99, "fees": [ { "type": "FUEL_SURCHARGE", "amount": 1.2, "description": "Current fuel surcharge" } ], "totalRate": 17.19, "currency": "USD", "transitTime": { "min": 3, "max": 5, "unit": "DAYS" } }

Add insurance

POST

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

/shipments/{shipmentId}/insurance

Add or modify insurance coverage for a shipment

Add insurance › path Parameters

shipmentId

string · uuid · required

Add insurance › Request Body

coverage

number · float · required

object[]

Add insurance › Responses

200

Insurance added successfully

premium

number · float

coverage

number · float

policyNumber

string

const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: JSON.stringify({ coverage: 2500, items: [ {description: 'MacBook Pro 16"', value: 2000}, {description: 'Apple Magic Keyboard', value: 300}, {description: 'Apple Magic Mouse', value: 200} ] }) }; fetch('https://acme-logistics.us-east-1.prod.sh.example.com/v1/shipments/:shipmentId/insurance', options) .then(response => response.json()) .then(response => console.log(response)) .catch(err => console.error(err));

{ "coverage": 2500, "items": [ { "description": "MacBook Pro 16\"", "value": 2000 }, { "description": "Apple Magic Keyboard", "value": 300 }, { "description": "Apple Magic Mouse", "value": 200 } ] }