Link parcels with specified bag numbers to a shipment.

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

or

Path Params

Header Params

Body Params application/json-patch+json

Example

{
    "bagNrs": "bag-001,bag-002",
    "unlinkOtherBagsIfAny": true,
    "ensureOnlyIncludedBags": true,
    "allowPartialSuccess": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.test.post-plus.io/api/v1/shipments//link-bags' \
--header 'Accept: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bagNrs": "bag-001,bag-002",
    "unlinkOtherBagsIfAny": true,
    "ensureOnlyIncludedBags": true,
    "allowPartialSuccess": true
}'

Responses

🟢200OK

application/json

OK

Body

Example

{
    "successParcelsCount": 5,
    "failedParcelsCount": 1,
    "parcels": [
        {
            "identifiers": {
                "id": 1234,
                "parcelNr": "RS12345678US",
                "senderParcelNr": "client-id-123"
            },
            "references": {
                "shipmentId": 0,
                "shipmentNr": "123-000000123",
                "bagNr": "bag-001",
                "carrier": "string",
                "carrierServiceCode": "string",
                "carrierParcelNr": "string",
                "manifestParcelNr": "string",
                "printId": 1234567890,
                "externalIds": 1234567890
            },
            "error": "Parcel is already linked to manifested shipment SH001"
        }
    ],
    "failedParcels": [
        {
            "identifiers": {
                "id": 1234,
                "parcelNr": "RS12345678US",
                "senderParcelNr": "client-id-123"
            },
            "references": {
                "shipmentId": 0,
                "shipmentNr": "123-000000123",
                "bagNr": "bag-001",
                "carrier": "string",
                "carrierServiceCode": "string",
                "carrierParcelNr": "string",
                "manifestParcelNr": "string",
                "printId": 1234567890,
                "externalIds": 1234567890
            },
            "error": "Parcel is already linked to manifested shipment SH001"
        }
    ],
    "bagNrs": [
        "string"
    ],
    "failedBagNrs": [
        "string"
    ]
}