Getting Started with Ship.Cars

This page will help you get started with Ship.Cars. You'll be up and running in a jiffy!

Welcome to Ship.Cars!

You're on your way to building an awesome integration with our platform! Here's some of the things you'll want to check out.

📈 High-level architecture

This diagram shows the Ship.Cars Platform and how it's integrated with external API integrators.

We have two main types of integrators - carriers and shippers.

• Carriers are handled by the Carrier TMS (transport management system)
• Shippers are managed by the LoadMate/Pro API (which communicates with carriers to get quotes)

Authorized clients can request price predictions for specific quotes/orders directly via our RateEngine API.

🏃 Getting started

The Ship.Cars API is HTTP-based (over SSL) and uses the JSON data format for most of the responses and some of the request.

Resource URLs

The base URL for accessing the API is:

https://ship.cars/api/

You can access specific resources with an HTTP request to:

https://ship.cars/api/path/to/resourc

HTTP Methods

The Ship.Cars API supports most of the standard HTTP methods - GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS.

Authentication

Authentication

📝 How carriers can use the Carriers TMS API

The Carrier Providers API integration is described here: Carrier Providers Integration

📝 How carriers can use the Quote Manager API in LoadMate/Pro

The LoadMate Providers API integration is described here: LoadMate Providers Integration

📝 How shippers can use the LoadMate/Pro API

The LoadMate Shipper API integration is described here: LoadMate Shippers' API Integrators

📝 How clients can use the RateEngine API

The RateEngine Price Prediction API integration is described here: RateEngine API Integration

🔗 Integrations #beta

Ship.Cars provides an easy way to receive updates. More information here: Integrations

💬 We're here to help!

If you get stuck, shoot us an email or use the Intercom widget on the bottom right of any page.

We're excited you're here! 💙