We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Get shipments by object reference id

GET

https://proxy-stage.peax.ch/core-service-input-scanning/agent-api/sources/{sourceId}/shipments/objectReferenceId/{objectReferenceId}

Receive all shipments by object reference id

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://proxy-stage.peax.ch/core-service-input-scanning/agent-api/sources//shipments/objectReferenceId/' \
--header 'Authorization: Bearer {{JWT}}'

Responses

🟢200Shipment(s) found

application/json

Body

Example

[
    {
        "data": {
            "objectReferenceId": "DD1C35DF-7144-4FD1-8969-F34106947DC4",
            "clientReferenceId": "Scan Center 4",
            "receivedAt": "2022-06-27T12:00:00Z",
            "redirectionLine": "C/O PEAX ID 566 8323 4461 55 POSTFACH 71/5430 WETTINGEN 2",
            "processType": "REGULAR",
            "isEnvelopeIncluded": true,
            "isRegisteredLetter": true,
            "separationInfo": [
                {
                    "from": 0,
                    "to": 0
                }
            ],
            "address-lines": [
                "string"
            ]
        },
        "file": "string"
    }
]

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

Modified at 2024-02-29 01:36:51

Deliver Shipment to PEAX

Forwarding shipments