Connect API Documentation

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

Customers

Manage your customers in YourBarMate.

Price group

You can set the price group for each customer and customise the pricing of each product for these price groups.

The custom prices for a price group have to be set per product.

Deliveries settings

You can configure default settings for all deliveries for your account.

Note that you can override the delivery_days, delivery_date_overrides and dates_with_no_delivery per customer and even per product.

delivery_days

Indexed by the day of the week (0 - Sunday, 6 - Saturday) it describes when an order has to be made in order to get a delivery on that day of the week. For each day we can set two properties:

  • lead_days: specifies how many days in advance the order has to be made to get the delivery on the day of the week. This is a required property.
  • cutoff: specifies until what time the order has to be made on the day indicated by the lead_days. Format is HH:mm. This is an optional property. Defaults to 23:59.

When an index is missing from the object, it means that there is no delivery on that day.

Example: Delivering on Monday, Wednesday and Friday. To get a delivery on Wed or Fri, the customers have to place their order by 8am on the day before. But to get a Monday delivery, they can place their order anytime by end of Saturday (00:00 on Sunday)

{
"delivery_days": {
"1": { "lead_days": 2 },
"3": { "lead_days": 1, "cutoff": "08:00" },
"5": { "lead_days": 1, "cutoff": "08:00" }
}
}
delivery_date_overrides

Indexed by dates in ISO date format (e.g. 2023-04-16) it has the same format and can override the settings provided by delivery_days.

Example: Delivering orders made by end of Saturday on the next Monday, apart from the 26th of December, where the order has to be made by 12pm Friday.

{
"delivery_days": {
"1": { "lead_days": 2 }
},
"delivery_date_overrides": {
"2023-12-26": {
"lead_days": 3,
"cutoff": "12:00"
}
}
}
dates_with_no_delivery

A list of dates in ISO date format. It contains all the dates when the supplier will not deliver this item.

Example: No delivery over the Christmas weekend.

{
"dates_with_no_delivery": [
"2023-12-24",
"2023-12-25",
"2023-12-26",
"2024-01-01"
]
}
Example delivery settings

This item can be ordered by 11:00am every morning and be delivered next day - apart from Friday and the weekend. Ordering anytime on Friday gets a Monday delivery. Ordering over the weekend all the way until 11am Monday morning gets a Tuesday delivery. Over Christmas special rules apply: on the 26th of December no deliveries are possible, and to make the cut for the first delivery on the 27th, the order has to be made before 4pm on Friday the 23rd of December.

{
"delivery_days": {
"1": { "lead_days": 3 },
"2": { "lead_days": 1, "cutoff": "11:00" },
"3": { "lead_days": 1, "cutoff": "11:00" },
"4": { "lead_days": 1, "cutoff": "11:00" },
"5": { "lead_days": 1, "cutoff": "11:00" }
},
"delivery_date_overrides": {
"2023-12-27": {
"lead_days": 4,
"cutoff": "16:00"
}
},
"dates_with_no_delivery": ["2023-12-26"]
}