API docs Getting started
Postman Collection
Import our Postman Collection and try every endpoint without writing code.
Our Postman Collection contains a ready-made request for every endpoint, with the same examples as these docs.
What is Postman?
Postman is an API platform for building and using APIs. You can download Postman on this page.
Import the collection
- Download the collection: parcelparcel-api.postman_collection.json.
- In Postman, click Import and drop the file in the window. You can also paste this link in the Import window:
- Open the ParcelParcel API collection and go to the Variables tab. Fill in your own
apiKeyandapiSecret. Tip: start with your sandbox key. Don't know where to find them? Check our Authentication page. - Open a request and click Send.
The collection has a folder per endpoint. For Cancel a shipment and Get the shipping documents, set the shipmentId variable to the id you got when you created the shipment. For Track a shipment, set trackingNumber.
Booking is for real
The request "Parcel shipment (booked directly)" has bookShipment: true. With your live key, sending it books a real shipment at the carrier on your account. Use your sandbox key to try it safely: nothing is sent to the carrier. The other create requests only make a draft.