Skip to main content

Bol Images V1 Ep

POST 
/v1/bol_images

Retrieve BOL Photos

Retrieves links to Bill of Lading (BOL) photos associated with specified orders, aiding in the verification and documentation of shipments.

Required Scopes (io.r)

Request​

order_ids: list[str] | None
A list of unique identifiers for orders. Can be left empty if order_numbers is provided.

order_numbers: list[str] | None
A list of order numbers. Can be left empty if order_ids is provided.

Providing both order_ids and order_numbers will extend the search to include all specified identifiers.


Response​

The response includes details about the BOL and associated photos for each specified order:

order_id: str | None = None
The unique identifier of the order. null if the order cannot be found.

bol_id: str | None = None
The unique identifier of the Bill of Lading. null if no BOL is associated with the order.

bol_number: str | None = None
The Bill of Lading number. null if no BOL number is associated with the order.

photos: list | None
A list containing details of each photo associated with the BOL, including:

Show Child Attributes

type: str | None = None
The type or category of the photo (e.g., "delivery", "damage"). null if not specified.

note: str | None = None
Any additional notes or descriptions provided for the photo. null if no notes are available.

url: str | None = None
The URL to access the photo. null if the photo is not available.

file_type: str = "image"
The file type of the attachment: "image" for image files (JPEG, PNG) or "pdf" for PDF documents. Defaults to "image".

Responses​

Successful Response

[
  {
    "order_id": "string",
    "bol_id": "string",
    "bol_number": "string",
    "photos": [
      {
        "type": "string",
        "note": "string",
        "url": "string",
        "file_type": "image"
      }
    ]
  }
]
Loading...