Delivery Reconciliation Match Overview Ep
POST/v1/delivery_reconciliation/match/overview
Delivery Reconciliation Match Overview
Retrieves delivery reconciliation matches filtered by delivery/order/BOL IDs and/or a date range,
with optional store and status filtering.
Provides a simplified view of delivery-to-order matching data for easier integration.
Must provide at least one of delivery_ids, order_ids, bol_ids, or a from_date/to_date pair.
Request
delivery_ids: list[str] | None = None
Optional list of delivery IDs; filter results to matches containing any of these deliveries.
order_ids: list[str] | None = None
Optional list of order IDs; filter results to matches containing any of these orders.
bol_ids: list[str] | None = None
Optional list of BOL IDs; filter results to matches containing any of these BOLs.
from_date: datetime | None = None
The start date and time (inclusive) for which to retrieve delivery reconciliation matches.
If a tz-naive object is given, it is assumed the value is in the provided timezone (UTC by default).
If provided, to_date must also be provided.
to_date: datetime | None = None
The end date and time (inclusive) for which to retrieve delivery reconciliation matches.
If a tz-naive object is given, it is assumed the value is in the provided timezone (UTC by default).
If provided, from_date must also be provided.
store_id: str | None = None
Optional store ID to filter results to a specific store. Cannot be used without date or ID parameters.
status: str | None = None
Optional status filter. Valid values: "approved", "unmatched", "matched", "voided". Cannot be used without date or
ID parameters.
timezone: str = "UTC"
Optional timezone for the from_date and to_date parameters, if the objects are tz-naive. No effect for datetimes
with tz offsets.
Response
results: list
List of match result objects, each containing:
Show Result Attributes
order_ids: list[str]
List of order IDs associated with the matches.
bol_ids: list[str]
List of BOL IDs associated with the matches.
delivery_ids: list[str]
List of delivery IDs associated with the matches.
matches: list
List of match details, each containing:
Show Match Attributes
match_id: str
Unique identifier for the match.
match_date: datetime
The date when the match was created.
deliveries: list
List of delivery records in this match (may contain null values), each containing:
Show Delivery Attributes
delivery_id: str
Unique identifier for the delivery.
delivery_number: str
The delivery number.
date: datetime
Date of the delivery.
store_id: str
Store identifier.
store_number: str
Store number.
store_name: str
Name of the store.
tank_id: str
Tank identifier.
product_id: str
Product identifier.
product: str
Product name.
volume: float
Volume delivered.
net_volume: float
Net volume delivered.
gross_volume: float
Gross volume delivered.
bols: list
List of BOL records in this match, each containing:
Show BOL Attributes
bol_id: str
Unique identifier for the BOL.
bol_number: str
The BOL number.
order_id: str
Associated order identifier.
order_number: str
Associated order number.
purchase_order: str
Purchase order number.
date: datetime
Date of the BOL.
store_id: str
Store identifier.
store_number: str
Store number.
store_name: str
Name of the store.
tank_id: str
Tank identifier.
product_id: str
Product identifier.
product: str
Product name.
volume: float
Volume on BOL.
net_volume: float
Net volume on BOL.
gross_volume: float
Gross volume on BOL.
po_numbers: list[str]
List of purchase order numbers.
products: list[str]
List of product names.
status: str
The current status of the match (e.g., "approved", "unmatched", "matched", "voided").
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
{
"results": [
{
"order_ids": [
"string"
],
"bol_ids": [
"string"
],
"delivery_ids": [
"string"
],
"matches": [
{
"match_id": "string",
"match_date": "2026-09-25T19:33:18.404Z",
"deliveries": [
{
"delivery_id": "string",
"delivery_number": "string",
"date": "2026-09-25T19:33:18.404Z",
"store_id": "string",
"store_number": "string",
"store_name": "string",
"tank_id": "string",
"product_id": "string",
"product": "string",
"volume": 0,
"net_volume": 0,
"gross_volume": 0,
"estimated_taxes": {
"id": "string",
"parent": "string",
"created_at": "2026-09-25T19:33:18.404Z",
"type": "tax",
"status": "open",
"reversed": false,
"transactions": [
{
"model_type": "base",
"type": "string",
"subtype": "string",
"rate": 0,
"amount": 0,
"total": 0,
"uom": "string",
"errors": [
"string"
],
"id": "5eb7cf5a86d9755df3a6c593",
"transaction_line": 0,
"invoice_line": 0,
"country_code": "string",
"jurisdiction": "string",
"local_jurisdiction": "string",
"product_category": 0,
"taxing_level": "string",
"tax_type": "string",
"rate_type": "string",
"rate_subtype": "string",
"calculation_type_ind": "string",
"tax_quantity": 0,
"tax_exempt_ind": "string",
"deferred_ind": "string",
"sales_tax_base_amount": 0,
"license_number": "string",
"scenario_id": 0,
"rate_description": "string",
"currency": "string",
"quantity_ind": "string"
}
]
},
"used_price_curve_id": "string",
"used_price_id": "string",
"amount": 0,
"total_value": 0
},
null
],
"bols": [
{
"bol_id": "string",
"bol_number": "string",
"order_id": "string",
"order_number": "string",
"purchase_order": "string",
"date": "2026-09-25T19:33:18.405Z",
"store_id": "string",
"store_number": "string",
"store_name": "string",
"tank_id": "string",
"product_id": "string",
"product": "string",
"volume": 0,
"net_volume": 0,
"gross_volume": 0
}
],
"po_numbers": [
"string"
],
"products": [
"string"
],
"status": "string"
}
]
}
]
}
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}