PostPlus API
  1. Shipments
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.
        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
      • 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. Shipments

Update shipment.

PUT
https://api.test.post-plus.io/api/v1/shipments/{shipmentId}
Shipments

Request

Path Params
shipmentId
integer <int64>
required
Header Params
Content-Type
string 
optional
Default:
application/json
Accept
string 
optional
Default:
application/json
X-API-KEY
string 
optional
Default:
apitest1234567890
Body Params application/json
shipmentNr
string  | null 
optional
Shipment reference number or document number. The existing number is not updated if the value is not specified.
Example:
123-000000123
masterNr
string  | null 
optional
Shipment master number
arrivalInfo
object (ShipmentArrivalInfo) 
optional
arrivalGateway
string  | null 
optional
Shipment arrival gateway
transportNr
string  | null 
optional
Transport number, such as flight number or truck number
<= 50 characters
originCountryCode
string  | null 
optional
Origin country code
totalWeight
number <double> | null 
optional
Total shipment weight
totalBags
integer <int32> | null 
optional
Total amount of bags in shipment
arrivalOn
string <date-time> | null 
optional
Estimated arrival date/time
notes
string  | null 
optional
Shipment arrival notes
<= 200 characters
Example
{
  "shipmentNr": "123-000000123",
  "masterNr": "string",
  "arrivalInfo": {
    "arrivalGateway": "string",
    "transportNr": "string",
    "originCountryCode": "string",
    "totalWeight": 0,
    "totalBags": 0,
    "arrivalOn": "2019-08-24T14:15:22Z",
    "notes": "string"
  }
}

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 PUT 'https://api.test.post-plus.io/api/v1/shipments/' \
--header 'Accept: application/json' \
--header 'X-API-KEY: apitest1234567890' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipmentNr": "123-000000123",
    "masterNr": "string",
    "arrivalInfo": {
        "arrivalGateway": "string",
        "transportNr": "string",
        "originCountryCode": "string",
        "totalWeight": 0,
        "totalBags": 0,
        "arrivalOn": "2019-08-24T14:15:22Z",
        "notes": "string"
    }
}'

Responses

🟢200OK
text/plain
Success
Body
id
integer <int64>
optional
Shipment Id.
status
object (ShipmentStatusInfo) 
optional
hasErrors
boolean 
optional
Whether there are errors associated with the shipment.
errorDetails
array[string] | null 
optional
List of error messages
hasWarnings
boolean 
optional
Whether there are warnings associated with the shipment.
warningDetails
array[string] | null 
optional
List of warning messages
status
enum<string> 
optional
Allowed values:
ImportedCreatedManifested
canUpdate
boolean 
optional
Flag whether shipment can be updated
canPrepare
boolean 
optional
Flag whether shipment can be prepared
canSubmit
boolean 
optional
Flag whether shipment can be submitted
createdOn
string <date-time>
optional
Created timestamp.
submittedOn
string <date-time> | null 
optional
Submitted timestamp.
arrivalInfo
object (ShipmentArrivalViewInfo) 
optional
arrivalGateway
string  | null 
optional
Shipment arrival gateway
transportNr
string  | null 
optional
Transport number, such as flight number or truck number
originCountryCode
string  | null 
optional
Origin country code
totalWeight
number <double> | null 
optional
Total shipment weight
totalBags
integer <int32> | null 
optional
Total amount of bags in shipment
arrivalOn
string <date-time> | null 
optional
Estimated arrival date/time
notes
string  | null 
optional
Shipment arrival notes
type
enum<string> 
optional
Allowed values:
VirtualDespatchAWBCMRCourierLabelsMailTransitPostalLastMileTransportReturnsHAWB
transactionType
enum<string> 
optional
Allowed values:
B2CC2CMixed
manifestLevel
enum<string> 
optional
Allowed values:
ParcelBag
shipmentNr
string  | null 
optional
Shipment reference number or document number. Auto-generated if not present.
masterNr
string  | null 
optional
Shipment master number.
terminalCode
string  | null 
optional
Arrival terminal code
totalItems
integer <int32>
optional
Total number of parcels in shipment.
totalItemsCancelled
integer <int32>
optional
Total number of cancelled items in shipment.
totalWeight
number <double>
optional
Gross weight of bags in shipment in kilograms.
totalWeightCancelled
number <double>
optional
Total cancelled items weight in kilograms
totalBags
integer <int32>
optional
Total number of bags in shipment.
parcelWarnings
integer <int32>
optional
Total number of parcel warnings.
parcelErrors
integer <int32>
optional
Total number of parcel errors.
Example
{
  "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
}
Previous
Create new shipment.
Next
Get shipment details.
Built with