Cancel a purchase order

const options = { method: 'PATCH', headers: { 'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: JSON.stringify({reason: 'Supplier went under'}) }; fetch('http://{defaultHost}/api/v3/admin/purchase_orders/{id}/cancel', options) .then(res => res.json()) .then(res => console.log(res)) .catch(err => console.error(err));

{ "id": "po_UkLWZg9DAJ", "number": "PO1001", "status": "canceled", "currency": "USD", "reference": null, "notes": "Supplier went under", "metadata": {}, "close_reason": null, "items_count": 1, "quantity_received_total": 0, "quantity_rejected_total": 0, "ordered_at": null, "received_at": null, "closed_short_at": null, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z", "expected_at": "2026-10-01", "cancel_by": null, "closed_short": false, "quantity_ordered_total": 100, "editable": false, "subtotal": "1250.00", "supplier_id": "sup_UkLWZg9DAJ", "destination_location_id": "sloc_UkLWZg9DAJ" }

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Bearer token for admin authentication

Path Parameters

string

required

Purchase order ID

Body

application/json

reason

string

Appended to the order's notes.

Example:

"Supplier went under"

Response

200 - application/json

purchase order cancelled

string

required

number

string

required

status

string

required

currency

enum<string>

required

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BYR,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EEK,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LTL,

LVL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRO,

MRU,

MTL,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SKK,

SLE,

SLL,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMM,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYI,

UYU,

UYW,

UZS,

VED,

VEF,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XCG,

XOF,

XPF,

YER,

ZAR,

ZMK,

ZMW,

ZWD,

ZWG,

ZWL,

ZWN,

ZWR

reference

string | null

required

notes

string | null

required

metadata

object

required

close_reason

string | null

required

items_count

number

required

quantity_received_total

number

required

quantity_rejected_total

number

required

ordered_at

string | null

required

received_at

string | null

required

closed_short_at

string | null

required

created_at

string

required

updated_at

string

required

expected_at

string | null

required

cancel_by

string | null

required

closed_short

boolean

required

quantity_ordered_total

number

required

editable

boolean

required

subtotal

string

required

supplier_id

string | null

required

destination_location_id

string | null

required

items

object[]

Show child attributes

stock_receipts

object[]

Show child attributes

supplier

object

Show child attributes

destination_location

object

Show child attributes

API basics

Endpoints

Authorizations

Headers

Path Parameters

Body

Response