Freight

tracking shipments

Returns the latest status and the last known driver location of one or more shipments.

Request parameters

NameTypeRequired/OptionalDescription
trackingNumbersArray<String>RequiredThe identifiers to look up. Each value can be a shipment tracking number, a shipment number (code, e.g. S-00524-2635) or an order number (code, e.g. P-01723-2449). Unknown values are simply omitted from the response. At most 50 values per request.
<br /> **Response parameters** (one element per matched shipment) | Name | Type | Description | |-----------------------|--------|---------------------------------------------------------------------------------------------------| | trackingNumber | String | The value from the request that matched this shipment. | | orderId | String | The ID of the order. | | orderNumber | String | The display number (code) of the order. | | shipmentId | String | The ID of the shipment. | | shipmentNumber | String | The display number (code) of the shipment. | | statusInfo.status | String | Current shipment status (see the table below). | | statusInfo.lastUpdated| String | ISO 8601 timestamp of the last status change (`null` when unknown). | | location | Object | Last known driver location - `null` when the shipment is not on a route yet or no GPS ping exists. | | location.latitude | Number | | | location.longitude | Number | | | location.lastUpdated | String | ISO 8601 timestamp of the GPS ping (`null` when unknown). | <br /> **Shipment status** | Value | Description | |-----------------------|------------------------------------------------------------------------------------| | needCarrier | First status when creating a shipment - Need to assign carrier. | | booked | When the carrier is assigned to the shipment. | | dispatched | When the driver/vehicle has started for pickup location. | | arrivedAtPickup | When the driver/vehicle has arrived at pickup location. | | pickupSuccessful | When the order is loaded in vehicle. | | pickupFailed | When Pickup task is Failed. | | inRouteToDropoff | When the driver/vehicle has started for dropoff location. | | arrivedAtDropoff | When the driver/vehicle has arrived at dropoff location. | | dropoffSuccessful | When the driver/vehicle has delivered the order successfully. | | dropoffFailed | When Dropoff task is “Failed”. | | complete | When the order is completed. | | returnInitiated | when return task is created. | | inRouteToReturn | When the driver/vehicle has started for return location. | | arrivedAtReturn | When the driver/vehicle has arrived at return location. | | returned | When the driver/vehicle has returned the order successfully. | | canceled | When the order is canceled. | | inRouteToWareHouse | When order is in route to the warehouse (In the case of using crossdock warehouse) | | arrivedAtWareHouse | When order is arrived at the warehouse (In the case of using crossdock warehouse) | | departedFromWarehouse | When order has left the warehouse (In the case of using crossdock warehouse) | | lost | When the shipment was reported lost. | | issue | When an issue was raised on the shipment and it is under review. | | removed | When the shipment was removed from its order. | | disposed | When the shipment was disposed of. |
post/freights/tracking

Request

  • Base URL: https://stg.wearewarp.com/api/v1
  • URL: https://stg.wearewarp.com/api/v1/freights/tracking
  • Auth: API key in header apikey

Request body

trackingNumbersstring[] required

Shipment tracking numbers, shipment numbers (codes) or order numbers (codes). Unknown values are omitted from the response.

Example request

{
  "trackingNumbers": [
    "2E2EWQATEF8K",
    "S-00524-2635",
    "P-01723-2449"
  ]
}

Response

successful operation

trackingNumberstring

The value from the request that matched this shipment.

orderIdstring
orderNumberstring

The display number (code) of the order.

shipmentIdstring
shipmentNumberstring

The display number (code) of the shipment.

Example response

[
  {
    "trackingNumber": "2E2EWQATEF8K",
    "orderId": "01H3W439G5J5Y282KQFQTAQGTD",
    "orderNumber": "P-01723-2449",
    "shipmentId": "01H3W51F7FEC42MFZAXJQTG4CY",
    "shipmentNumber": "S-00524-2635",
    "statusInfo": {
      "status": "complete"
    },
    "location": {
      "latitude": 37.382544,
      "longitude": -122.035183
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.