Skip to main content

Order Change All V1 Ep

POST 
/v1/order/change/all

List Order Changes

Returns order changes matching filters. Results limited to 3000 items.

Required Scopes (order_change:read)

Headers​

HeaderTypeRequiredDescription
X-Tenant-NamestrNoName of the tenant making the request

Request​

At least one filter is required.

status: IntegrationStatus | None = None
Filter by status (requested, rejected, synced).

order_numbers: list[str] | None = None
Filter by origin order numbers.

change_types: list[OrderChangeType] | None = None
Filter by change type.

Change Types

supply_change - Supply/load information changed.

destination_change - Drop site changed.

delivery_window_change - Delivery window changed.

as_of: datetime | None = None
Return changes created on or after this datetime. Mutually exclusive with updated_as_of and between.

updated_as_of: datetime | None = None
Return changes updated on or after this datetime. Mutually exclusive with as_of and between.

between: DateWindow | None = None
Return changes created within date range. Mutually exclusive with as_of and updated_as_of.

Show Child Attributes

from_date: datetime
Start of date range.

to_date: datetime
End of date range.

origin_system_name: str | None = None
Filter by origin system name.

destination_system_name: str | None = None
Filter by destination system name.


Response​

Returns a list of OrderChangeView objects.

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.

Responses​

Successful Response

[
  {
    "id": "string",
    "origin_order_number": "string",
    "destination_order_number": "string",
    "status": "origin_mapped",
    "change_types": [
      "supply_change"
    ],
    "created_on": "2026-01-16T21:26:18.513Z",
    "updated_on": "2026-01-16T21:26:18.513Z",
    "origin_tenant_name": "string",
    "destination_tenant_name": "string",
    "required_manual_approval": false,
    "approved_by": "string",
    "approved_on": "2026-01-16T21:26:18.513Z",
    "rejected_by": "string",
    "rejected_on": "2026-01-16T21:26:18.513Z",
    "rejected_reason_code": "string",
    "submit_reason_code": "string",
    "accept_reason_code": "string"
  }
]
Loading...