Skip to main content
PATCH
Spree Admin SDK

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

Path Parameters

customer_id
string
required
id
string
required

Body

application/json
kind
string

The registration the number belongs to, such as eu_vat or gb_vat. Any kind is accepted; one with a registered validator is checked by it. Built-in: eu_vat. Extensions may register more.

Example:

"gb_vat"

value
string
Example:

"GB123456789"

Response

200 - application/json

registration updated

id
string
required
kind
string
required

Tax identifier kind, keyed to a registered validator. Built-in: eu_vat. Extensions may register more.

value
string
required
validation_status
enum<string> | null
required
Available options:
pending,
verified,
unverified,
unavailable,
unsupported
validation_evidence
object | null
required
source
enum<string> | null
required
Available options:
override,
company,
customer
validated_at
string | null
required
created_at
string
required
updated_at
string
required
validatable
boolean
required
customer_id
string | null
required
cart_id
string | null
required
order_id
string | null
required