Cancel an order (only while it is awaiting payment)

curl --request POST \
  --url https://api.example.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Ordered the wrong size"
}
'

import requests

url = "https://api.example.com/v1/orders/{id}/cancel"

payload = { "reason": "Ordered the wrong size" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Ordered the wrong size'})
};

fetch('https://api.example.com/v1/orders/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/orders/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Ordered the wrong size'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/orders/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"Ordered the wrong size\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/orders/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Ordered the wrong size\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orders/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Ordered the wrong size\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "orderNumber": "<string>",
  "date": "<string>",
  "status": "PENDING_PAYMENT",
  "type": "RETAIL",
  "items": [
    {
      "productId": "<string>",
      "productName": "<string>",
      "quantity": 123,
      "price": 123,
      "productImage": "<string>",
      "sizeId": "<string>",
      "variantName": "<string>",
      "sizeLabel": "<string>",
      "sku": "<string>",
      "size": "<string>"
    }
  ],
  "bundles": [
    {
      "id": "<string>",
      "bundleId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "lineTotal": 123,
      "components": [
        {
          "productId": "<string>",
          "sizeId": "<string>",
          "productName": "<string>",
          "variantName": "<string>",
          "sizeLabel": "<string>",
          "sku": "<string>",
          "quantity": 123
        }
      ],
      "image": "<string>"
    }
  ],
  "subtotalAmount": 123,
  "deliveryAmount": 123,
  "rewardAmount": 123,
  "pointsRedeemed": 123,
  "discountAmount": 123,
  "discounts": [
    {
      "discountId": "<string>",
      "name": "Summer 10% off",
      "type": "PERCENTAGE",
      "amount": 4.5
    }
  ],
  "totalAmount": 123,
  "deliveryInfo": {
    "deliveryMethod": "STANDARD_DELIVERY",
    "recipientName": "<string>",
    "recipientContact": "<string>",
    "recipientAddress": "<string>",
    "preferredLogisticsProvider": "DPD",
    "logisticsProvider": "DPD",
    "courierTrackingNumber": "<string>"
  },
  "orderInfo": {
    "paymentMethod": "STRIPE",
    "orderNo": "<string>",
    "orderDate": "<string>"
  }
}

POST

orders

{id}

cancel

Cancel an order (only while it is awaiting payment)

curl --request POST \
  --url https://api.example.com/v1/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Ordered the wrong size"
}
'

import requests

url = "https://api.example.com/v1/orders/{id}/cancel"

payload = { "reason": "Ordered the wrong size" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Ordered the wrong size'})
};

fetch('https://api.example.com/v1/orders/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/orders/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Ordered the wrong size'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/orders/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"Ordered the wrong size\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/orders/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Ordered the wrong size\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/orders/{id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Ordered the wrong size\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "orderNumber": "<string>",
  "date": "<string>",
  "status": "PENDING_PAYMENT",
  "type": "RETAIL",
  "items": [
    {
      "productId": "<string>",
      "productName": "<string>",
      "quantity": 123,
      "price": 123,
      "productImage": "<string>",
      "sizeId": "<string>",
      "variantName": "<string>",
      "sizeLabel": "<string>",
      "sku": "<string>",
      "size": "<string>"
    }
  ],
  "bundles": [
    {
      "id": "<string>",
      "bundleId": "<string>",
      "name": "<string>",
      "quantity": 123,
      "unitPrice": 123,
      "lineTotal": 123,
      "components": [
        {
          "productId": "<string>",
          "sizeId": "<string>",
          "productName": "<string>",
          "variantName": "<string>",
          "sizeLabel": "<string>",
          "sku": "<string>",
          "quantity": 123
        }
      ],
      "image": "<string>"
    }
  ],
  "subtotalAmount": 123,
  "deliveryAmount": 123,
  "rewardAmount": 123,
  "pointsRedeemed": 123,
  "discountAmount": 123,
  "discounts": [
    {
      "discountId": "<string>",
      "name": "Summer 10% off",
      "type": "PERCENTAGE",
      "amount": 4.5
    }
  ],
  "totalAmount": 123,
  "deliveryInfo": {
    "deliveryMethod": "STANDARD_DELIVERY",
    "recipientName": "<string>",
    "recipientContact": "<string>",
    "recipientAddress": "<string>",
    "preferredLogisticsProvider": "DPD",
    "logisticsProvider": "DPD",
    "courierTrackingNumber": "<string>"
  },
  "orderInfo": {
    "paymentMethod": "STRIPE",
    "orderNo": "<string>",
    "orderDate": "<string>"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Body

application/json

reason

string

Example:

"Ordered the wrong size"

Response

200 - application/json

string

required

orderNumber

string

required

date

string

required

status

enum<string>

required

Available options:

PENDING_PAYMENT,

CONFIRMED,

PROCESSING,

DISPATCHED,

DELIVERED,

CANCELLED,

REFUNDED

type

enum<string>

required

Available options:

RETAIL,

TRADE

items

object[]

required

Show child attributes

bundles

object[]

required

Bundle packages bought, each at its bundle price

Show child attributes

subtotalAmount

number

required

Items + bundles

deliveryAmount

number

required

rewardAmount

number

required

What loyalty points took off

pointsRedeemed

number

required

Loyalty points spent on this order

discountAmount

number

required

Taken off the subtotal by the discount applied at checkout

discounts

object[]

required

The discount(s) behind discountAmount — at most one today

Show child attributes

totalAmount

number

required

deliveryInfo

object

required

Show child attributes

orderInfo

object

required

Show child attributes

Auth & Account

Catalogue

Inventory (Admin)

Orders & Cart

Payments & Webhooks

Notifications, Loyalty & Campaigns

Admin

Cancel an order (only while it is awaiting payment)

Authorizations

Path Parameters

Body

Response