Skip to main content

Cancel an order

PUT {{base_url}}/orders/{orderUuid}/cancel

Description​

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

Request​

Request Headers:

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

Path Parameters:

NameDescription
orderUuid(required, path) Order UUID.

Responses:

Status: 200 ok​

Description:

Order cancelled successfully. Response Body Schema (JSON):

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

Example:

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

400 Bad Request Description: Invalid order reference supplied.

404 Not Found Description: Order not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request PUT \ 
 --url  /orders/{orderUuid}/cancel \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

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