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 object to PEAX

POST

https://proxy-stage.peax.ch/core-service-input-partner/agent-api/v1/partners/{partnerId}/documents

partnerInputApi

Send Multipart data (containing file and data) 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

partnerId

string

required

The partner unique ID

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 POST 'https://proxy-stage.peax.ch/core-service-input-partner/agent-api/v1/partners//documents' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: text/plain' \
--data-raw ''

Responses

🟢200Input Object successfully received

application/json

Body

shipmentId

string

optional

handled shipment ID

objectReferenceId

string

optional

uniqely object identifier in the external system (any uuid)

Example:

123e4567-e89b-12d3-a456-426614174000

clientReferenceId

string

optional

uniqely identifier for the client in the external system (any uuid)

Example:

123e4567-e89b-12d3-a456-426614174000

Example

{
  "shipmentId": "string",
  "objectReferenceId": "123e4567-e89b-12d3-a456-426614174000",
  "clientReferenceId": "123e4567-e89b-12d3-a456-426614174000"
}

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

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

Search for a PEAX user

Overview