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.

Deliver Shipment to PEAX

POST

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

shipments

Send file and metadata to PEAX to be validated and forwarded to customers

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

sourceId

string

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params multipart/form-data

data

string

optional

file

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://proxy-stage.peax.ch/core-service-input-scanning/agent-api/v1/sources//shipments' \
--header 'Authorization: Bearer {{JWT}}' \
--form 'data=""' \
--form 'file=@""'

Responses

🟢200Shipment Successfull received

application/json

Body

shipmentId

string <uuid>

optional

Object identifier 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

Example

{
  "shipmentId": "DD1C35DF-7144-4FD1-8969-F34106947DC4",
  "objectReferenceId": "DD1C35DF-7144-4FD1-8969-F34106947DC4",
  "clientReferenceId": "Scan Center 4"
}

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

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

Changelog

Get shipments by object reference id