Order Cancel Ep

POST 
/v1/order/cancel

Cancel Order

Marks the order as canceled in Crossroads and then sends the cancellation to the destination system.

Required Scopes (order:cancel)

Headers

Header	Type	Required	Description
X-Tenant-Name	str	No	Name of the origin tenant making the request. Optional if you are authenticated by API key.
X-Origin-Instance-Name	str | None	No	Name of the instance creating the request. Optional if you are authenticated by API key.
X-Dest-Tenant-Name	str	Yes	Name of the destination tenant that will receive the request

Request

order: OrderRequest
Identifies the order to be canceled. 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.

---

reason_code: str | None = None
Optional reason code for the cancellation (max 30 characters).

Response

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

Integration Stages

pending
The request has been accepted and is being processed asynchronously.

requested
The order has been created and is awaiting manual acceptance by the destination tenant.

origin_mapped
The order has been received by crossroads and needs mapping to crossroads master data.

master_mapped
The order has been mapped to crossroads master data and needs mapping to the destination system.

destination_mapped
The order has been mapped to the destination system and is ready to be sent.

synced
The order has been successfully sent to the destination system.

canceled
The order has been canceled.

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

rejected
The order 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.

Responses

200

Successful Response

application/json

Example (from schema)

{
  "status": "origin_mapped",
  "log": {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "title": "string",
    "date": "2026-05-11T19:25:51.332Z",
    "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...