Skip to main content
Version: 2.1

Order

@experiemental context type representing an order. To be used with OMS and EMS systems.

This type currently only defines a required id field, which should provide a reference to the order in one or more systems, an optional human readable name field to be used to summarize the order and an optional details field that may be used to provide additional detail about the order, including a context representing a product, which may be extended with arbitrary properties. The details.product field is currently typed as a unspecified Context type, but both details and details.product are expected to be standardized in future.

Schema​

https://github.com/finos/FDC3/tree/main/schemas/context/order.schema.json

Type​

fdc3.order

Properties​

id​

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

Type: object

Example Value: 

{
  "myOMS": "12345"
}

Example Value: 

{
  "myOMS": "ABC123"
}

name​

An optional human-readable summary of the order.

Type: string

Example Value: ...

Example Value:

details​

Optional additional details about the order, which may include a product element that is an, as yet undefined but extensible, Context

Type: object

Subproperties​

product​
  • Type: undefined
  • Description: undefined

Example Value: 

{
  "product": {
    "type": "fdc3.product",
    "id": {
      "productId": "ABC123"
    },
    "instrument": {
      "type": "fdc3.instrument",
      "id": {
        "ticker": "MSFT"
      }
    }
  }
}

Example Value:

Examples​

{
  "type": "fdc3.order",
  "name": "...",
  "id": {
    "myOMS": "12345"
  },
  "details": {
    "product": {
      "type": "fdc3.product",
      "id": {
        "productId": "ABC123"
      },
      "instrument": {
        "type": "fdc3.instrument",
        "id": {
          "ticker": "MSFT"
        }
      }
    }
  }
}
{
  "type": "fdc3.order",
  "id": {
    "myOMS": "ABC123"
  }
}