Skip to content

Request a cancellation

POST
/api/v1/business/website/orders/cancel/

Submit a cancellation request for a PENDING or CONFIRMED order. The store reviews and approves/rejects it.

Authorizations

apiKey

Your business API key (sb_live_*) — identifies which store the request is for. Required on every /api/v1/business/website/ request.

Type
API Key (header: X-Periscale-Key)
+
shopperToken

The shopper's access token from the shopper authentication endpoints. Required for cart, checkout, orders, and account actions.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"order_id": 0,
  
"reason": "string"
}

Responses

Cancellation request submitted.

application/json
JSON
{
  
"status": true,
  
"status_code": 0,
  
"message": "string",
  
"data": {
  
  
"id": 0,
  
  
"order_id": 0,
  
  
"status": "string",
  
  
"reason": "string",
  
  
"created_at": "string"
  
}
}

Playground

Server
Authorization
Body

Samples

Powered by VitePress OpenAPI

© Periscale