Skip to content

REST API

Caution

This documentation is a for legacy version of the purplship-server (up to 2021.7).

Please visit purplship.com/docs for the latest documentation.

The Multi-carrier Shipping API

purplship shipping API is powered by REST. Rather than dealing with non-standardized, often poorly documented carrier webservices and arcane technologies such as SOAP. purplship proposes a unified and intuitive REST API compatible for all supported carriers services.

API References

purplship exposes a set of REST API resources. The full references are accessible at /openapi/ for the full description of the service APIs from your browser.

Playground

You can download the purplship OpenAPI specification to quickly familiarize yourself with the REST API and perform example requests by importing it in tools such as Insomnia or Postman