PostPlus API
    PostPlus API
    • Authentication, Environments
    • Endpoints Overview
      • Parcels Endpoints
      • Shipments Endpoints
      • Tracking Endpoints
      • Accounts Endpoints
    • Scenarios And Workflows
      • Working with parcels
      • Create or update parcel record
      • Cancel or delete a parcel record
      • Manifesting parcels in bags and shipments
      • Query parcel tracking events
    • All API Endpoints
      • Parcels
        • Create or update single parcel.
        • Create or update up to 200 parcels in a single request.
        • Get parcel details by parcel Id.
        • Get up to 100 parcels details by parcel Ids.
        • Get parcel details by parcel number (tracking number).
        • Get up to 100 parcels details by parcel numbers (tracking numbers).
        • Get parcel details by sender reference number.
        • Get up to 100 parcel details by sender reference numbers.
        • Query up to 500 parcels.
        • Delete parcel by Id.
        • Delete up to 100 parcels by Ids.
        • Get print details and contents by print Id.
        • Get up to 100 parcel print details and contents by print Ids.
        • Get pickup point details by Id.
        • Query pickup points.
        • Group parcels into bags and link to a shipment (update parcel references).
        • Get parcel details by manifest reference numbers.
        • Get up to 100 parcel details by manifest reference numbers.
        • Get parcel details by carrier reference numbers.
        • Get up to 100 parcel details by carrier reference numbers.
      • Shipments
        • Create new shipment.
        • Update shipment.
        • Get shipment details.
        • Delete shipment.
        • Create new bag level shipment.
        • Update bag level shipment.
        • Link parcels with specified bag numbers to a shipment.
        • Validate and prepare shipment for submitting.
        • Submit and lock shipment and it's parcels.
        • Cancel erroneous parcels in a shipment.
        • Upload shipment manifest file.
        • Upload shipment document.
        • Delete shipment manifest file.
        • Query up to 500 shipments.
        • Group parcels into bags and link to a shipment, then prepare and submit shipment in one transaction.
      • Documents
        • Download manifest file.
        • Download resulting (processed) manifest file.
        • Download resulting (processed) shipment file.
        • Download shipment documents in archive file.
        • Download shipment document file by Id.
        • Download parcel label by Id.
        • Generate and download shipment parcel labels.
        • Generate and download generic bag labels.
        • Generate and download bag label.
        • Generate and download parcel commercial invoices.
      • Tracking
        • Get event codes and other metadata.
        • Fetch up to 500 tracking events in cursor fashion.
        • Get tracking events by the list of parcel numbers, up to 50, comma separated.
        • Get tracking events by the list of sender reference numbers, up to 50, comma separated.
        • Get tracking events by the list of parcel numbers or sender reference numbers, up to 50, comma separated.
        • Upload tracking events file.
        • Get bag tracking events by the list of bag numbers, up to 50, comma separated.
        • Get bag tracking events by the list of bag numbers or shipment numbers, up to 50, comma separated.
      • Accounts
        • Get current account details.
      • Integrations
        • Add up to 500 tracking events to the processing queue. The whole batch either succeeds or fails.
        • Add tracking event with generic payload.

    Authentication, Environments

    Authentication#

    API is using an API Key authentication scheme that requires X-API-KEY header to be present in each request. Each API key is associated with:
    Environment (test or poduction, see below).
    Specific PostPlus account with specific authorization rules, i.e. a given API key might be authorized to manage shipments, but not authorized to request HS codes. Authorizations are managed by PostPlus according to customer agreements.

    Customer Portal#

    Parcels, labels, shipments created via API can also be accessed via customer portal, see urls below in the Environments section.
    IT support and customer portal related documentation is accessbile at https://postplus.freshdesk.com/support/solutions

    Environments#

    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#

    Bear in mind, that TEST environment is a shared environment, multiple customers might use it at the same time. The data is being reset on a regular basis, so users should not expect the data to be retained there for extended periods of time.
    API URL: https://api.test.post-plus.io
    API Swagger UI: https://api.test.post-plus.io/swagger
    Customer Portal URL: https://extranet.test.post-plus.io/
    API key:
    apitest1234567890
    Customer Portal credentials:
    user: apitest@post-plus.net
    password: apitest1234567890

    PRODUCTION environment#

    API URL: https://api.post-plus.io
    API Swagger UI: https://api.post-plus.io/swagger
    Customer Portal URL: https://extranet.post-plus.io/
    Production API key and access to customer portal will be provided by the account manager.

    API request rate limtis#

    šŸ“Œ PostPlus API applies rate limiting to all client requests

    PostPlus API applies rate limiting (normally 5 requests per seconds) to all client requests, so integrators must cosider batch operations whenever possible, for example in Tracking Endpoints

    Sending API requests from the documentation user interface#

    Sample API requests provided in the documentation use TEST environment and TEST API key by default
    image.png
    image.png
    Next
    Parcels Endpoints
    Built with