Consignments

Get Consignment

get/consignments/{consignmentId}

Request

  • Base URL: https://api.reelables.com/v1
  • URL: https://api.reelables.com/v1/consignments/{consignmentId}
  • Auth: OAuth 2 (client credentials, token URL https://auth.reelables.com/oauth2/token, scopes: https://auth.reelables.com/full-access)

Path parameters

consignmentIdstring required

The identifier of the Consignment

Headers

request-idstring

Unique identifier for the API request. Example: f7ecf495-ca1c-4468-a6c2-6ee3f723fa00

Response

200 response

trackingRefstring required

The tracking reference that identifies the Consignment in the user system

idstring uuid required

Unique identifier of the Consignment. Example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'

isActiveboolean

Indicates whether the Consignment is actively being tracked

Changes

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