RC:Ship API

The RC:Ship API gives your application programmatic access to shipping rates, shipments, labels, tracking, and shipping events. It allows you to build custom logistics workflows on top of our multi-carrier network.

API Principles

• RESTful Design: Resource-oriented URLs and standard HTTP verbs.
• JSON Payloads: Requests and responses are encoded in JSON.
• Secure by Default: All endpoints require HTTPS and Bearer token authentication.
• Event-Driven: Webhooks push asynchronous state changes directly to your application.

Base URL

All API requests should be made to the following production base URL:

https://api.ship.retailcoder.com/v1

Request & Response Conventions

Content Type

You must send the Content-Type: application/json header for all requests containing a body. The API will respond with JSON in all cases, including errors.

IDs

All resources in RC:Ship are assigned a unique string identifier prefixed with a resource indicator (e.g., shp_... for shipments, rate_... for rates).

Timestamps

All timestamps are returned in ISO 8601 format, represented in UTC (e.g., 2024-05-18T14:30:00Z).

Error Handling

RC:Ship uses standard HTTP response codes to indicate the success or failure of an API request.

• 2xx: Success.
• 4xx: Client error (e.g., missing parameter, invalid auth token). The payload will contain details.
• 5xx: Server error on our end.

{
  "error": {
    "code": "validation_error",
    "message": "The destination zip code is invalid.",
    "param": "destination.zip"
  }
}