Get documents for the specified shipment.

POST

/api/v3/shipments/{Id}/GetDocuments

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Body Params application/json

Example

{
    "documentTypes": [
        "banyan_bol"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/api/v3/shipments//GetDocuments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documentTypes": [
        "banyan_bol"
    ]
}'

Responses

🟢200Success

application/json

Body

Example

[
    {
        "documentType": "Banyan_BOL",
        "base64Documents": [
            "string"
        ],
        "zplDocuments": [
            "string"
        ],
        "success": true,
        "error": {
            "message": "string"
        }
    }
]

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Modified at 2024-09-16 11:42:17

Get Reference Numbers for a Shipment

Book a Shipment

Get documents for the specified shipment.

Get documents related to the specified shipment.#

Request

Request Code Samples

Responses

Get documents related to the specified shipment.