TRtrackstarhq
freight
Shipments

Get Shipment

Changed on

Returns a single Shipment for the Freight connection with the associated shipment id.

get/freight/shipments/{shipment_id}

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/freight/shipments/{shipment_id}
  • Auth
    none required

Path parameters

shipment_idstring required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Response

Successful response

Example response

{
  "data": {
    "id": "shipment_id",
    "eta_date": "2021-01-01T00:00:00Z",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "cost": 1,
    "shipment_date": "2021-01-01T00:00:00Z",
    "arrival_date": "2021-01-01T00:00:00Z",
    "raw_status": "status",
    "status": "pre_transit",
    "shipment_method": "shipment_method",
    "external_system_url": "https://example.com/freightshipment/123",
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-03-15T13:45:30Z",
    "trackstar_updated_date": "2023-03-15T13:45:30Z"
  }
}

Changes