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

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

sourceId

string

required

Query Params

type

string

optional

Defines how to query the forwardings

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/v1/sources//forwardings?type' \
--header 'Authorization: Bearer {{JWT}}'

Responses

🟢200returns forwardings

application/json

Body

array of:

shipmentId

string <uuid>

optional

Object identifier of the requested forward from PEAX

Example:

DD1C35DF-7144-4FD1-8969-F34106947DC4

objectReferenceId

string

optional

External object identifier

Example:

DD1C35DF-7144-4FD1-8969-F34106947DC4

clientReferenceId

string

optional

External client identifier

Example:

Scan Center 4

type

enum<string>

optional

Allowed values:

NON_SCANNABLEPARTIALLY_NON_SCANNABLEPHYSICALLY_FORWARDEDORIGINAL_ORDER

deliveryDate

string

optional

ISO 8601 date when object was delivered

Example:

2023-05-26T10:03:02.195Z

separationInfo

array[object (SeparationInput) {2}]

optional

Separation informations describing start and end pages per document

from

integer

optional

document starting page in shipment

integer

optional

document ending page in shipment

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