GET /tracking-events/{id}.json

GET /tracking-events/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • • 200

    Successful response

    Hide response attributes Show response attributes object
    • actionRequired boolean | null

      Action required

    • city string | null

      City

    • country string | null

      Country

    • createdAt string(date-time)

      Created at

    • details string | null

      Details

    • externalId string | null

      External

    • id integer(int32)

      Id

    • purchaseInvoiceId integer(int32) | null

      Purchase invoice

    • state string | null

      State

    • status string | null

      Status

      Values are pre_transit, transit, delivered, returned, failure, or unknown.

    • statusAt string(date-time) Required

      Status at

    • subStatus string | null

      Sub status

      Values are information_received, address_issue, contact_carrier, delayed, delivery_attempted, delivery_rescheduled, delivery_scheduled, location_inaccessible, notice_left, out_for_delivery, package_accepted, package_arrived, package_damaged, package_departed, package_forwarded, package_held, package_processed, package_processing, pickup_available, reschedule_delivery, delivered, return_to_sender, package_unclaimed, package_undeliverable, package_disposed, package_lost, or other.

    • transactionId integer(int32) Required

      Transaction

    • updatedAt string(date-time)

      Updated at

    • zip string | null

      Zip
GET /tracking-events/{id}.json 
curl \
 -X GET http://api.example.com/v1/tracking-events/{id}.json
Response examples (200) 
{
  "actionRequired": true,
  "city": "string",
  "country": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "details": "string",
  "externalId": "string",
  "id": 42,
  "purchaseInvoiceId": 42,
  "state": "string",
  "status": "pre_transit",
  "statusAt": "2023-05-04T09:42:00+00:00",
  "subStatus": "information_received",
  "transactionId": 42,
  "updatedAt": "2023-05-04T09:42:00+00:00",
  "zip": "string"
}