Schema
OrderEvent
Represents an event that occurred against an order.
Overview
Properties
uuid
string
The unique identifier.
Format
uuid
Read only
Yes
type
reference
Required
The type of event that occured.
References Order Event Type.
description
string
A human-readable description of the event.
Example
Order dispatched to outlet
Min length
1
created_at
string
The date-time that the event occurred.
Format
date-time
Used by
Raw YAML
Download source
title: OrderEvent
type: object
x-tags:
- Orders
description: Represents an event that occurred against an order.
required:
- type
properties:
uuid:
type: string
format: uuid
description: The unique identifier.
readOnly: true
type:
$ref: ./OrderEventType.yaml
description: The type of event that occured.
description:
type: string
minLength: 1
example: Order dispatched to outlet
description: A human-readable description of the event.
created_at:
type: string
format: date-time
description: The date-time that the event occurred.