end points for global price lists.
List your price lists
Get /v1/b2b/price/lists
Response
A list of Price List Objects.
Get a price list
Get /v1/b2b/price/lists/{id}
Input
id: The id of the price list you want.
Response
Create a price list
POST /v1/b2b/price/lists
Body
A Price List Object
Response
The id to the newly created price list.
Update a price list
PUT /v1/b2b/price/lists
Body
A Price List Object
Response
The updated Price List Object
Delete a price list
DELETE /v1/b2b/price/lists/{id}
Input
id: The id of the price list you want to delete.
Response
None
Events: there is a new JSON property that can be passed in at the event level for a price list called priceList. Please see the Event documentation
Event Template: You can now pass an array of price lists in at the event template called priceLists
Event Schedule: You can now pass in an array of price lists (called priceLists) with a schedule.
Price List JSON Objects
Field | Description | Notes |
|---|---|---|
| id | Unique ID of the price list. | Read Only |
| name | Name of the price list. | |
| description | Description of the price list. | |
| effectiveStartTime | Date for the start of this price list. | ISO-8601 |
| effectiveEndTime | Date for the end of this price list. | ISO-8601 |
| prices | List of prices. | |
| prices[x].personType | The person type object | |
| prices[x].personType.id | The id of the person type. | |
| prices[x].personType.name | The name of the person type. | Read Only |
| prices[x].personType.description | The description of the person type. | Read Only |
| prices[x].personType.type | The type of person type. | |
| prices[x].personType.displayOrder | The order that this will be displayed in, in the price list. | |
| prices[x].price | The price for this person type. | |
| prices[x].salesChannels | list of sales channels available for this person type. | |
| prices[x].salesChannels[y].channel | one of (online, customerRep, pointOfSale, manualEntry) | |
| prices[x].salesChannels[y].name | one of (Online, Customer Rep, Point of Sale, Manual Entry) | |
| prices[x].salesChannels[y].enabled | true if this sales channel is enabled for this price list person type combination otherwise false. |
PriceList Schema
{ "id" : "123-456-678", "name" : "Price for Tours", "description" : "Default price for standard tours", "effectiveStartTime" : ISO8601 date, "effectiveEndTime" : ISO8601 date, "prices" : [ { "personType" : { "id" : "897-12356", "name" : "Adult", "description" : "18 and older", "active" : true, "type" : "Individual", "displayOrder" : 1 }, "price" : 1.02, "salesChannels" : [ { "channel" : "online", "name" : "Online", "enabled" : false }, { "channel" : "pointOfSale", "name" : "Point of Sale", "enabled" : true }, { "channel" : "customerRep", "name" : "Customer Rep", "enabled" : true } ] }, ... ]} |