Endpoints Reference
Customer
Create/update a customer
PUT
/v1/{siteEnv}/{siteId}/customers
PATH PARAMETERS
siteEnv
string
*Example: live
siteId
string
*Example: bobs-store
BODY PARAMETERS
body
object
*email
string<email>
*Example: bob@sparklayer.io
first_name
string
*Example: Bob
last_name
string
*Example: Jones
company_name
string
Example: Tom Jones Climbing Ltd
sales_agent_groups
string[]
Example: ["group-1"]
price_lists
string[]
Example: ["25-off"]
customer_discount_percentage
number
Example: 25
group
string
Example: 50-off
role
string<main | limited-customer>
Example: limited-customer
RESPONSES
201
Successful operation
object
customer_external_id
string
Example: CU1234
Platform ID of Customer
401
Auth Failure
500
System Exception