Customers
· Revision #3
Update Customer Endpoint
Structure
Customer
Name
|
Type
|
Description
|
Required
|
id |
int |
The id for the customer |
No |
name |
string |
The name of the customer |
No |
email |
string |
The email of the customer |
No |
group |
string |
The group name of the customer |
No |
tax_group |
string |
The tax group name of the customer |
No |
additional_attributes |
array |
The additional attributes of the customer, see Additional Attribute |
No |
Additional Attribute
Name
|
Type
|
Description
|
Required
|
key |
string |
The key of the additional attribute |
Yes |
value |
string |
The value of the additional attribute |
Yes |
Example Request
PUT /api/customers/{id|email}
{
"name": "Test",
"email": "test@gmail.com",
"group": "Group Name",
"additional_attributes": [
{
"key": "last-api-update",
"value": "2023-09-01 09:29:41"
}
]
}
Example Response
{
"customer": {
"id": 1
}
}