REST API

Connect your system directly to YBM Connect. Use the REST API to manage your product catalog, pricing, customers and delivery settings, process customer orders and receive webhook notifications.

Manage your product catalog

Create and maintain products, categories, vessels and bundles.

Receive customer orders

Read new delivery requests, respond with availability and actual prices, and track their status.

Manage your customers

Read customer accounts and manage their price groups and delivery rules.

Manage account settings

Configure delivery days, cut-off times, exceptions and account defaults.

How the exchange works

The API exchanges JSON over HTTPS. A typical integration follows these steps:

  1. Request YBM Connect access from our support team.
  2. Set up authentication and make your first API request.
  3. Use the relevant endpoints to manage products, pricing, customers and delivery settings.
  4. Read customer orders and send delivery responses through the API.
  5. Optionally use webhooks to receive new and cancelled order notifications.

Set up your connection

Authentication

Once you can sign in to YBM Connect, generate your API token under Settings → Integration. Keep it on your server and include it with every API request.

Authentication

Choose what to exchange

Product catalog

Create, update and remove products, categories, vessels and bundles.

Product catalog Categories

Pricing

Set standard prices, price-group pricing and customer-specific prices.

Pricing

Customers

Read customer accounts and manage their price groups and delivery rules.

Customers

Account settings

Configure the delivery rules that apply to your account by default.

Account settings

Customer Orders

Read deliveries, respond to requests and track their status.

Deliveries

Webhook events

Receive notifications when customer orders are created or cancelled.

Webhooks