Get single delivery order

GET {{base_url}}/delivery-orders/{deliveryOrderUuid}

Description

This API endpoint retrieves information about a specific delivery order based on its unique identifier. The request requires the tenant ID, country code, and the delivery order UUID.

Request

Headers:

Name	Description
tenantId	The identifier for the tenant.
countryCode	The country code for the delivery order.

Path Parameters:

Name	Description
deliveryOrderUuid	The unique identifier of the delivery order to find.

Response

200 OK: Description:

Indicates that the delivery order has been found. Example

{
  "status": true,
  "statusCode": 0,
  "message": "Delivery order found.",
  "data": {
    // Delivery order information
  },
  "errors": []
}

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>Delivery order found.</message>
  <data>
    <!-- Delivery order information -->
  </data>
  <errors></errors>
</response>

400 Bad Request:

Example

{
  "status": false,
  "statusCode": 400,
  "message": "Invalid delivery order ID reference supplied.",
  "errors": [
    {
      "message": "Invalid delivery order ID reference supplied.",
      "descriptiveMessage": "The provided delivery order ID reference is not valid. Please ensure correct values are supplied."
    }
  ]
}

<response>
  <status>false</status>
  <statusCode>400</statusCode>
  <message>Invalid delivery order ID reference supplied.</message>
  <errors>
    <error>
      <message>Invalid delivery order ID reference supplied.</message>
      <descriptiveMessage>The provided delivery order ID reference is not valid. Please ensure correct values are supplied.</descriptiveMessage>
    </error>
  </errors>
</response>

404 Not Found:

{
  "status": false,
  "statusCode": 404,
  "message": "Delivery order not found.",
  "errors": [
    {
      "message": "Delivery order not found.",
      "descriptiveMessage": "The specified delivery order could not be found."
    }
  ]
}

<response>
  <status>false</status>
  <statusCode>404</statusCode>
  <message>Delivery order not found.</message>
  <errors>
    <error>
      <message>Delivery order not found.</message>
      <descriptiveMessage>The specified delivery order could not be found.</descriptiveMessage>
    </error>
  </errors>
</response>