Bol Save Ep

POST 
/v1/order/save_bol

Save Bill of Lading

Saves a Bill of Lading (BOL) for an order and sends it to the destination system.

Required Scopes (order:save_bol)

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

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.

---

terminal: TerminalMappingKey
Terminal where the BOL originated.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

bol_date: datetime
Date and time the BOL was issued.

---

details: list[BOLDetailRequest]
List of BOL line items. Each detail represents a distinct product/supplier combination on the BOL.

Show Child Attributes

site: SiteTankMappingKey
Delivery site for this line item.

Show SiteTankMappingKey Attributes

To choose site, at least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id. To choose tank, at least one of tank_id or product_source_id must be provided. Crossroads recommends that you provide tank_id. If you provide product_source_id, only tanks that have a product ID can be chosen. If two tanks have the same product ID, the one with the lowest ID will be chosen.

---

source_id: str | None = None
Unique identifier of the site in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the site in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the site mapping record. Use when you have previously looked up or cached the mapping.

---

tank_id: str | None = None
Tank ID of the tank to be selected. Matched against the tanks at the site.

---

product_source_id: str | None = None
Product ID for a product contained in a tank at the site.

---

supplier: CounterpartyMappingKey
Supplier for this line item.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

product: ProductMappingKey
Product on this line item.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

contract: str | None = None
Contract identifier if this line item was sourced under a contract.

---

price_type: PriceType | None = None
Pricing methodology for this line item.

rack - Spot rack price at the terminal.

contract - Negotiated contract price.

index - Index-based pricing (e.g., OPIS).

inventory - Priced from existing inventory.

spot - Spot market price.

---

net_volume: float
Net volume delivered in gallons. This is the actual fuel volume after temperature correction.

---

gross_volume: float
Gross volume in gallons. Measured volume before temperature correction.

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: CrossroadsBOL | None = None
The saved BOL record.

Show Child Attributes

bol_number: str
Unique Bill of Lading identifier.

---

terminal: TerminalMappingKey
Terminal where the product was picked up.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

bol_date: datetime
Date and time the BOL was issued.

---

details: list[BOLDetail]
Line items on the BOL.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

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

Loading...