Price Lists
· Revision #2
Update Price List
Structure
Price List
Name
|
Type
|
Description
|
Required
|
name |
string |
The name of the price list |
No |
applies_to |
string |
The applies to of the price list (everyone, not-customers, customers, groups) |
No |
start_at |
timestamp |
The start at of the price list |
No |
end_at |
timestamp |
The end at of the price list |
No |
customer_groups |
array |
An array of Customer Group objects (only required when applies_to = "groups") |
No |
Customer Group
Name
|
Type
|
Description
|
Required
|
id |
int |
The id of the customer group |
Yes |
start_at |
timestamp |
The start at for the customer group |
No |
end_at |
timestamp |
The end at for the customer group |
No |
Example Request
PUT /api/price-lists/{id}
{
"name": "API Test Updated",
"applies_to": "customers"
}
Example Response
{
"priceList": {
"id": 1
}
}