Price Lists

Each site will be assigned a price list that determines ex tax unit prices of each item on sale.

Price lists work by overriding prices in their parent lists (just like subclassing in object-oriented programming). The base price list has a parent_id of null.

Get all price lists

GET /v1/companies/5678/price_lists Get all price lists

Get a price list

GET /v1/companies/5678/price_lists/base Get the base price list
GET /v1/companies/5678/price_lists/236 Get a price list by ID
  • The unit_price returned is always the ex tax price for that product and the unit_price_inc_tax is tax inclusive price
  • .
  • The list_type has a value of fixed if products in the price list have individual fixed prices, and dynamic if the products are priced based on a percentage adjustment of the base price list.
  • The adjustment_percentage is returned for dynamic price lists. It is the percentage increase or decrease from the base price. As per the example above, the base price of a Cappuccino is $2.00, so with an adjustment_percentage of -10 the price is reduced by 10% percent, being $1.80. Note that there are additional rules around which products are dynamically adjusted. It does not apply to every base product.

Only products explicitly priced in the requested price list will be included. To get all products, including those inherited from parent lists, use the products sub-endpoint:

GET /v1/companies/5678/price_lists/236/products Get products for a price list, including all inherited products
  • The unit_price returned is always the ex tax price for that product and the unit_price_inc_tax is tax inclusive price
  • .
  • All products will have false as inherited value if price list is dynamic as it can/will override any products price.
  • In addition, the products that satisfy the dynamic price list rule will be priced based on a percentage adjustment of the base price list. adjustment_percentage will be shown for products with adjustment for us to determine which products have been adjusted.

List of Webhooks

Here is a list of the supported webhook topics.

price_lists/created

When a price list is created. You will receive the complete price list.

price_lists/updated

When a price list is updated or the product prices on it have been changed. You will receive the complete price list after the modifications have been applied.

You also may provide the following attribute filters:

  • name

price_lists/deleted

When a price list is deleted. You will receive the complete price list.