Skip to content

Change the account

PATCH
/storefront/sites/{host}/account
curl --request PATCH \
--url https://example.com/storefront/sites/northgate.shop.getbottle.app/account \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "marketingConsent": true, "locale": "en-GB" }'

Deliberately without a staff session: a shopper on the business’s own shop. Its name, the old single marketing switch, and its language. A language is the shop’s and the account’s own emails’, and is given to every customer this account manages, so their order, delivery and invoice emails come in it too.

host
required
string

Example

northgate.shop.getbottle.app
Media typeapplication/json
object
name
string
>= 1 characters <= 120 characters
marketingConsent
boolean
locale

A language: en-GB English, ar Arabic, ur Urdu, pa Punjabi (Gurmukhi), hi Hindi, bn Bengali, gu Gujarati, zh-Hans Chinese (Simplified), pl Polish, ro Romanian, es Spanish, fr French, de German.

string | null
Allowed values: en-GB ar ur pa hi bn gu zh-Hans pl ro es fr de

The account

Media typeapplication/json
object
name
required
string
email
required
string
emailVerified
required
boolean
twoFactor
required
boolean
hasPin
required
boolean
marketingConsent
boolean
locale

A language: en-GB English, ar Arabic, ur Urdu, pa Punjabi (Gurmukhi), hi Hindi, bn Bengali, gu Gujarati, zh-Hans Chinese (Simplified), pl Polish, ro Romanian, es Spanish, fr French, de German.

string | null
Allowed values: en-GB ar ur pa hi bn gu zh-Hans pl ro es fr de
customers
required
Array<object>
object
id
required

UUID v7

string format: uuid
name
required
string
kind
required
string
Allowed values: domestic commercial
paymentTerms
required
string | null
canPayOnAccount
required
boolean
trade
required
boolean
role
required
string
Allowed values: manager buyer accounts
canOrder
required
boolean
addresses
required
Array<object>
object
id
required

UUID v7

string format: uuid
customerId
required

UUID v7

string format: uuid
label
required
string
line1
required
string
line2
required
string | null
city
required
string | null
postcode
required
string | null
tradeApplication
required
object
status
required
string
Allowed values: none pending approved declined
reason
required
string | null
submittedAt
required
string | null format: date-time

Example

{
"locale": "en-GB",
"customers": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"kind": "domestic",
"role": "manager"
}
],
"addresses": [
{
"id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"customerId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}
],
"tradeApplication": {
"status": "none"
}
}

Refused: the message says why

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not from the shop itself, or the email is not confirmed yet

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not a shop. No body.

A real shop not selling now (shop_closed)

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}

Too many tries

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}