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. BOL images provided are stored in Crossroads.

Required Scopes (order:save_bol)

Headers

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

Request (multipart/form-data)

order: OrderRequest
Identifies the order this BOL belongs to. Provide either field - the system resolves direction automatically.

Show Attributes

order_id: str | None = None
The Crossroads order ID (if known).

---

order_number: str | None = None
Your order number. Can be either your system's number or your partner's - the system determines which based on the authenticated tenant pair.

---

bol_number: str
Bill of Lading number identifier.

---

note: str | None = None
Optional note to attach to the BOL image.

---

file: UploadFile
Image file to be saved.

Response

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.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

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

Loading...