Connect API Documentation

https://connect.yourbarmate.com/api
Changelog

Write pricing for specific product and customer

PUT /products/:id/customer-pricing/:customer

Parameters

  • id: The identifier as specified when the product was created
  • customer: The identifier of the customer

Status codes

  • 200 on success

Request properties

The request format is the same as the response with the following properties:

  • price: The integer price in cents, if available

  • pricing: Optional scaled pricing setup

    • strategy: The pricing strategy, one of "VOLUME", "INCREMENTAL", or "DIVISIBLE"
    • price_points: The prices used in the pricing based on the quantity of items.
      • from: The number of items the price point is applied from
      • price: The price for one item
    • date_overrides: An array of date periods where the price points are different from the default ones. Each item of the array can have the following properties:
      • from_date: The start of the validity for the date override. Can be open ended if no to_date is given.
      • to_date: The last day of the date range. It is inclusive, the override is still valid on this date.
      • price_points: The price points to be used for this date range or from this start date.

Please note that this is a PUT endpoint so if either of the above properties is missing from the request, it will be removed from the object.

Response

  • price: The integer price in cents, if available
  • pricing: Optional scaled pricing setup
    • strategy: The pricing strategy, one of "VOLUME", "INCREMENTAL", or "DIVISIBLE"
    • price_points: The prices used in the pricing based on the quantity of items.
      • from: The number of items the price point is applied from
      • price: The price for one item
    • date_overrides: An array of date periods where the price points are different from the default ones. Each item of the array can have the following properties:
      • from_date: The start of the validity for the date override. Can be open ended if no to_date is given.
      • to_date: The last day of the date range. It is inclusive, the override is still valid on this date.
      • price_points: The price points to be used for this date range or from this start date.

Example requests

Response on success will always match the request body.

{
"price": 725,
"pricing": {
"strategy": "VOLUME",
"price_points": [
{
"from": 1,
"price": 725
},
{
"from": 100,
"price": 699
}
]
}
}
{
"pricing": {
"strategy": "VOLUME",
"price_points": [
{
"from": 1,
"price": 1250
},
{
"from": 10,
"price": 1200
},
{
"from": 50,
"price": 1150
}
]
}
}
{
"price": 999
}