- Authentication, Environments
- Endpoints Overview
- Scenarios And Workflows
- 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.POST
- Update shipment.PUT
- Get shipment details.GET
- Delete shipment.DELETE
- Create new bag level shipment.POST
- Update bag level shipment.PUT
- Link parcels with specified bag numbers to a shipment.POST
- Validate and prepare shipment for submitting.POST
- Submit and lock shipment and it's parcels.POST
- Cancel erroneous parcels in a shipment.POST
- Upload shipment manifest file.POST
- Upload shipment document.POST
- Delete shipment manifest file.DELETE
- Query up to 500 shipments.GET
- Group parcels into bags and link to a shipment, then prepare and submit shipment in one transaction.POST
- 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
- Integrations
Get shipment details.
GET
https://api.test.post-plus.io/api/v1/shipments/{shipmentId}
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/shipments/' \
--header 'Accept: application/json' \
--header 'X-API-KEY: apitest1234567890' \
--header 'Content-Type: application/json'Responses
🟢200OK
text/plain
Body
Example
{
"shipmentSubmitToken": "string",
"isProcessing": true,
"bags": [
{
"id": 0,
"bagNr": "string",
"destinationCountryCode": "string",
"outboundBagNrs": "string",
"type": "NotRegistered",
"transactionType": "B2C",
"manifestLevel": "Parcel",
"status": "Created",
"totalItems": 0,
"totalItemsCancelled": 0,
"totalWeight": 0,
"netWeight": 0,
"netWeightCancelled": 0,
"tareWeight": 0,
"parcelWarnings": 0,
"parcelErrors": 0,
"routeInfo": "string",
"hasErrors": true,
"errorDetails": [
"string"
],
"hasWarnings": true,
"warningDetails": [
"string"
]
}
],
"manifestFiles": [
{
"id": 0,
"fileName": "string",
"fileType": "AutoDetect",
"fileFormat": "Generic",
"status": "Saved",
"bytes": 0,
"rows": 0,
"parsedRows": 0,
"hasErrors": true,
"errorDetails": [
"string"
],
"createdOn": "2019-08-24T14:15:22Z"
}
],
"documents": [
{
"id": 0,
"fileName": "string",
"fileType": "Generic",
"fileFormat": "Generic",
"status": "Saved",
"bytes": 0,
"hasErrors": true,
"errorDetails": [
"string"
],
"createdOn": "2019-08-24T14:15:22Z"
}
],
"id": 0,
"status": {
"hasErrors": true,
"errorDetails": [
"string"
],
"hasWarnings": true,
"warningDetails": [
"string"
],
"status": "Imported",
"canUpdate": true,
"canPrepare": true,
"canSubmit": true,
"createdOn": "2019-08-24T14:15:22Z",
"submittedOn": "2019-08-24T14:15:22Z"
},
"arrivalInfo": {
"arrivalGateway": "string",
"transportNr": "string",
"originCountryCode": "string",
"totalWeight": 0,
"totalBags": 0,
"arrivalOn": "2019-08-24T14:15:22Z",
"notes": "string"
},
"type": "VirtualDespatch",
"transactionType": "B2C",
"manifestLevel": "Parcel",
"shipmentNr": "string",
"masterNr": "string",
"terminalCode": "string",
"totalItems": 0,
"totalItemsCancelled": 0,
"totalWeight": 0,
"totalWeightCancelled": 0,
"totalBags": 0,
"parcelWarnings": 0,
"parcelErrors": 0
}