Skip to main content
POST
/
v1
/
ucp
/
orders
/
{id}
/
cancel
Cancel an order
curl --request POST \
  --url https://api.getsly.ai/v1/v1/ucp/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "checkout_id": "<string>",
    "status": "pending",
    "total": "<string>",
    "currency": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "customer_reference": "<string>",
    "tracking": {
      "carrier": "<string>",
      "tracking_number": "<string>"
    }
  },
  "refund_id": "<string>"
}

Authorizations

Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Path Parameters

id
string
required

Body

application/json
reason
string
Maximum string length: 500

Response

200 - application/json

Cancelled

data
object
required
refund_id
string