PostPlus API
  1. Scenarios And Workflows
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.
  1. Scenarios And Workflows

Working with parcels

Overview of parcel related endpoints: Parcels Endpoints

General workflow for working with parcels#

Creating/updating the parcel, ... more details Create or update parcel
Retrieving parcel info
Retrieving parcel label
Cancelling or deleting the parcel ... more details Cancel or delete a parcel record
Query parcel tracking events .. more details Query parcel tracking events

image.png

Creating a parcel and retrieving it's label#

@host = https://api.test.post-plus.io
@apiKey = apitest1234567890

PUT {{host}}/api/v1/parcels
content-type: application/json
X-API-KEY: {{apiKey}}

{
  "identifiers": {
    "senderParcelNr": "Test-SE-0036"
  },
  "parcel": {
    "transactionType": "B2C",
    "parcelGrossWeight": 0.15,
    "currency": "USD",
    "items": [
      {
        "description": "plastic toy",
        "hsCode": "950300",
        "quantity": 1,
        "valuePerItem": 0.1,
        "weightPerItem": 0.1
      }
    ]
  },
  "additionalInfo": {
    "serviceCode": "FREEP"
  },
  "receiver": {
    "name": "A test consignee",
    "phone": "+123456",
    "address": "Skeppsbron 5-1",
    "zipCode": "41121",
    "city": "GÖTEBORG",
    "countryCode": "SE"
  }
}

Retrieving parcel info#

To get a parcel information, this endpoint can be used with the parcel ID:
Get parcel details by parcel Id.
Get parcel details by parcel number (tracking number).
Get parcel details by sender reference numbers.
@host = https://api.test.post-plus.io
@apiKey = apitest1234567890

GET {{host}}/api/v1/parcels/{parcelId}?IncludeItems=true&IncludeReceiver=true&IncludeSender=true&IncludePrints=true
content-type: application/json
X-API-KEY: {{apiKey}}

GET {{host}}/api/v1/parcels/parcel-nrs/{parcelNr}?IncludeItems=true&IncludeReceiver=true&IncludeSender=true&IncludePrints=true
content-type: application/json
X-API-KEY: {{apiKey}}

GET {{host}}/api/v1/parcels/sender-parcel-nrs/{senderParcelNr}?IncludeItems=true&IncludeReceiver=true&IncludeSender=true&IncludePrints=true
content-type: application/json
X-API-KEY: {{apiKey}}

Retrieving parcel label#

To get a parcel label use the follwoing endpoint endpoints:
To get the label details and label contents in base64, use
Get print details and contents by print Id.
@host = https://api.test.post-plus.io
@apiKey = apitest1234567890

GET {{host}}/api/v1/parcels/parcel-prints/{{labelId}}?IncludeContents=true
content-type: application/json
X-API-KEY: {{apiKey}}
To get the label in direct content output (for example pdf), use
Download parcel label by Id.
@host = https://api.test.post-plus.io
@apiKey = apitest1234567890

GET {{host}}/api/v1/documents/parcel-prints/{{labelId}}
content-type: application/json
X-API-KEY: {{apiKey}}

Query parcel tracking events#

Query parcel tracking events
Previous
Scenarios And Workflows
Next
Create or update parcel record
Built with