Cancel order

curl --request POST \
  --url https://api.maple.inc/v1/orders/{orderId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "object": "order_decision",
  "order_id": "<string>",
  "status": "received"
}

Authorizations

Authorization

string

header

required

API key — mpk_test_… for the sandbox, mpk_live_… for production. Issued by Maple during partner onboarding.

Path Parameters

orderId

string

required

Body

application/json

reason

string | null

Minimum string length: 1

Pattern: ^\S[\s\S]*\S$|^\S$|^$

Response

Success

object

enum<string>

required

Available options:

order_decision

order_id

string

required

decision

enum<string>

required

Available options:

accept,

deny,

ready,

complete,

cancel,

status

status

enum<string>

required

Available options:

received

Update order statusPartner reports an order status transition (e.g. ready, in delivery, fulfilled).

⌘I

Cancel order

curl --request POST \
  --url https://api.maple.inc/v1/orders/{orderId}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "<string>"
}
'

{
  "object": "order_decision",
  "order_id": "<string>",
  "status": "received"
}