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

Query pickup points.

GET
https://api.test.post-plus.io/api/v1/parcels/pickup-points/query
Parcels

Request

Query Params
CarrierCode
string 
required
>= 1 characters
Example:
DPB
CountryCode
string 
required
>= 1 characters
Example:
EE
City
string  | null 
optional
Example:
TALLINN
ZipCode
string  | null 
optional
IncludeInactive
boolean 
optional
Header Params
Content-Type
string 
optional
Default:
application/json
Accept
string 
optional
Default:
application/json
X-API-KEY
string 
optional
Default:
apitest1234567890

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/pickup-points/query?CarrierCode=DPB&CountryCode=EE&City=TALLINN&ZipCode=&IncludeInactive' \
--header 'Accept: application/json' \
--header 'X-API-KEY: apitest1234567890' \
--header 'Content-Type: application/json'

Responses

🟢200OK
text/plain
Success
Body
pickupPoints
array[object (PickupPointInfo) {26}]  | null 
optional
id
integer <int32>
optional
updatedOn
string <date-time>
optional
carrierPickupPointId
string  | null 
optional
name
string  | null 
optional
isActive
boolean 
optional
carrier
string  | null 
optional
carrierCode
string  | null 
optional
countryCode
string  | null 
optional
region
string  | null 
optional
city
string  | null 
optional
zipCode
string  | null 
optional
address
string  | null 
optional
lat
number <double>
optional
lng
number <double>
optional
type
enum<string> 
optional
Allowed values:
LockerParcelShop
description
string  | null 
optional
contactPhone
string  | null 
optional
contactEmail
string  | null 
optional
hasBankCard
boolean  | null 
optional
monday
string  | null 
optional
tuesday
string  | null 
optional
wednesday
string  | null 
optional
thursday
string  | null 
optional
friday
string  | null 
optional
saturday
string  | null 
optional
sunday
string  | null 
optional
Example
{
    "pickupPoints": [
        {
            "id": 0,
            "updatedOn": "2019-08-24T14:15:22Z",
            "carrierPickupPointId": "string",
            "name": "string",
            "isActive": true,
            "carrier": "string",
            "carrierCode": "string",
            "countryCode": "string",
            "region": "string",
            "city": "string",
            "zipCode": "string",
            "address": "string",
            "lat": 0,
            "lng": 0,
            "type": "Locker",
            "description": "string",
            "contactPhone": "string",
            "contactEmail": "string",
            "hasBankCard": true,
            "monday": "string",
            "tuesday": "string",
            "wednesday": "string",
            "thursday": "string",
            "friday": "string",
            "saturday": "string",
            "sunday": "string"
        }
    ]
}
Previous
Get pickup point details by Id.
Next
Group parcels into bags and link to a shipment (update parcel references).
Built with