Order Change Accept V1 Ep
POST/v1/order/change/accept
Accept Order Change
Accepts an order change, applies the changes to the order, marks it as synced, and creates a log entry.
Required Scopes (order_change:accept)
Headers
| Header | Type | Required | Description |
|---|---|---|---|
| X-Tenant-Name | str | No | Name of the origin tenant making the request |
| X-Dest-Tenant-Name | str | Yes | Name of the destination tenant |
Request
At least one identifier is required.
id: str | None = None
Unique identifier of the order change (from /order/change/all response).
order: OrderKey | None = None
Identifies the order associated with the change.
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
The Crossroads order ID.
reason_code: str | None = None
Optional reason code for the acceptance (max 30 characters).
Response
origin_order_number: str
Order number from the origin system.
destination_order_number: str | None = None
Order number in the destination system.
delivery_window: DeliveryWindow
The delivery time window for the order.
note: str | None = None
Notes associated with the order.
drops: list[Drop]
List of drop locations and details.
extra_data: dict = {}
Additional data associated with the order.
Responses
- 200
- 422
Successful Response
- application/json
- Example (from schema)
{
"status": "origin_mapped",
"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.540Z",
"end": "2026-01-16T21:26:18.540Z",
"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.540Z",
"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.541Z",
"post_drop_volume": 0,
"post_drop_inches": 0,
"post_drop_time": "2026-01-16T21:26:18.541Z"
}
]
}
],
"extra_data": {}
},
"message": "string",
"order_row": {
"internal_order": {
"id": "string",
"internal_order_number": "string",
"partner_order_number": "string",
"po": "string",
"status": "origin_mapped",
"order_status": "No Progress",
"trip_status": "assigned",
"eta": "2026-01-16T21:26:18.541Z",
"assigned_to": "string",
"hauled_by": "string",
"integration": "string",
"delivery_window_start": "2026-01-16T21:26:18.541Z",
"delivery_window_end": "2026-01-16T21:26:18.541Z",
"product_ratios": [
{
"name": "string",
"amount": 0,
"volume": 0
}
],
"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"
}
]
}
],
"suppliers": [
"string"
],
"origins": [
"string"
],
"destinations": [
"string"
],
"created_date": "2026-01-16T21:26:18.541Z",
"updated_date": "2026-01-16T21:26:18.541Z",
"updated_by": "string",
"created_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"
},
"failed_log_id": "string",
"integration_error_title": "string",
"integration_error_message": "string",
"pending_change_id": "string",
"pending_change_types": [
"string"
]
},
"partner_order": {
"id": "string",
"internal_order_number": "string",
"partner_order_number": "string",
"po": "string",
"status": "origin_mapped",
"order_status": "No Progress",
"trip_status": "assigned",
"eta": "2026-01-16T21:26:18.542Z",
"assigned_to": "string",
"hauled_by": "string",
"integration": "string",
"delivery_window_start": "2026-01-16T21:26:18.542Z",
"delivery_window_end": "2026-01-16T21:26:18.542Z",
"product_ratios": [
{
"name": "string",
"amount": 0,
"volume": 0
}
],
"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"
}
]
}
],
"suppliers": [
"string"
],
"origins": [
"string"
],
"destinations": [
"string"
],
"created_date": "2026-01-16T21:26:18.542Z",
"updated_date": "2026-01-16T21:26:18.542Z",
"updated_by": "string",
"created_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"
},
"failed_log_id": "string",
"integration_error_title": "string",
"integration_error_message": "string",
"pending_change_id": "string",
"pending_change_types": [
"string"
]
},
"gravitate_order": {
"id": "string",
"internal_order_number": "string",
"partner_order_number": "string",
"po": "string",
"status": "origin_mapped",
"order_status": "No Progress",
"trip_status": "assigned",
"eta": "2026-01-16T21:26:18.542Z",
"assigned_to": "string",
"hauled_by": "string",
"integration": "string",
"delivery_window_start": "2026-01-16T21:26:18.542Z",
"delivery_window_end": "2026-01-16T21:26:18.542Z",
"product_ratios": [
{
"name": "string",
"amount": 0,
"volume": 0
}
],
"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"
}
]
}
],
"suppliers": [
"string"
],
"origins": [
"string"
],
"destinations": [
"string"
],
"created_date": "2026-01-16T21:26:18.542Z",
"updated_date": "2026-01-16T21:26:18.542Z",
"updated_by": "string",
"created_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"
},
"failed_log_id": "string",
"integration_error_title": "string",
"integration_error_message": "string",
"pending_change_id": "string",
"pending_change_types": [
"string"
]
}
}
}
Validation Error
- application/json
- Example (from schema)
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...