Order Change Reject V1 Ep

POST 
/v1/order/change/reject

Reject Order Change

Marks an order change as rejected and creates a log entry.

Required Scopes (order_change:reject)

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).

---

origin_order_number: str | None = None
Order number from the origin system.

---

destination_order_number: str | None = None
Order number in the destination system.

---

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

Response

status: IntegrationStatus
Status of the order change (will be rejected).

---

order_change: OrderChangeView
The rejected order change details.

Show Child Attributes

id: str
Unique identifier of the order change.

---

origin_order_number: str
Order number from the origin system.

---

destination_order_number: str | None = None
Order number in the destination system.

---

status: IntegrationStatus
Current status of the change.

---

change_types: list[OrderChangeType]
Types of changes in this record.

---

created_on: datetime
When the change was created.

---

updated_on: datetime | None = None
When the change was last updated.

---

origin_tenant_name: str
Name of the origin tenant.

---

destination_tenant_name: str | None = None
Name of the destination tenant.

---

rejected_reason_code: str | None = None
Reason code provided when the change was rejected.

---

submit_reason_code: str | None = None
Reason code provided when the change was submitted.

---

accept_reason_code: str | None = None
Reason code provided when the change was accepted.

---

message: str | None = None
Status message.

---

log: CrossroadsLogV2 | None = None
The log entry created for this rejection.

Responses

200

Successful Response

application/json

Example (from schema)

{
  "status": "origin_mapped",
  "order_change": {
    "id": "string",
    "origin_order_number": "string",
    "destination_order_number": "string",
    "status": "origin_mapped",
    "change_types": [
      "supply_change"
    ],
    "created_on": "2026-01-16T21:26:18.524Z",
    "updated_on": "2026-01-16T21:26:18.524Z",
    "origin_tenant_name": "string",
    "destination_tenant_name": "string",
    "required_manual_approval": false,
    "approved_by": "string",
    "approved_on": "2026-01-16T21:26:18.524Z",
    "rejected_by": "string",
    "rejected_on": "2026-01-16T21:26:18.524Z",
    "rejected_reason_code": "string",
    "submit_reason_code": "string",
    "accept_reason_code": "string"
  },
  "message": "string",
  "log": {
    "_id": "5eb7cf5a86d9755df3a6c593",
    "title": "string",
    "date": "2026-01-16T21:26:18.525Z",
    "status": "unknown",
    "severity": "low",
    "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"
    },
    "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"
    },
    "worker_name": "Crossroads",
    "correlation_id": "string",
    "retried": false,
    "group_id": "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.526Z",
      "assigned_to": "string",
      "hauled_by": "string",
      "integration": "string",
      "delivery_window_start": "2026-01-16T21:26:18.526Z",
      "delivery_window_end": "2026-01-16T21:26:18.526Z",
      "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.526Z",
      "updated_date": "2026-01-16T21:26:18.526Z",
      "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.526Z",
      "assigned_to": "string",
      "hauled_by": "string",
      "integration": "string",
      "delivery_window_start": "2026-01-16T21:26:18.526Z",
      "delivery_window_end": "2026-01-16T21:26:18.526Z",
      "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.527Z",
      "updated_date": "2026-01-16T21:26:18.527Z",
      "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.527Z",
      "assigned_to": "string",
      "hauled_by": "string",
      "integration": "string",
      "delivery_window_start": "2026-01-16T21:26:18.527Z",
      "delivery_window_end": "2026-01-16T21:26:18.527Z",
      "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.527Z",
      "updated_date": "2026-01-16T21:26:18.527Z",
      "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"
      ]
    }
  }
}

422

Validation Error

application/json

Example (from schema)

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

Loading...