Update order

PUT {{base_url}}/orders?orderUuid

Description

This API endpoint updates an existing order specified by its unique identifier (orderUuid).

Request

Request Headers:

Name	Description
tenantId	(required, header) The tenant ID associated with the request.
countryCode	(required, header) The country code associated with the request.

Path Parameters:

Name	Description
orderUuid	(required, path) Order UUID.

Request Body Schema (JSON):

{
  "dropoffLocationName": "string",
  "dropoffContactPhoneNumber": "string",
  "dropoffContactName": "string",
  "dropoffContactEmail": "string",
  "dropoffLocationNameMore": "string",
  "dropoffLatitude": "string",
  "dropoffLongitude": "string",
  "weight": "string",
  "pickupLocationName": "string",
  "pickupContactPhoneNumber": "string",
  "pickupContactName": "string",
  "pickupContactEmail": "string",
  "pickupLocationNameMore": "string",
  "pickupLatitude": "string",
  "pickupLongitude": "string",
  "items": [
    {
      "name": "string",
      "price": 0,
      "width": 0,
      "weight": 0,
      "length": 0,
      "height": 0,
      "quantity": 0
    }
  ]
}

Example:

<orderUpdateRequest>
  <dropoffLocationName>string</dropoffLocationName>
  <dropoffContactPhoneNumber>string</dropoffContactPhoneNumber>
  <dropoffContactName>string</dropoffContactName>
  <dropoffContactEmail>string</dropoffContactEmail>
  <dropoffLocationNameMore>string</dropoffLocationNameMore>
  <dropoffLatitude>string</dropoffLatitude>
  <dropoffLongitude>string</dropoffLongitude>
  <weight>string</weight>
  <pickupLocationName>string</pickupLocationName>
  <pickupContactPhoneNumber>string</pickupContactPhoneNumber>
  <pickupContactName>string</pickupContactName>
  <pickupContactEmail>string</pickupContactEmail>
  <pickupLocationNameMore>string</pickupLocationNameMore>
  <pickupLatitude>string</pickupLatitude>
  <pickupLongitude>string</pickupLongitude>
  <items>
    <item>
      <name>string</name>
      <price>0</price>
      <width>0</width>
      <weight>0</weight>
      <length>0</length>
      <height>0</height>
      <quantity>0</quantity>
    </item>
  </items>
</orderUpdateRequest>

Responses:

Status: 200 OK Description: Order updated successfully.

Response Body Schema (JSON):

{
  "status": "boolean",
  "statusCode": "integer",
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

Example:

<orderUpdateResponse>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</orderUpdateResponse>

400 Bad Request Description: Invalid order UUID provided.

404 Not Found Description: Order not found.

Query Params

Param	value
orderUuid	null