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.

Download forwarding cover letter

GET

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

cover letter

Download cover letter

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

sourceId

string

required

shipmentId

string

required

Defines which shipment needs a cover letter

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//media/shipments//cover-letter' \
--header 'Authorization: Bearer {{JWT}}'

Responses

🟢200Cover letter in pdf format

application/json

Body

object {0}

Example

{}

🟠400Bad request

🟠401Unauthorized

🟠403Permission denied

🔴500Internal server error

Modified at 2024-02-29 01:37:04

Forwarding shipments

Close the forwarding process