Parcelly API

Create, track and cancel parcel shipments with a single REST API. Parcelly picks the carrier, prints the label and keeps you up to date until the parcel arrives.

Base URL

https://api.parcelly.dev

Authentication

Authenticate every request with your secret API key, sent as an HTTP bearer token:

Authorization: Bearer <key>

Keep your key on the server and never commit it to source control.

Errors

Failed requests return a non-2xx status and a JSON body with a machine-readable code and a human-readable message.

Endpoints

GET /v1/shipments List shipments
POST /v1/shipments Create a shipment
GET /v1/shipments/{shipment_id} Get a shipment
POST /v1/shipments/{shipment_id}/cancel Cancel a shipment
GET /v1/carriers List carriers

Staying up to date

Read the changelog, subscribe to the RSS feed, or fetch the OpenAPI document directly.