OrderList

@experimental A list of orders. Use this type for use cases that require not just a single order, but multiple.

The OrderList schema does not explicitly include identifiers in the id section, as there is not a common standard for such identifiers. Applications can, however, populate this part of the contract with custom identifiers if so desired.

Schema

https://fdc3.finos.org/schemas/next/context/orderList.schema.json (github)

Type

fdc3.orderList

Properties

id

type: object

Additional Properties

type: string

One or more identifiers that refer to the order list in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future.

name

type: string

An optional human-readable summary of the order list

orders (required)

type: array

Items

type: Order

An array of order contexts that forms the list.

Example

{
  "type": "fdc3.orderList",
  "orders": [
    {
      "type": "fdc3.order",
      "id": {
        "myOMS": "ABC123"
      }
    },
    {
      "type": "fdc3.order",
      "id": {
        "myOMS": "DEF456"
      }
    }
  ]
}