Cancels an Order - Spree Commerce documentation

PATCH

api

platform

orders

{id}

cancel

Cancels an Order

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('http://{defaultHost}/api/v2/platform/orders/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "The access token is invalid"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Query Parameters

include

string

Select which associated resources you would like to fetch, see: https://jsonapi.org/format/#fetching-includes

Response

record canceled

Approves an Order

Use Store Credit for an Order

⌘I

Cancels an Order

const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

fetch('http://{defaultHost}/api/v2/platform/orders/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "The access token is invalid"
}