COconvoy
loads

Get Load

Retrieve a load by its external identifier.

get/loads/{externalId}

Request

  • Base URL
    https://demo-developer.convoy.com/broker
  • Auth
    HTTP bearer

Path parameters

externalIdstring required

The broker-assigned external identifier for the load. Format is broker-defined. Must be URL-encoded per RFC 3986 when the value contains spaces or special characters.

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Response

The request has succeeded.

externalIdstring required

The broker-assigned external identifier for the load.

syncStatus'QUEUED' | 'COMPLETED' | 'FAILED' required

The current sync status of the load. This reflects live state and may differ from the last webhook emission, which captures point-in-time status.

StatusDescription
QUEUEDA submission is in-flight and has not yet resolved.
COMPLETEDThe most recent submission was processed successfully.
FAILEDThe most recent submission was rejected.
postingStatus'AVAILABLE' | 'PENDING' | 'CANCELED' | 'COVERED' nullable required

The current posting status of the load, or null if not yet determined.

updatedAtstring date-time required

ISO 8601 timestamp of the last event that affected this load.

Changes

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