Skip to main content

Search for Shipment

GET /tms/shipments/search

Description​

This endpoint is used to search for a shipment based on specific criteria. The search can be filtered using tenant and country identifiers, along with a search value.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The code of the country.
  • searchValue (string, query, optional): The value to search for in the shipments.

Responses​

200 OK​

  • Order shipment returned successfully
  • Media Type: Controls Accept header.
  • Example Value:
{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

400 Bad Request​

Order shipment not found

404 Not Found​

Order shipment not found

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

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

RESPONSE

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