- 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.
- 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
- Integrations
Get current account details.
GET
https://api.test.post-plus.io/api/v1/accounts/current
Request
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/accounts/current' \
--header 'Accept: application/json' \
--header 'X-API-KEY: apitest1234567890' \
--header 'Content-Type: application/json'Responses
🟢200OK
text/plain
Body
Example
{
"shipmentTypes": [
"VirtualDespatch"
],
"shipmentTerminals": [
{
"code": "string",
"name": "string",
"isEnabled": true,
"isDirectInjection": true,
"countryCode": "string",
"arrivalGateways": [
"string"
]
}
],
"parcelNrSequences": [
{
"name": "string",
"isEnabled": true,
"type": "UPUS10",
"mailType": "NotRegistered",
"rangeStart": "string",
"rangeEnd": "string",
"lastParcelNr": "string",
"isOffline": true
}
],
"addresses": [
{
"type": "SenderAddress",
"contactName": "string",
"contactEmail": "string",
"contactPhone": "string",
"companyName": "string",
"address": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"isDefault": true
}
],
"commonSettings": {
"qstep": {
"importClientId": 0,
"exportClientId": 0,
"importShipmentsEnabled": true,
"exportShipmentsEnabled": true
},
"leanMile": {
"exportShipmentsEnabled": true
},
"x7Trade": {
"exportShipmentsEnabled": true
},
"labels": {
"accountLogoCode": "string",
"postal": {
"b2CPrintActualSenderAddressWithReturnAddress": true,
"b2CPrintActualSenderAddress": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"printSenderParcelNr": true,
"printTaxId": {
"property1": [
"string"
],
"property2": [
"string"
]
},
"senderAddress": {
"property1": {
"name": "string",
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
},
"property2": {
"name": "string",
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
}
},
"returnAddress": {
"property1": {
"name": "string",
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
},
"property2": {
"name": "string",
"address": "string",
"zipCode": "string",
"city": "string",
"country": "string"
}
}
}
},
"customs": {
"customsClearanceCountryCodes": [
"string"
],
"defaultGoodsOriginCountryCode": "string",
"defaultGoodsOriginHub": "string"
},
"postal": {
"maxReceptacleWeightKg": 0
},
"shipmentManifest": {
"includedBagTareWeightKg": 0
},
"rateManagement": {
"isParcelBasedInvoiceSpec": true
},
"emaiNotifications": {
"onShipmentHandlingEvents": {
"to": [
"string"
],
"bcc": [
"string"
]
},
"onShipmentDocumentEvents": {
"to": [
"string"
],
"bcc": [
"string"
]
}
},
"telemetry": {
"logRequests": [
"string"
],
"logInvalidRequests": [
"string"
]
}
},
"accountId": "string",
"rowVersion": "string",
"name": "string",
"accountCode": "string",
"isEnabled": true,
"organizationName": "string",
"accountManager": "string",
"businessUnitCode": "string"
}