Skip to main content
PATCH
/
customers
/
{id}
Update a customer
curl --request PATCH \
  --url https://api.shoppex.io/dev/v1/customers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "name": "<string>",
  "surname": "<string>",
  "phone": "<string>",
  "phone_country_code": "<string>",
  "country_code": "<string>",
  "street_address": "<string>",
  "additional_address_info": "<string>",
  "city": "<string>",
  "postal_code": "<string>",
  "state": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "shop_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "surname": "<string>",
    "phone": "<string>",
    "phone_country_code": "<string>",
    "country_code": "<string>",
    "street_address": "<string>",
    "additional_address_info": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "<string>",
    "affiliate_revenue": 123,
    "affiliate_revenue_currency": "<string>",
    "affiliate_revenue_percent": 123,
    "customer_balance": 123,
    "customer_balance_currency": "<string>",
    "created_at": 123
  }
}

Authorizations

Authorization
string
header
required

Use your API key with the Bearer scheme. Get your key from Dashboard → Settings → API Keys. Format: Authorization: Bearer shx_...

Path Parameters

id
string
required

Body

application/json
email
string<email>
name
string
Minimum string length: 1
surname
string
Minimum string length: 1
phone
string | null
phone_country_code
string | null
country_code
string | null
Maximum string length: 2
street_address
string | null
additional_address_info
string | null
city
string | null
postal_code
string | null
state
string | null

Response

Default Response

data
object
required