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.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| X-Tenant-Name | str | No | Name of the origin tenant making the request. Optional if you are authenticated by API key. |
| X-Origin-Instance-Name | str | None | No | Name of the instance creating the request. Optional if you are authenticated by API key. |
| X-Dest-Tenant-Name | str | Yes | Name of the destination tenant that will receive the request |
Request (multipart/form-data)
order: OrderRequest
Identifies the order this BOL belongs to. Provide either field - the system resolves direction automatically.
Show OrderRequest Attributes
order_id: str | None = None
The Crossroads order ID (if known).
order_number: str | None = None
Your order number. Crossroads will look for orders created by you and created by others and sent to you.
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
pending
The request has been accepted and is being processed asynchronously.
requested
The order has been created and is awaiting manual acceptance by the destination tenant.
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.
canceled
The order has been canceled.
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.
message: str | None = None
Status message or error details.
log: CrossroadsLogV2 | None = None
Processing log entry.
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
Responses
- 200
- 422
Successful Response
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}