Back to siteAPI Documentation

API Reference

Merchant endpoints grouped by feature area.

Authentication

Authenticate merchant users and refresh access tokens.

Login
POST

/api/v1/auth/login

Authenticate a merchant account.

View endpoint

Refresh Token
POST

/api/v1/auth/refresh

Issue a new access token.

View endpoint

Quotes

Request and manage transport pricing quotes.

Request Quote
POST

/api/v1/quotes

Create a new quote request.

View endpoint

List Quotes
GET

/api/v1/quotes

List quote requests.

View endpoint

Get Quote
GET

/api/v1/quotes/{quote_id}

Retrieve a single quote.

View endpoint

Shipments

Create, view, update, and track shipments.

Create Shipment
POST

/api/v1/shipments

Create a shipment record.

View endpoint

Create On-Demand Shipment
POST

/api/v1/shipments/on-demand

Create an on-demand shipment.

View endpoint

List Shipments
GET

/api/v1/shipments

List shipments.

View endpoint

Get Shipment
GET

/api/v1/shipments/{shipment_id}

Retrieve a shipment by ID.

View endpoint

Update Shipment
PATCH

/api/v1/shipments/{shipment_id}

Update mutable shipment fields.

View endpoint

Get Shipment Tracking
GET

/api/v1/shipments/{shipment_id}/tracking

Fetch tracking timeline for a shipment.

View endpoint

List Shipment Quotes
GET

/api/v1/shipments/{shipment_id}/quotes

List quote options linked to a shipment.

View endpoint

Bookings

Book, view, and cancel booked shipments.

Book Shipment
POST

/api/v1/shipments/{shipment_id}/book

Book a shipment using a quote option.

View endpoint

List Bookings
GET

/api/v1/bookings

List merchant bookings.

View endpoint

Get Booking
GET

/api/v1/bookings/{booking_id}

Retrieve a booking by ID.

View endpoint

Cancel Shipment
POST

/api/v1/shipments/{shipment_id}/cancel

Cancel a shipment booking.

View endpoint

Webhook Subscriptions

Receive real-time delivery and shipment events.

Create Subscription
POST

/api/v1/webhooks/subscriptions

Register a webhook endpoint.

View endpoint

List Subscriptions
GET

/api/v1/webhooks/subscriptions

List webhook subscriptions.

View endpoint

Test Subscription
POST

/api/v1/webhooks/subscriptions/{subscription_id}/test

Trigger a test delivery.

View endpoint

Delete Subscription
DELETE

/api/v1/webhooks/subscriptions/{subscription_id}

Delete a webhook subscription.

View endpoint