API Integration Guide

Brands that run their own ERP, order management system or custom storefront can connect to Jay Group directly through the Jay Group Logistics API (version 3). It is a REST API that sends JSON over HTTPS, so orders flow into our warehouses and inventory, shipment and tracking data flow back to your systems automatically. If you sell on Shopify, Amazon or another platform we already support, you may not need the API at all: see our integrations.

What you can connect

• Orders: create, edit, cancel and search DTC and B2B orders.
• Items and inventory: create SKUs and check inventory levels.
• Purchase orders: send retail and wholesale purchase orders.
• Receiving: send advance ship notices (ASNs) for inbound parcel, LTL, truck and container deliveries.
• Shipping labels: buy carrier labels in PDF or ZPL, from Economy to Next Day service.
• Tracking and webhooks: get real-time order, shipment and receiving updates.

How to get started

1. Ask your Jay Group account manager for API credentials: a client ID and a client secret.
2. Exchange them for an access token, valid for 12 hours, using the OAuth 2.0 client credentials flow.
3. Send the token with each request. Each application is granted only the permissions (scopes) it needs.
4. Register a webhook URL to receive events such as OrderFulfilled, FulfillmentDelivered and TrackingUpdate instead of polling for changes.

Built for reliable integrations

• Signed webhooks (HMAC-SHA256), retried up to seven times over 24 hours if your system does not respond.
• Order edits with JSON Patch, up to 40 changes per request, without resending the whole order.
• Shipping cost for every shipment, from estimate to final, with itemized base, fuel, peak and accessorial charges.
• HTTPS with TLS 1.2 or 1.3, ISO 8601 dates and standard HTTP status codes.

For a plain-language walkthrough of how shipping APIs work, read our ecommerce guide to shipping APIs.