PostPlus API
  1. Parcels
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.
        PUT
      • Create or update up to 200 parcels in a single request.
        POST
      • Get parcel details by parcel Id.
        GET
      • Get up to 100 parcels details by parcel Ids.
        GET
      • Get parcel details by parcel number (tracking number).
        GET
      • Get up to 100 parcels details by parcel numbers (tracking numbers).
        GET
      • Get parcel details by sender reference number.
        GET
      • Get up to 100 parcel details by sender reference numbers.
        GET
      • Query up to 500 parcels.
        GET
      • Delete parcel by Id.
        DELETE
      • Delete up to 100 parcels by Ids.
        DELETE
      • Get print details and contents by print Id.
        GET
      • Get up to 100 parcel print details and contents by print Ids.
        GET
      • Get pickup point details by Id.
        GET
      • Query pickup points.
        GET
      • Group parcels into bags and link to a shipment (update parcel references).
        POST
      • Get parcel details by manifest reference numbers.
        GET
      • Get up to 100 parcel details by manifest reference numbers.
        GET
      • Get parcel details by carrier reference numbers.
        GET
      • Get up to 100 parcel details by carrier reference numbers.
        GET
    • 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. Parcels

Get parcel details by manifest reference numbers.

GET
https://api.test.post-plus.io/api/v1/parcels/manifest-parcel-nrs/{manifestParcelNr}

Request

Path Params

Query Params

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.test.post-plus.io/api/v1/parcels/manifest-parcel-nrs/' \
--header 'Accept: application/json' \
--header 'X-API-KEY: apitest1234567890' \
--header 'Content-Type: application/json'

Responses

🟢200OK
text/plain
Success
Body

Example
{
    "identifiers": {
        "id": 1234,
        "parcelNr": "RS12345678US",
        "senderParcelNr": "client-id-123"
    },
    "references": {
        "shipmentId": 0,
        "shipmentNr": "123-000000123",
        "bagNr": "bag-001",
        "externalIds": 1234567890,
        "carrier": "string",
        "carrierParcelNr": "string",
        "manifestParcelNr": "string",
        "printId": 1234567890
    },
    "status": {
        "hasErrors": true,
        "errorDetails": [
            "string"
        ],
        "hasWarnings": true,
        "isCancelled": false,
        "warningDetails": [
            "string"
        ],
        "status": "Created",
        "createdOn": "2019-08-24T14:15:22Z"
    },
    "parcel": {
        "type": "NotRegistered",
        "destinationCountryCode": "NL",
        "transactionType": "B2C",
        "parcelItems": 1,
        "parcelValue": 1.25,
        "currency": "USD",
        "parcelGrossWeight": 0.125,
        "height": 0,
        "width": 0,
        "length": 0,
        "items": [
            {
                "description": "Tennis ball",
                "skuCode": "sku-123",
                "hsCode": "711319",
                "quantity": 1,
                "valuePerItem": 1.25,
                "weightPerItem": 0.125
            }
        ]
    },
    "receiver": {
        "name": "string",
        "phone": "string",
        "phoneNormalized": "string",
        "email": "string",
        "address": "string",
        "zipCode": "string",
        "city": "string",
        "state": "string",
        "countryCode": "string",
        "pickupPointId": 0
    },
    "sender": {
        "name": "string",
        "phone": "string",
        "phoneNormalized": "string",
        "email": "string",
        "address": "string",
        "zipCode": "string",
        "city": "string",
        "state": "string",
        "countryCode": "string"
    },
    "additionalInfo": {
        "taxType": "string",
        "taxIdentification": "string",
        "routeInfo": "string",
        "shipDate": "2019-08-24T14:15:22Z",
        "serviceCode": "string",
        "ordinal": 0
    },
    "prints": [
        {
            "id": 1234,
            "format": "Pdf",
            "type": "PostalLabel",
            "subTypes": [
                "string"
            ],
            "provider": "ExtProvider,Postal",
            "bytes": 0,
            "content": "string",
            "hasErrors": true,
            "errorDetails": [
                "string"
            ]
        }
    ]
}
Previous
Group parcels into bags and link to a shipment (update parcel references).
Next
Get up to 100 parcel details by manifest reference numbers.
Built with