1Pick a language
2Credentials
3Try it!
Click
Try It! to start a request and see the response here!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/resource/
HTTP Methods
The Ship.Cars API supports most of the standard HTTP methods - GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS.
Error Handling
The Ship.Cars API responds with standard HTTP response status codes in the 200, 300, 400, and 500 ranges. Your application should handle each of these classes differently.
| Status Code Class | Description |
|---|---|
| 2xx | Denotes success and indicates that the API request completed without errors. |
| 3xx | Indicates that the requested resource URL is incorrect and includes a redirection URL. |
| 4xx | Indicates that there was a problem with the API request, such as a missing required parameter or an invalid parameter value. Check the response code and body for details and modify your request accordingly before sending it again. |
| 5xx | Indicates that there was a problem with the server and that the request should be retried |
In addition to the response codes, the Ship.Cars API typically sends a JSON-formatted response body with the following data:
- in case of success, the body contains the requested, created, or modified resources.
- in case of error, the body contains details about the error in a
detailattribute. In case of missing or invalid values in the request body, the response body lists the names of the invalid attributes and gives detials about each of them.