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.

Forwarding shipments

GET

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

Receive all waiting forwardings

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Query 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/v1/sources//forwardings?type' \
--header 'actor_account_peaxid: {{actor_account_peaxid}}' \
--header 'actor_account_uuid: {{actor_account_uuid}}' \
--header 'context_account_peaxid: {{context_account_peaxid}}' \
--header 'context_account_uuid: {{context_account_uuid}}' \
--header 'Authorization: Bearer <token>'

Responses

🟢200returns forwardings

application/json

Body

Example

[
    {
        "shipmentId": "DD1C35DF-7144-4FD1-8969-F34106947DC4",
        "objectReferenceId": "DD1C35DF-7144-4FD1-8969-F34106947DC4",
        "clientReferenceId": "Scan Center 4",
        "type": "NON_SCANNABLE",
        "deliveryDate": "2023-05-26T10:03:02.195Z",
        "separationInfo": [
            {
                "from": 0,
                "to": 0
            }
        ]
    }
]

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

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

Get shipments by object reference id

Download forwarding cover letter