API Reference

Consignment Tracking

Manage tracking information for consignments. Tracking records capture carrier status updates, tracking numbers, and URLs for shipment monitoring.

Endpoints Overview

Method Endpoint Description
GET /v1/consignments/{consignmentId}/tracking Get tracking records
POST /v1/consignments/{consignmentId}/tracking Create tracking record
PUT /v1/consignments/{consignmentId}/tracking/{consignmentTrackingId} Update tracking record
GET /v1/consignments/{consignmentId}/tracking/{consignmentTrackingId} Get specific tracking record and events
POST /v1/consignments/{consignmentId}/tracking/{consignmentTrackingId}/event Create tracking event

Get Tracking Records

Retrieve all tracking records for a consignment.

Endpoint: GET /v1/consignments/{consignmentId}/tracking

Path Parameters

Parameter Type Required Description
consignmentId uuid Yes The consignment ID

Query Parameters

Parameter Type Required Description
PageIndex integer No Page number (default: 1)
PageSize integer No Items per page (default: 25, max: 500)
SearchText string No Filter results by search text

Request Example 

curl -X GET "https://api.consignlyhq.com/v1/consignments/550e8400-e29b-41d4-a716-446655440000/tracking" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example 

{
  "index": 1,
  "total": 2,
  "consignmentTracking": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440600",
      "carrierName": "Fast Freight Co",
      "status": 2,
      "trackingNumber": "FF123456789",
      "trackingUrl": "https://fastfreight.com/track/FF123456789",
      "integrationName": "Fast Freight Integration",
      "createdUtc": "2024-01-18T09:00:00Z",
      "modifiedUtc": "2024-01-19T14:30:00Z",
      "lastUpdatedDate": "2024-01-19"
    }
  ]
}

Tracking Status Values

Value Status Description
0 Unknown Status unknown
1 Printed Label printed
2 Dispatched Shipment dispatched
3 InTransit Shipment is in transit
4 OutForDelivery Shipment is out for delivery
5 Delivered Shipment has been delivered
6 PickupInStore Available for pickup in store
7 AttemptedDelivery Delivery attempt made
8 Exception Exception/issue with delivery
9 AwaitingCollection Awaiting collection
10 Cancelled Shipment cancelled
11 Manifested Shipment manifested with carrier

Create Tracking Record

Add a new tracking record to a consignment.

Endpoint: POST /v1/consignments/{consignmentId}/tracking

Path Parameters

Parameter Type Required Description
consignmentId uuid Yes The consignment ID

Request Body 

{
  "carrierName": "Fast Freight Co",
  "status": 1,
  "trackingNumber": "FF123456789",
  "trackingUrl": "https://fastfreight.com/track/FF123456789"
}
Field Type Required Description
carrierName string No Name of the carrier
status integer No Tracking status (see values above)
trackingNumber string No Carrier tracking number
trackingUrl string No URL to track shipment

Request Example 

curl -X POST "https://api.consignlyhq.com/v1/consignments/550e8400-e29b-41d4-a716-446655440000/tracking" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "carrierName": "Fast Freight Co",
    "status": 1,
    "trackingNumber": "FF123456789",
    "trackingUrl": "https://fastfreight.com/track/FF123456789"
  }'

Response Example

Status: 200 OK

{
  "consignmentTrackingId": "550e8400-e29b-41d4-a716-446655440600"
}

Update Tracking Record

Update an existing tracking record.

Endpoint: PUT /v1/consignments/{consignmentId}/tracking/{consignmentTrackingId}

Path Parameters

Parameter Type Required Description
consignmentId uuid Yes The consignment ID
consignmentTrackingId uuid Yes The tracking record ID

Request Body 

{
  "carrierName": "Fast Freight Co",
  "status": 2,
  "trackingNumber": "FF123456789",
  "trackingUrl": "https://fastfreight.com/track/FF123456789"
}

Request Example 

curl -X PUT "https://api.consignlyhq.com/v1/consignments/550e8400-e29b-41d4-a716-446655440000/tracking/550e8400-e29b-41d4-a716-446655440600" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": 2
  }'

Response

Status Description
200 Tracking record updated
304 Not modified

Tracking in Consignment Detail

Tracking records are included in the consignment detail response:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "consignmentTracking": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440600",
      "carrierName": "Fast Freight Co",
      "status": 2,
      "trackingNumber": "FF123456789",
      "trackingUrl": "https://fastfreight.com/track/FF123456789"
    }
  ]
}

Get Specific Tracking Record and Events

Retrieve a specific tracking record for a consignment, along with its events.

Endpoint: GET /v1/consignments/{consignmentId}/tracking/{consignmentTrackingId}

Path Parameters

Parameter Type Required Description
consignmentId uuid Yes The consignment ID
consignmentTrackingId uuid Yes The tracking ID

Request Example 

curl -X GET "https://api.consignlyhq.com/v1/consignments/550e8400-e29b-41d4-a716-446655440000/tracking/550e8400-e29b-41d4-a716-446655440601" \
  -H "Authorization: Bearer ACCESS_TOKEN"

Response Example 

{
  "carrierName": "Last Mile Delivery",
  "status": 2,
  "trackingNumber": "LMD987654321",
  "trackingUrl": "https://lastmile.com/track/LMD987654321",
  "integrationName": "Last Mile",
  "createdUtc": "2026-03-08T23:35:10Z",
  "modifiedUtc": "2026-03-09T23:40:11Z",
  "lastUpdatedDate": "2026-03-09",
  "trackingEvents": [
    {
      "status": 1,
      "details": "Labels printed",
      "eventDateTime": "2026-03-08T23:35:10Z",
      "createdUtc": "2026-03-08T23:35:10Z"
    },
    {
      "status": 2,
      "details": "With courier",
      "eventDateTime": "2026-03-09T23:40:11Z",
      "createdUtc": "2026-03-09T23:40:11Z"
    }
  ]
}

Tracking Status Values

Value Status Description
0 Unknown Status unknown
1 Printed Label printed
2 Dispatched Shipment dispatched
3 InTransit Shipment is in transit
4 OutForDelivery Shipment is out for delivery
5 Delivered Shipment has been delivered
6 PickupInStore Available for pickup in store
7 AttemptedDelivery Delivery attempt made
8 Exception Exception/issue with delivery
9 AwaitingCollection Awaiting collection
10 Cancelled Shipment cancelled
11 Manifested Shipment manifested with carrier

Create Tracking Events for a Record

Create a new event for a tracking record for a consignment.

Endpoint: POST /v1/consignments/{consignmentId}/tracking/{consignmentTrackingId}/event

Path Parameters

Parameter Type Required Description
consignmentId uuid Yes The consignment ID
consignmentTrackingId uuid Yes The tracking ID

Request Example 

curl -X POST "https://api.consignlyhq.com/v1/consignments/550e8400-e29b-41d4-a716-446655440000/tracking/550e8400-e29b-41d4-a716-446655440601/event" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
      "carrierName": "Last Mile Delivery",
      "status": 4,
      "details": "On its way!"
    }'

Response

Status Description
200 Tracking event record created
304 Not modified

Related Endpoints

Previous
Consignment Tasks
Next
Consumable Types