Get a purchase order

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const purchaseOrder = await client.purchaseOrders.get('po_1234567890', {
  expand: ['items', 'supplier'],
})

{
  "id": "po_UkLWZg9DAJ",
  "number": "PO1001",
  "status": "draft",
  "currency": "USD",
  "reference": null,
  "notes": null,
  "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": true,
  "subtotal": "1250.00",
  "supplier_id": "sup_UkLWZg9DAJ",
  "destination_location_id": "sloc_UkLWZg9DAJ",
  "items": [
    {
      "id": "poi_UkLWZg9DAJ",
      "quantity_ordered": 100,
      "quantity_received": 0,
      "quantity_rejected": 0,
      "quantity_over": 0,
      "outstanding": 100,
      "currency": "USD",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "unit_cost": "12.50",
      "total_cost": "1250.00",
      "purchase_order_id": "po_UkLWZg9DAJ",
      "variant_id": "variant_gbHJdmfrXB",
      "product_id": "prod_UkLWZg9DAJ",
      "variant_name": "Product 1639018",
      "variant_sku": "SKU-198",
      "options_text": "Size: S",
      "thumbnail_url": null
    }
  ],
  "supplier": {
    "id": "sup_UkLWZg9DAJ",
    "name": "Acme Wholesale",
    "contact_name": "Dana Okafor",
    "email": "supplier7@example.com",
    "phone": "555-0100",
    "notes": null,
    "address1": null,
    "address2": null,
    "city": null,
    "state_name": null,
    "state_code": null,
    "country_code": null,
    "postal_code": null,
    "purchase_orders_count": 1,
    "metadata": {},
    "created_at": "2026-01-15T12:00:00.000Z",
    "updated_at": "2026-01-15T12:00:00.000Z",
    "deleted_at": null,
    "can_be_deleted": false
  }
}

{
  "error": {
    "code": "record_not_found",
    "message": "Purchase order not found"
  }
}

GET

api

admin

purchase_orders

{id}

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const purchaseOrder = await client.purchaseOrders.get('po_1234567890', {
  expand: ['items', 'supplier'],
})

{
  "id": "po_UkLWZg9DAJ",
  "number": "PO1001",
  "status": "draft",
  "currency": "USD",
  "reference": null,
  "notes": null,
  "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": true,
  "subtotal": "1250.00",
  "supplier_id": "sup_UkLWZg9DAJ",
  "destination_location_id": "sloc_UkLWZg9DAJ",
  "items": [
    {
      "id": "poi_UkLWZg9DAJ",
      "quantity_ordered": 100,
      "quantity_received": 0,
      "quantity_rejected": 0,
      "quantity_over": 0,
      "outstanding": 100,
      "currency": "USD",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z",
      "unit_cost": "12.50",
      "total_cost": "1250.00",
      "purchase_order_id": "po_UkLWZg9DAJ",
      "variant_id": "variant_gbHJdmfrXB",
      "product_id": "prod_UkLWZg9DAJ",
      "variant_name": "Product 1639018",
      "variant_sku": "SKU-198",
      "options_text": "Size: S",
      "thumbnail_url": null
    }
  ],
  "supplier": {
    "id": "sup_UkLWZg9DAJ",
    "name": "Acme Wholesale",
    "contact_name": "Dana Okafor",
    "email": "supplier7@example.com",
    "phone": "555-0100",
    "notes": null,
    "address1": null,
    "address2": null,
    "city": null,
    "state_name": null,
    "state_code": null,
    "country_code": null,
    "postal_code": null,
    "purchase_orders_count": 1,
    "metadata": {},
    "created_at": "2026-01-15T12:00:00.000Z",
    "updated_at": "2026-01-15T12:00:00.000Z",
    "deleted_at": null,
    "can_be_deleted": false
  }
}

{
  "error": {
    "code": "record_not_found",
    "message": "Purchase order not found"
  }
}

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

Query Parameters

expand

string

Comma-separated associations to embed: items, supplier, destination_location

Response

purchase order found

string

required

number

string

required

status

required

The values listed are the built-in ones; extensions may add more.

Available options:

draft,

ordered,

partially_received,

received,

over_received,

canceled

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

⌘I

API basics

Endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Response