OrderTypes

Order type configuration.

Fields

Field Type Required Version Description
id integer Yes 1.1 Unique order type identifier
name string No 1.1 Order type name
code string No 1.1 Order type code
orderTypeGroupId integer No 1.1 Reference to OrderTypeGroup
customerId integer Yes 1.1 Reference to Customer
active boolean No 1.1 Order type active status

Example

{
  "id": 1,
  "name": "Dine In",
  "code": "DINE_IN",
  "orderTypeGroupId": 1,
  "customerId": 12345,
  "active": true
}

Example - Common Order Types

[
  {
    "id": 1,
    "name": "Dine In",
    "code": "DINE_IN",
    "orderTypeGroupId": 1,
    "customerId": 12345,
    "active": true
  },
  {
    "id": 2,
    "name": "Takeaway",
    "code": "TAKEAWAY",
    "orderTypeGroupId": 2,
    "customerId": 12345,
    "active": true
  },
  {
    "id": 3,
    "name": "Delivery",
    "code": "DELIVERY",
    "orderTypeGroupId": 2,
    "customerId": 12345,
    "active": true
  },
  {
    "id": 4,
    "name": "Drive Through",
    "code": "DRIVE_THROUGH",
    "orderTypeGroupId": 2,
    "customerId": 12345,
    "active": true
  },
  {
    "id": 5,
    "name": "Staff Meal",
    "code": "STAFF",
    "orderTypeGroupId": 3,
    "customerId": 12345,
    "active": true
  }
]