Quick Guides

Here you can find some quick guides to get you started with the Crestline API, from authentication to creating shipments and managing webhooks.

📄️ Authorization

The Crestline API uses Basic Authentication to authenticate users. In the future, we plan to transition to OAuth2 to provide enhanced security and flexibility. This guide explains the current authentication method and what to expect with the upcoming changes.

📄️ Manage Shipments

Shipments are the center of the Crestline API, because every object within our API is tied back to a shipment. You are able to look up individual objects using different endpoints within our API, but as long as you have the Shipment UUID, you will be able to get the shipment, the vehicles in the shipment, the photos of the vehicles, the documents linked to the shipment and so on.

📄️ Handling Responses

The API will always return the same response structure unless a 5xx Server error occurs.

📄️ Webhooks

Retry Policy