Order Get Ep
POST/v1/order/get
Get Order
Gets an order for the authenticated tenant pair.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| X-Tenant-Name | str | No | Name of the origin tenant making the request |
Request
order: OrderRequest
Identifies the order. 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.
Response
order: Order
The order object.
Show Order Attributes
origin_order_number: str
Order number from the origin system.
destination_order_number: str | None = None
Order number assigned by the destination system after being received.
po: str | None = None
Purchase order number.
supply_owner: CounterpartyMappingKey | None = None
The company responsible for supply.
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.
delivery_window: DeliveryWindow
Time window for delivery.
Show DeliveryWindow Attributes
start: datetime
Start of delivery window.
end: datetime
End of delivery window. End date must be after start date.
timezone: str = "UTC"
Timezone name.
note: str | None = None
Order notes (max 300 characters).
drops: list[Drop]
List of delivery drops on the order.
Show Child Attributes
site: SiteTankMappingKey
Delivery site reference. Either tank_id on the site or product on the drop must be provided for tank resolution.
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.
product: ProductMappingKey | None = None
Product being delivered. Required if tank_id is not provided on the site.
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.
volume: int
Volume to deliver in gallons.
extra_data: dict = {}
Additional custom data for this drop.
loads: list[Load] = []
Supply source instructions for this drop. Each load specifies where and how product will be sourced. A load is considered fully qualified when terminal, product, supplier, and price_type are all provided.
Show Child Attributes
terminal: TerminalMappingKey | None = None
Loading terminal for pickup.
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 | None = None
Product to load.
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.
supplier: CounterpartyMappingKey | None = None
Supplier providing the product.
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.
price_type: PriceType | None = None
Pricing methodology for the supply option.
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.
contract: str | None = None
Contract identifier when price_type is "contract". Max 100 characters.
bols: list[BOL] = []
Bills of Lading associated with completed deliveries. BOLs provide proof of shipment and delivery details.
Show Child Attributes
bol_number: str
Unique Bill of Lading identifier issued by the carrier or terminal.
terminal: TerminalMappingKey
Loading terminal where 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. Each detail represents a distinct product/supplier combination on the BOL.
Show BOLDetail 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 of the 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.
product: ProductMappingKey
Product supplied 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.
bol_photos: list[BOLPhotoReference] = []
References to BOL photos stored in the system.
Show BOLPhotoReference Attributes
bol_number: str
BOL number this photo is associated with.
file_name: str
File name of the stored photo.
uploaded_at: datetime
When the photo was uploaded.
note: str | None = None
Optional note about the photo.
executed_drops: list[ExecutedDrop] = []
Drop measurement records for completed deliveries.
Show ExecutedDrop Attributes
site: SiteMappingKey
Delivery site where the drop was executed.
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.
mode: str
How to apply this record. "replace" replaces existing records for this site, "append" adds to them.
details: list[ExecutedDropDetail]
Individual product measurements for this drop.
Show Child Attributes
product: ProductMappingKey
Product being dropped.
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.
quantity: float
Volume delivered in gallons.
tank: SiteTankMappingKey | None = None
Tank where the product was dropped.
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.
pre_drop_volume: float | None = None
Tank volume in gallons before delivery.
pre_drop_inches: float | None = None
Tank stick measurement in inches before delivery.
pre_drop_time: datetime | None = None
Time of pre-drop measurement.
post_drop_volume: float | None = None
Tank volume in gallons after delivery.
post_drop_inches: float | None = None
Tank stick measurement in inches after delivery.
post_drop_time: datetime
Time of post-drop measurement.
extra_data: dict = {}
Additional custom data from the source system. This data will be preserved on the order.
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
{
"_id": "5eb7cf5a86d9755df3a6c593",
"status": "origin_mapped",
"failed_at_step": "origin_mapped",
"progression_state": "No Progress",
"trip_status": "no_progress",
"eta": "2026-05-11T19:25:51.297Z",
"delivery_eta": "2026-05-11T19:25:51.297Z",
"assigned_to": "string",
"hauled_by": "string",
"hauled_by_id": "string",
"hauled_for": "string",
"hauled_for_id": "string",
"units": "gallons",
"routing": {
"origin_tenant_id": "string",
"origin_tenant_name": "string",
"origin_source_system": "string",
"origin_source_system_id": "string",
"origin_instance_id": "string",
"origin_instance_name": "string",
"destination_tenant_id": "string",
"destination_tenant_name": "string",
"destination_source_system": "string",
"destination_source_system_id": "string",
"destination_instance_id": "string",
"destination_instance_name": "string"
},
"origin_order": {
"origin_order_number": "string",
"destination_order_number": "string",
"po": "string",
"supply_owner": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"delivery_window": {
"start": "2026-05-11T19:25:51.297Z",
"end": "2026-05-11T19:25:51.297Z",
"timezone": "UTC"
},
"note": "string",
"drops": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"volume": 0,
"loads": [
{
"terminals": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"products": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"suppliers": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"price_types": [
"rack"
],
"contracts": [
"string"
]
}
],
"extra_data": {}
}
],
"bols": [
{
"bol_number": "string",
"terminal": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"bol_date": "2026-05-11T19:25:51.298Z",
"details": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"supplier": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"contract": "string",
"price_type": "rack",
"net_volume": 0,
"gross_volume": 0
}
],
"sites": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
]
}
],
"bol_photos": [
{
"bol_number": "string",
"file_name": "string",
"uploaded_at": "2026-05-11T19:25:51.298Z",
"note": "string"
}
],
"executed_drops": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"mode": "replace",
"details": [
{
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"quantity": 0,
"tank": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"pre_drop_volume": 0,
"pre_drop_inches": 0,
"pre_drop_time": "2026-05-11T19:25:51.298Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-05-11T19:25:51.298Z"
}
]
}
],
"extra_data": {}
},
"master_order": {
"origin_order_number": "string",
"destination_order_number": "string",
"po": "string",
"supply_owner": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"delivery_window": {
"start": "2026-05-11T19:25:51.299Z",
"end": "2026-05-11T19:25:51.299Z",
"timezone": "UTC"
},
"note": "string",
"drops": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"volume": 0,
"loads": [
{
"terminals": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"products": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"suppliers": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"price_types": [
"rack"
],
"contracts": [
"string"
]
}
],
"extra_data": {}
}
],
"bols": [
{
"bol_number": "string",
"terminal": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"bol_date": "2026-05-11T19:25:51.299Z",
"details": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"supplier": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"contract": "string",
"price_type": "rack",
"net_volume": 0,
"gross_volume": 0
}
],
"sites": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
]
}
],
"bol_photos": [
{
"bol_number": "string",
"file_name": "string",
"uploaded_at": "2026-05-11T19:25:51.299Z",
"note": "string"
}
],
"executed_drops": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"mode": "replace",
"details": [
{
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"quantity": 0,
"tank": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"pre_drop_volume": 0,
"pre_drop_inches": 0,
"pre_drop_time": "2026-05-11T19:25:51.300Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-05-11T19:25:51.300Z"
}
]
}
],
"extra_data": {}
},
"destination_order": {
"origin_order_number": "string",
"destination_order_number": "string",
"po": "string",
"supply_owner": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"delivery_window": {
"start": "2026-05-11T19:25:51.300Z",
"end": "2026-05-11T19:25:51.300Z",
"timezone": "UTC"
},
"note": "string",
"drops": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"volume": 0,
"loads": [
{
"terminals": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"products": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"suppliers": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"price_types": [
"rack"
],
"contracts": [
"string"
]
}
],
"extra_data": {}
}
],
"bols": [
{
"bol_number": "string",
"terminal": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"bol_date": "2026-05-11T19:25:51.301Z",
"details": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"supplier": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"contract": "string",
"price_type": "rack",
"net_volume": 0,
"gross_volume": 0
}
],
"sites": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
]
}
],
"bol_photos": [
{
"bol_number": "string",
"file_name": "string",
"uploaded_at": "2026-05-11T19:25:51.301Z",
"note": "string"
}
],
"executed_drops": [
{
"site": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"mode": "replace",
"details": [
{
"product": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"quantity": 0,
"tank": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string",
"tank_id": "string",
"tank_goid": "string",
"tank_goid_name": "string",
"product_source_id": "string"
},
"pre_drop_volume": 0,
"pre_drop_inches": 0,
"pre_drop_time": "2026-05-11T19:25:51.301Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-05-11T19:25:51.301Z"
}
]
}
],
"extra_data": {}
},
"created_at": "2026-05-11T19:25:51.301Z",
"updated_at": "2026-05-11T19:25:51.301Z"
}
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}