API docs / Getting started

Copy a cURL example from these docs, paste it in Postman and send your first request.

Every endpoint page starts with an Example request. Its cURL tab is a complete request: method, URL, headers and body. Postman turns it into a request for you, so you don't have to type anything over.

#What is Postman?

Postman is an API platform for building and using APIs. You can download Postman on this page.

#Import a cURL example

1. Open an endpoint, for example Compare shipping options.
2. In the Example request, choose the cURL tab and click Copy.
3. In Postman, click Import at the top left and paste the cURL in the box. You can also paste it straight into the URL bar of a new request.
4. Postman creates the request with the method, headers and body filled in.
5. In the Headers tab, replace {YourAPIKey}@{YourAPISecret} in the X-PP-API header with your own API key and secret. Don't know where to find them? Check our Authentication page.
6. Click Send.

#Other ways to copy a request

• Body: only the JSON body, for when you already have a request set up and want to try another example.
• JavaScript and Python: the same request as code, ready to paste in your own project.
• HTTP: the raw request, as it goes over the line.