Skip to main content

Get Shipment Details

GET /tms/shipments/{uuid}

Description​

This endpoint retrieves the details of a specific shipment using its unique identifier (UUID).

Parameters​

  • tenantId (string, header, required): The tenant's unique identifier.
  • countryCode (string, header, required): The country code where the request is being made.
  • uuid (string, path, required): The unique identifier of the shipment.

Responses​

Success Response (200)​

The Success Response (200) is returned when the shipment details are successfully retrieved. This response indicates the success of the operation and provides additional details.

Response Fields​

FieldTypeDescription
statusbooleanIndicates the success of the shipment details retrieval.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains the shipment details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example Value​

{
  "status": true,
  "statusCode": 0,
  "message": "Found the Shipment",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Error Responses​

####Invalid Shipment ID (400)

The Invalid Shipment ID (400) response is returned when an invalid shipment ID reference is supplied.

Resource Not Found (404)​

The Resource Not Found (404) response is returned when the specified shipment is not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/shipments/{uuid} \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!