Order Get Ep
POST/v1/order/get
Get Order
Gets an order in your tenant.
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| X-Tenant-Name | str | No | Name of the origin tenant making the request |
Request
order: OrderKey
Identifies the order to be fetched. 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.
Response
order: Order
The order object.
Show Child 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. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the entity in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: company_XXXXXX.
delivery_window: DeliveryWindow
Time window for delivery.
Show Child Attributes
start: datetime
Start of delivery window.
end: datetime
End of delivery window.
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: SiteMappingKey
Delivery site reference. At least one of mapping_id, source_name, source_id, or goid must be provided. If using mapping_id, source_name, or source_id, tank_id is required. If using goid, tank_goid is required.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping. Requires tank_id to be set.
source_name: str | None = None
Display name of the site in the source system. Matched against the mapping's display_name field. Requires tank_id to be set.
source_id: str | None = None
Unique identifier of the site in the source system. Matched against the mapping's source_id field. Requires tank_id to be set.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided except tank_goid. Format: site_XXXXXX.
tank_id: str | None = None
Tank identifier at the site in the source system. Required when using mapping_id, source_name, or source_id. Max 10 characters.
tank_goid: str | None = None
Tank Gravitate Object ID. Required when using goid. Format: tank_XXXXXX. Max 50 characters.
product: ProductMappingKey | None = None
Product being delivered. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the product in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the product in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: product_XXXXXX.
volume: int
Volume to deliver in gallons.
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. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the terminal in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the terminal in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: terminal_XXXXXX.
product: ProductMappingKey | None = None
Product to load. Only set when creating blends - otherwise inherited from drop. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the product in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the product in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: product_XXXXXX.
supplier: CounterpartyMappingKey | None = None
Supplier providing the product. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the supplier in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the supplier in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: company_XXXXXX.
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. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the terminal in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the terminal in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: terminal_XXXXXX.
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 Child Attributes
supplier: CounterpartyMappingKey
Supplier of the product on this line item. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the supplier in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the supplier in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: company_XXXXXX.
product: ProductMappingKey
Product supplied on this line item. At least one of mapping_id, source_name, source_id, or goid must be provided.
Show Child Attributes
mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.
source_name: str | None = None
Display name of the product in the source system. Matched against the mapping's display_name field.
source_id: str | None = None
Unique identifier of the product in the source system. Matched against the mapping's source_id field.
goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: product_XXXXXX.
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.
extra_data: dict = {}
Additional custom data from the source system.
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": "assigned",
"eta": "2026-01-16T21:26:18.464Z",
"assigned_to": "string",
"hauled_by": "string",
"routing": {
"origin_tenant_id": "string",
"origin_tenant_name": "string",
"origin_source_system": "string",
"origin_source_system_id": "string",
"destination_tenant_id": "string",
"destination_tenant_name": "string",
"destination_source_system": "string",
"destination_source_system_id": "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-01-16T21:26:18.464Z",
"end": "2026-01-16T21:26:18.464Z",
"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": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"volume": 0,
"loads": [
{
"terminal": {
"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"
},
"supplier": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"price_type": "rack",
"contract": "string"
}
]
}
],
"bols": [
{
"bol_number": "string",
"terminal": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"sites": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"bol_date": "2026-01-16T21:26:18.465Z",
"details": [
{
"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
}
]
}
],
"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"
},
"pre_drop_volume": 0,
"pre_drop_inches": 0,
"pre_drop_time": "2026-01-16T21:26:18.465Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-01-16T21:26:18.465Z"
}
]
}
],
"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-01-16T21:26:18.465Z",
"end": "2026-01-16T21:26:18.465Z",
"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": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"volume": 0,
"loads": [
{
"terminal": {
"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"
},
"supplier": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"price_type": "rack",
"contract": "string"
}
]
}
],
"bols": [
{
"bol_number": "string",
"terminal": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"sites": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"bol_date": "2026-01-16T21:26:18.466Z",
"details": [
{
"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
}
]
}
],
"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"
},
"pre_drop_volume": 0,
"pre_drop_inches": 0,
"pre_drop_time": "2026-01-16T21:26:18.466Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-01-16T21:26:18.466Z"
}
]
}
],
"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-01-16T21:26:18.467Z",
"end": "2026-01-16T21:26:18.467Z",
"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": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"volume": 0,
"loads": [
{
"terminal": {
"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"
},
"supplier": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"price_type": "rack",
"contract": "string"
}
]
}
],
"bols": [
{
"bol_number": "string",
"terminal": {
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
},
"sites": [
{
"mapping_id": "5eb7cf5a86d9755df3a6c593",
"source_name": "string",
"source_id": "string",
"goid": "string",
"goid_name": "string"
}
],
"bol_date": "2026-01-16T21:26:18.467Z",
"details": [
{
"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
}
]
}
],
"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"
},
"pre_drop_volume": 0,
"pre_drop_inches": 0,
"pre_drop_time": "2026-01-16T21:26:18.468Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-01-16T21:26:18.468Z"
}
]
}
],
"extra_data": {}
},
"created_at": "2026-01-16T21:26:18.468Z",
"updated_at": "2026-01-16T21:26:18.468Z"
}
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}