Get documents for the specified shipment.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Id

integer

required

The shipment (load) id to be canceled. Banyan supplied.

Body Params application/json

The get documents request.

documentTypes

array[string]

required

The requested document types.

>= 1 items

Allowed values:

Banyan_BOLShipping_LabelCarrier_BOLCarrier_PODCarrier_LabelAPARCarrier_Weight

shippingLabelFormat

enum<string>

optional

The format to return for shipping labels.

Allowed values:

ZPLEPLPDF

labelHasDockTabs

boolean

optional

Flag indicating whether the label has dock tabs.

convertPdfToImage

boolean

optional

Flag indicating whether pdf documents should be converted to an image.

imageFormat

enum<string>

optional

If converting pdf files to image files, the format to convert to.

Allowed values:

JPGPNG

Example

{
  "documentTypes": [
    "banyan_bol"
  ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

array of:

documentType

enum<string>

optional

Document types supported by the Get Documents endpoint.

Allowed values:

Banyan_BOLShipping_LabelCarrier_BOLCarrier_PODCarrier_LabelAPARCarrier_Weight

base64Documents

array[string] | null

optional

Documents using base 64 encoding.

zplDocuments

array[string] | null

optional

Documents using ZPL encoding.

success

boolean

optional

Flag indicating whether getting documents of this type succeeded.

error

object (BanyanWebServices.Domain.Dtos.ErrorWrapperDto)

optional

Web services 2 return error messages wrapped in a class for some reason.

message

string | null

optional

The error message.

Example

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

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Get documents related to the specified shipment.#

Request

Request samples

Responses

Get documents related to the specified shipment.