Order Change All V1 Ep

POST 
/v1/order/change/all

List Order Changes

Returns order changes matching filters. Results limited to 200 items per page.

Headers

These headers are optional if you are authenticated via API key. Your API key supplies the necessary data

Header	Type	Required	Description
X-Tenant-Name	str	No	Name of the origin tenant making the request

Request

At least one filter is required.

status: IntegrationStatus | None = None
Filter by status. Order changes are typically in requested, rejected, or synced.

Integration Status Values

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.

---

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

Determining Your Copy of the Order Change

Order changes can be sent by either of the tenants on an order, so the routing direction on the order may differ from the direction on any of its order changes. To determine which side of the order change you are interested in, check the origin and destination tenant name on the change document.

• If your tenant matches origin_tenant_name, use origin_order_change as your copy of the change and destination_order_change as the counterparty's copy.
• If your tenant matches destination_tenant_name, use destination_order_change as your copy and origin_order_change as the counterparty's copy.

Reminder: The routing direction on an order change may not match the routing direction on the original order.

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.

Integration Status Values

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.

---

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.

---

origin_order_change: OrderChange | None = None
The requested change as expressed in the origin system's terms (its order, products, and sites).

Show Child Attributes

delivery_window: DeliveryWindow | None = None
Updated time window for delivery. Omit if unchanged.

Show DeliveryWindow Attributes

start: datetime
Start of delivery window.

---

end: datetime
End of delivery window. End date must be after start date.

---

timezone: str = "UTC"
Timezone name.

---

note: str | None = None
Order notes (max 300 characters).

---

drops: list[Drop]
List of delivery drops on the order change.

Show Child Attributes

site: SiteTankMappingKey
Delivery site reference. Either tank_id on the site or product on the drop must be provided for tank resolution.

Show SiteTankMappingKey Attributes

To choose site, at least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id. To choose tank, at least one of tank_id or product_source_id must be provided. Crossroads recommends that you provide tank_id. If you provide product_source_id, only tanks that have a product ID can be chosen. If two tanks have the same product ID, the one with the lowest ID will be chosen.

---

source_id: str | None = None
Unique identifier of the site in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the site in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the site mapping record. Use when you have previously looked up or cached the mapping.

---

tank_id: str | None = None
Tank ID of the tank to be selected. Matched against the tanks at the site.

---

product_source_id: str | None = None
Product ID for a product contained in a tank at the site.

---

product: ProductMappingKey | None = None
Product being delivered. Required if tank_id is not provided on the site.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

volume: int
Volume to deliver in gallons.

---

extra_data: dict = {}
Additional custom data for this drop.

---

loads: list[Load] = []
Supply source instructions for this drop. Each load specifies where and how product will be sourced. A load is considered fully qualified when terminal, product, supplier, and price_type are all provided.

Show Child Attributes

terminal: TerminalMappingKey | None = None
Loading terminal for pickup.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

product: ProductMappingKey | None = None
Product to load.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

supplier: CounterpartyMappingKey | None = None
Supplier providing the product.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

price_type: PriceType | None = None
Pricing methodology for the supply option.

rack - Spot rack price at the terminal.

contract - Negotiated contract price.

index - Index-based pricing (e.g., OPIS).

inventory - Priced from existing inventory.

spot - Spot market price.

---

contract: str | None = None
Contract identifier when price_type is "contract". Max 100 characters.

---

load_number: str | None = None
Load number for the load. This is optional and will be passed as an additional filter to the other supply option if provided.

---

extra_data: dict = {}
Additional custom data.

---

destination_order_change: OrderChange | None = None
The requested change mapped into the destination system's terms. None until the change has been mapped to the destination.

Show Child Attributes

delivery_window: DeliveryWindow | None = None
Updated time window for delivery. Omit if unchanged.

Show DeliveryWindow Attributes

start: datetime
Start of delivery window.

---

end: datetime
End of delivery window. End date must be after start date.

---

timezone: str = "UTC"
Timezone name.

---

note: str | None = None
Order notes (max 300 characters).

---

drops: list[Drop]
List of delivery drops on the order change.

Show Child Attributes

site: SiteTankMappingKey
Delivery site reference. Either tank_id on the site or product on the drop must be provided for tank resolution.

Show SiteTankMappingKey Attributes

To choose site, at least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id. To choose tank, at least one of tank_id or product_source_id must be provided. Crossroads recommends that you provide tank_id. If you provide product_source_id, only tanks that have a product ID can be chosen. If two tanks have the same product ID, the one with the lowest ID will be chosen.

---

source_id: str | None = None
Unique identifier of the site in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the site in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the site mapping record. Use when you have previously looked up or cached the mapping.

---

tank_id: str | None = None
Tank ID of the tank to be selected. Matched against the tanks at the site.

---

product_source_id: str | None = None
Product ID for a product contained in a tank at the site.

---

product: ProductMappingKey | None = None
Product being delivered. Required if tank_id is not provided on the site.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

volume: int
Volume to deliver in gallons.

---

extra_data: dict = {}
Additional custom data for this drop.

---

loads: list[Load] = []
Supply source instructions for this drop. Each load specifies where and how product will be sourced. A load is considered fully qualified when terminal, product, supplier, and price_type are all provided.

Show Child Attributes

terminal: TerminalMappingKey | None = None
Loading terminal for pickup.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

product: ProductMappingKey | None = None
Product to load.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

supplier: CounterpartyMappingKey | None = None
Supplier providing the product.

Show MappingKey Attributes

At least one of source_id, source_name, or mapping_id must be provided. Crossroads recommends that you provide source_id.

---

source_id: str | None = None
Unique identifier of the counterparty in the source system. Matched against the mapping's source_id field.

---

source_name: str | None = None
Display name of the entity in the source system. Matched against the mapping's display_name field.

---

mapping_id: str | None = None
Database ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

price_type: PriceType | None = None
Pricing methodology for the supply option.

rack - Spot rack price at the terminal.

contract - Negotiated contract price.

index - Index-based pricing (e.g., OPIS).

inventory - Priced from existing inventory.

spot - Spot market price.

---

contract: str | None = None
Contract identifier when price_type is "contract". Max 100 characters.

---

load_number: str | None = None
Load number for the load. This is optional and will be passed as an additional filter to the other supply option if provided.

---

extra_data: dict = {}
Additional custom data.

---

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

---

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

---

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

Responses

200

Successful Response

application/json

Example (from schema)

[
  {
    "id": "string",
    "origin_order_number": "string",
    "destination_order_number": "string",
    "status": "origin_mapped",
    "change_types": [
      "supply_change"
    ],
    "created_on": "2026-09-25T19:33:16.246Z",
    "updated_on": "2026-09-25T19:33:16.246Z",
    "origin_tenant_name": "string",
    "destination_tenant_name": "string",
    "origin_order_change": {
      "delivery_window": {
        "start": "2026-09-25T19:33:16.246Z",
        "end": "2026-09-25T19:33:16.246Z",
        "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_source_id": "string"
          },
          "product": {
            "mapping_id": "5eb7cf5a86d9755df3a6c593",
            "source_name": "string",
            "source_id": "string",
            "goid": "string",
            "goid_name": "string"
          },
          "volume": 0,
          "loads": [
            {
              "terminals": [
                {
                  "mapping_id": "5eb7cf5a86d9755df3a6c593",
                  "source_name": "string",
                  "source_id": "string",
                  "goid": "string",
                  "goid_name": "string"
                }
              ],
              "products": [
                {
                  "mapping_id": "5eb7cf5a86d9755df3a6c593",
                  "source_name": "string",
                  "source_id": "string",
                  "goid": "string",
                  "goid_name": "string"
                }
              ],
              "suppliers": [
                {
                  "mapping_id": "5eb7cf5a86d9755df3a6c593",
                  "source_name": "string",
                  "source_id": "string",
                  "goid": "string",
                  "goid_name": "string"
                }
              ],
              "price_types": [
                "rack"
              ],
              "contracts": [
                "string"
              ],
              "load_number": "string"
            }
          ],
          "extra_data": {}
        }
      ],
      "extra_data": {}
    },
    "destination_order_change": {
      "delivery_window": {
        "start": "2026-09-25T19:33:16.247Z",
        "end": "2026-09-25T19:33:16.247Z",
        "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_source_id": "string"
          },
          "product": {
            "mapping_id": "5eb7cf5a86d9755df3a6c593",
            "source_name": "string",
            "source_id": "string",
            "goid": "string",
            "goid_name": "string"
          },
          "volume": 0,
          "loads": [
            {
              "terminals": [
                {
                  "mapping_id": "5eb7cf5a86d9755df3a6c593",
                  "source_name": "string",
                  "source_id": "string",
                  "goid": "string",
                  "goid_name": "string"
                }
              ],
              "products": [
                {
                  "mapping_id": "5eb7cf5a86d9755df3a6c593",
                  "source_name": "string",
                  "source_id": "string",
                  "goid": "string",
                  "goid_name": "string"
                }
              ],
              "suppliers": [
                {
                  "mapping_id": "5eb7cf5a86d9755df3a6c593",
                  "source_name": "string",
                  "source_id": "string",
                  "goid": "string",
                  "goid_name": "string"
                }
              ],
              "price_types": [
                "rack"
              ],
              "contracts": [
                "string"
              ],
              "load_number": "string"
            }
          ],
          "extra_data": {}
        }
      ],
      "extra_data": {}
    },
    "required_manual_approval": false,
    "approved_by": "string",
    "approved_on": "2026-09-25T19:33:16.247Z",
    "rejected_by": "string",
    "rejected_on": "2026-09-25T19:33:16.247Z",
    "rejected_reason_code": "string",
    "submit_reason_code": "string",
    "accept_reason_code": "string"
  }
]

422

Validation Error

application/json

Example (from schema)

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

Loading...