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.

Upload the XML Document

Designing

POST

https://proxy-stage.peax.ch/document-partner-service/agent-api/api/v1/sources/{sourceId}/accounts/{accountPeaxId}/documents/{documentId}/xml

xml

Send an xml document

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

sourceId

string

required

accountPeaxId

string

required

documentId

string

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params multipart/form-data

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/document-partner-service/agent-api/api/v1/sources//accounts//documents//xml' \
--header 'Authorization: Bearer {{JWT}}' \
--form 'file=@""'

Responses

🟢200Shipment Successfull received

application/json

Body

object {0}

Example

{}

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

Modified at 2024-07-29 11:49:31

Send external metadata

Get content of XML Document