Open API · v0.2

Open API

A company admin issues an API key in Settings, scoped to one workspace and revocable. With it your systems read that workspace's data as JSON, page by page or only what changed since a given time, and — with a write scope — create and update customers, quotes, shipments, milestones, documents and charges. Some writes wait for a person in the workspace to approve them. The full reference is the OpenAPI 3.1 file.

API keysPer workspace, revocable
REST + JSONRead and write
EventsA change feed and pushed messages

What it covers

AvailableShipments (all modes), legs and milestonesRead
AvailableCharges and invoices (buy-side only with the finance:cost scope)Read
AvailableCustomers, carriers and other partiesRead
AvailableQuotes and document metadataRead
AvailableSupported customer, quote, shipment, milestone, document and charge operations (road, sea and air)Write
AvailableChange feed of eventsRead
AvailableShipment messages pushed to your endpoint when a file changesPush

Scope and approval rules

Scoped, revocable API keys provide workspace-specific REST reads and supported writes. Write operations cover road, sea and air workflows; the OpenAPI reference defines the available operations and fields.

API-key operations may be automatic, require caller confirmation or wait for a workspace approver, as specified for each operation. Write access and buy-side financial data require their respective scopes.

The change feed is available through the API. Signed outbound shipment messages require an administrator to configure the receiving endpoint, filters and delivery settings.

Need to connect a system to YLOAD 360?

Talk to us