PostPlus API overview

PostPlus provides API endpoints that enable customers to interact with the PostPlus platform by creating and managing parcels, retrieving parcel labels, manifesting shipments, etc. API conforms to Open API specification.

PostPlus has currently two customer-facing environments in use: test and production. Test environment suits for prototyping and integration development, it contains the latest releases that might not be available in production yet, and additionally, data in the test environment gets reset on regular basis.

TEST environment specification at https://api.test.post-plus.io/swagger

X-API-KEY for testing is: apitest1234567890

PRODUCTION environment specification at https://api.post-plus.io/swagger

Production API key will be provided by the account manager or can be requested from PostPlus IT.

API is using an API Key authentication scheme that requires X-API-KEY header to be present in each request. Production API keys shall be obtained from the PostPlus account manager.

API request example:

Each provided API key is associated with a specific PostPlus account with specific authorization rules, i.e. a given key might be authorized to manage shipments, but not authorized to request HS codes. Authorizations are managed by PostPlus according to customer agreements.

Here we’ll go through all the steps necessary to upload shipments data. Please note that the steps through API are very similar to regular user interface shipment creation and manifest file upload.

In general, the user interface at https://api.test.post-plus.io/swagger should provide enough information for developers to get started with integration. Each endpoint (an action or a query) has an action description as well as request and response payload descriptions. The Swagger user interface also allows users to send requests using provided API keys.

API allows creating and updating one or multiple parcels in one request, retrieve parcel information, updating references, such as bag numbers, and linking to shipments.

The main API workflow is the following:

Read more about how to create parcels, shipments and fetch tracking.