Knowledge Base

Order (cancel)

TEST environment

POST

/dre/order-cancel

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://dre2.yourdomain.com/a2/test/dre/order-cancel?id=' \
--header 'X-Dre-Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "unique_id": "123465",
    "detail": {
        "reason": "Payment failure",
        "event_timestamp": 1709810452000
    }
}'

Response Example

200 - Success

{
  "result": "ok",
  "detail": [
    "Received. This has been processed"
  ]
}

Request

Query Params

string

required

Your script ID. Will be provided by DATA Reshape Team

Default:

Match pattern:

^[A-Z0-9]{8}$

Header Params

Content-Type

string

required

Default:

application/json

X-Dre-Access-Token

string

required

Your secret access token. Will be provided by DATA Reshape Team

Default:

Body Params application/json

unique_id

string

required

The unique identifier of a transaction.

>= 3 characters

Examples:

123465abcdef

Match pattern:

^[a-zA-Z0-9_-]{3,}$

detail

object

required

reason

string

optional

The reason for cancelling the order

Example:

Payment failure

Match pattern:

^[\w\d\s\.-_]+$

event_timestamp

integer

required

A Unix timestamp (in milliseconds) for the time to associate with the event.

>= 1709810452000

Example:

1709810452000

Examples

Responses

🟢200Success

application/json

Body

result

string

required

>= 3 characters

detail

array[string]

required

🟠405Bad Request

Modified at 2024-03-07 11:21:24

Order (create)

Lead (create)