Bol Image Save Ep

POST /v1/order/save_bol_image

Save Bill of Lading Image

Saves a BOL Image for a BOL on the order and sends it to the destination system.

Required Scopes (order:save_bol)

Header	Type	Required	Description
X-Tenant-Name	str	No	Name of the origin tenant making the request
X-Dest-Tenant-Name	str	Yes	Name of the destination tenant that will receive the BOL
X-Origin-System-Name	str \| None	No	Name of the origin system. If not provided, uses the tenant's primary system

order: OrderKey
Identifies the order this BOL belongs to. At least one field is required.

Show Child Attributes

origin_order_number: str | None = None
Order number from the origin system.

destination_order_number: int | None = None
Order number in the destination system.

order_id: str | None = None
ID of the order.

bol_number: str
Bill of Lading number identifier.

file: File
Image file to be saved

status: str
Crossroads integration status. Each status represents a step in the integration pipeline.

Integration Stages

origin_mapped
The order has been received by crossroads and needs mapping to crossroads master data.

master_mapped
The order has been mapped to crossroads master data and needs mapping to the destination system.

destination_mapped
The order has been mapped to the destination system and is ready to be sent.

synced
The order has been successfully sent to the destination system.

error
An error occurred during processing. Check the message and log for details.

rejected
The order was rejected by the destination system. Check the message and log for details.

bol_image: CrossroadsBOLImage | None = None
The saved BOL image record.

Show Child Attributes

bol_number: str
Unique Bill of Lading identifier.

file: File
Image file that was saved

message: str | None = None
Status message or error details.

Successful Response

Validation Error

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}