Order Reset V1 Ep

POST 
/v1/order/reset

Reset Order

Clears BOLs, executed drops, and resets the order's progression state to NO_PROGRESS in Crossroads, then sends the reset to the destination system.

This operation is used to clear delivery progress data when an order needs to be re-executed. The cleared data (BOLs and drops) is preserved in the audit log for emergency recovery.

Required Scopes (order:reset)

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 that will receive the reset
X-Origin-System-Name	str | None	No	Name of the origin system. If not provided, uses the tenant's primary system

Request

order: OrderRequest
Identifies the order to be reset. Provide either field - the system resolves direction automatically.

Show Attributes

order_id: str | None = None
The Crossroads order ID (if known).

---

order_number: str | None = None
Your order number. Can be either your system's number or your partner's - the system determines which based on the authenticated tenant pair.

Response

status: str
Crossroads integration status. Each status represents a step in the integration pipeline.

Integration Stages

origin_mapped
The reset has been received by crossroads and is being processed.

synced
The reset has been successfully applied in Crossroads and sent to the destination system.

error
An error occurred during processing. Check the message and log for details.

rejected
The reset 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. Contains the cleared BOLs and drops data in extra_data for recovery purposes.

Responses

200

Successful Response

application/json

Example (from schema)

{
  "status": "origin_mapped",
  "log": {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "title": "string",
    "date": "2026-03-19T20:39:31.978Z",
    "status": "unknown",
    "severity": "low",
    "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"
    },
    "detail": {
      "category": "crossroads",
      "message": "Unhandled System Error. Please retry or contact support.",
      "message_short": "System Error",
      "traceback": "string"
    },
    "metadata": {
      "type": "order",
      "group_id": "string",
      "origin_order_number": "string",
      "crossroads_order_id": "string"
    },
    "worker_name": "Crossroads",
    "correlation_id": "string",
    "retried": false,
    "saga_id": "string",
    "saga_type": "string",
    "send_notification": true,
    "outbound_request": {},
    "inbound_request": {}
  },
  "message": "string"
}

422

Validation Error

application/json

Example (from schema)

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

Loading...