REST API

Y3M API documentation

Integrate external business systems with Y3M using authenticated JSON API endpoints for delivery routes and order picking.

Integration details

Authentication
Every request requires a company API key in the Authorization header using the Bearer scheme.
Request format
Send one JSON object with Content-Type: application/json to the selected POST route.
Limits
Payloads may be up to 1 MiB. Each source IP may send 30 requests per 60 seconds.
Errors
Errors use a consistent JSON object with an HTTP status, machine-readable code, message, and field details when validation fails.

Available endpoints

Delivery routes

Send delivery route data in JSON format.

POST/api/v1/delivery/routes
Open documentation

Order Picking orders

Send order picking data in JSON format.

POST/api/v1/order-picking/orders
Open documentation