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}

Get Shipments

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

sourceId

string

required

objectReferenceId

string

required

Defines which shipment(s)

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Request 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

array of:

data

object

optional

objectReferenceId

string

optional

External object identifier

Example:

DD1C35DF-7144-4FD1-8969-F34106947DC4

clientReferenceId

string

optional

External client identifier

Example:

Scan Center 4

receivedAt

string

optional

ISO 8601 UTC timestamp at which the shipment was received at the scanning Center

Example:

2022-06-27T12:00:00Z

redirectionLine

string

optional

Redirection line printed by POST, including information about final receiver

Example:

C/O PEAX ID 566 8323 4461 55 POSTFACH 71/5430 WETTINGEN 2

processType

enum<string>

optional

Allowed values:

REGULARNON_SCANNABLEPARTIALLY_NON_SCANNABLE

isEnvelopeIncluded

boolean

optional

Shipment includes image of envelope

isRegisteredLetter

boolean

optional

Statement if the letter was a registered letter or not

separationInfo

array[object (SeparationInput) {2}]

optional

Separation informations describing start and end pages per document

address-lines

array[string]

optional

file

string <binary>

required

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