Connect API Documentation

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

Changelog

2024-01-10

Features:

  • Added bundle id_override to products. This ID overrides the product ID in deliveries and WebHook messages when the user orders a product with this bundle selected.

2023-04-04

Features:

2023-03-20

Features:

  • Bundle and vessel types are not separated any longer. All packaging types can be used in both contexts, with the exception of PX (pallet).
  • min_order_count can now be a float for products with order_by being kg. The value represents the minimum weight to be ordered, e.g. 0.25 = 250g.

2023-03-03

Features:

  • The special vessel types NA and ZZ can now be used for bundles as well.
  • The bundle type BH (bunch) can now be used for vessels as well.

2023-01-24

Features:

  • Added support for bundle unit "kg".

2023-01-17

Features:

2022-12-29

Features:

2022-12-05

Features:

  • Added product pricing to all products related endpoints to support scaled pricing.
  • Added support for latin1 encoding to CSV files.
  • CSV order files now include a BOM when encoded in utf-8.

2022-11-03

Features:

2022-10-24

Documentation:

2022-10-18

Features:

2022-10-12

Documentation:

2022-10-06

Features:

  • Added new message field to delivery items on the webhook.
  • Adjusted the semantics of the OUT_OF_STOCK status on products to better reflect the actual behavior.

2022-09-30

Features:

  • Added new endpoint for PUT /categories/:id.

2022-09-28

Features:

  • Added new endpoint for PUT /products/:id.

2022-09-22

Features:

  • Added support for product specific delivery details (see products page for details).

2022-03-14

Features:

  • The new product field order_by allows to specify whether the product is ordered by "vessel" (default) or by "kg". When specifying "kg", the "vessel" can be omitted and the new price_per property defaults to "kg". Products that are ordered by "kg" support fraction amounts to be delivered.
  • The new product field price_per allows to specify how the product price is calculated. It can be set to "vessel" (default), "l", "kg" or "100g".
  • The product size is not required to be an integer anymore. A vessel size of { size: 1.5, unit: "l" } is now valid.

2021-12-15

  • Feature: The product vessel object can now be updated. Note that users who already imported the product will NOT have their product data updated automatically.

2021-12-08

  • Feature: The delivery request object now has customer_id field. This ID can be defined by the supplier to associate the delivery with a customer within a larger account with multiple physical locations.

2021-11-26

2021-11-08

  • Feature: The product vessel field is now optional when creating new products.

2021-11-02

  • Feature: Add support for pallet_bundle within bundles of type pallet.

    This feature helps customers to count products delivered on pallets more easily.

    When specifying a bundle with type pallet in POST /products or PATCH /products/:id, a new pallet_bundle property may specify the bundles on the pallet. The new property is then included in the Deliveries and the WebHook events.

    If no pallet_bundle is specified, but exactly one other bundle exists, it will be selected as the pallet_bundle automatically.

    With a pallet_bundle the vessel_amount in a Delivery and the WebHook event equals count * bundle.size * bundle.pallet_bundle.size.