Update a supplier - Spree Commerce documentation

Spree Admin SDK

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

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

const supplier = await client.suppliers.update('sup_1234567890', {
  contact_name: 'Jordan Lee',
  email: 'orders@acme-supply.com',
  phone: '+1 555 0100',
})

{
  "id": "sup_UkLWZg9DAJ",
  "name": "Acme Wholesale",
  "contact_name": "Sam Reyes",
  "email": "supplier23@example.com",
  "phone": "555-0100",
  "notes": null,
  "address1": "1 Warehouse Way",
  "address2": null,
  "city": "Brooklyn",
  "state_name": null,
  "state_code": "NY",
  "country_code": "US",
  "postal_code": "11201",
  "purchase_orders_count": 0,
  "metadata": {},
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "deleted_at": null,
  "can_be_deleted": true
}

PATCH

/

api

/

v3

/

admin

/

suppliers

/

{id}

Spree Admin SDK

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

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

const supplier = await client.suppliers.update('sup_1234567890', {
  contact_name: 'Jordan Lee',
  email: 'orders@acme-supply.com',
  phone: '+1 555 0100',
})

{
  "id": "sup_UkLWZg9DAJ",
  "name": "Acme Wholesale",
  "contact_name": "Sam Reyes",
  "email": "supplier23@example.com",
  "phone": "555-0100",
  "notes": null,
  "address1": "1 Warehouse Way",
  "address2": null,
  "city": "Brooklyn",
  "state_name": null,
  "state_code": "NY",
  "country_code": "US",
  "postal_code": "11201",
  "purchase_orders_count": 0,
  "metadata": {},
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "deleted_at": null,
  "can_be_deleted": true
}

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

id

string

required

Supplier ID

Body

application/json

name

string

Example:

"Northwind Trading"

contact_name

string | null

Example:

"Dana Okafor"

email

string | null

Example:

"sales@northwind.test"

phone

string | null

Example:

"555-0100"

notes

string | null

address1

string | null

Example:

"1 Warehouse Way"

address2

string | null

city

string | null

Example:

"Brooklyn"

state_name

string | null

state_code

string | null

Example:

"NY"

country_code

enum<string> | null

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AR,

AS,

AT,

AU,

AW,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GT,

GU,

GW,

GY,

HK,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

Example:

"US"

postal_code

string | null

Example:

"11201"

metadata

object | null

Response

200 - application/json

supplier updated

id

string

required

name

string

required

contact_name

string | null

required

email

string | null

required

phone

string | null

required

notes

string | null

required

address1

string | null

required

address2

string | null

required

city

string | null

required

state_name

string | null

required

state_code

string | null

required

country_code

enum<string> | null

required

Available options:

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AO,

AR,

AS,

AT,

AU,

AW,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CR,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DJ,

DK,

DM,

DO,

DZ,

EC,

EE,

EG,

ER,

ES,

ET,

FI,

FJ,

FK,

FM,

FO,

FR,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GT,

GU,

GW,

GY,

HK,

HN,

HR,

HT,

HU,

ID,

IE,

IL,

IM,

IN,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SV,

SX,

SY,

SZ,

TC,

TD,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

YE,

YT,

ZA,

ZM,

ZW

postal_code

string | null

required

purchase_orders_count

number

required

metadata

object

required

created_at

string

required

updated_at

string

required

deleted_at

string | null

required

can_be_deleted

boolean

required

⌘I