Articles in this section

Get Table Orders

Avatar
Greg
  • Updated
Follow

Get all active orders for the given table

GET ~/tables/:table-name/orders

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information.
Content-Type String

Request content type, must be 'application/json'
vendor String

The POS vendor name retrieved from Doshii dashboard

Parameters

Field Type Description
:table-name String

The name of the Table to retrieve Orders for
  uuid String

A UUID for the item. Automatically generated by Doshii.
  status String

The status of the unapproved item. Must be one of ['pending', 'cancelled', 'voided']

Response

Field Type Description
id String

Unique number identifying this resource
locationId String

Id of the Location resource
checkinId String

Id of the Checkin resource
memberId String

Id of the Member resource
manuallyAccepted Boolean

The order has been verified by a human, pass through "status": "accepted" without external validation. Defaults to false.
phase String

Free text representation of where the Order is in it's lifecycle at the venue. Eg: 'preparing', 'mains served', 'ready for delivery', etc...
status String

The current state of the Order. Can be one of the following:

state description
pending Order yet to be confirmed by the POS
rejected Order was not accepted by the POS
accepted Order was accepted by the POS
complete Order has been marked as completed by the POS
cancelled Pending Order was cancelled by the Partner
venue_cancelled Accepted Order was cancelled by the Partner or POS

See Status and the Order State Machine for more information.
type String

The type of order should be one of the following

type description
(not provided) Standard POS order.
delivery Order ahead to be delivered to the Consumer
pickup Order ahead to be picked up by the Consumer
dinein Order is for dine-in at the venue
notes String

Free-text entry for order or delivery notes such as "deliver to back door".
requiredAt String

A DateTime for when the Order is required. Will be null if not a future Order.
availableEta String

An estimated DateTime for when the Order is available for pickup/delivery. Will be null if immediately available.
items Object[]

Array of Product objects.
  posId String

The POS id of the Product
  name String

The display name of the Product
  quantity String

The quantity ordered
  description String

A short description of the Product
  unitPrice String

The price of the Product in cents
  totalBeforeSurcounts String

The price of the line item before the Surcounts are applied
  totalAfterSurcounts String

The price of the line item after the Surcounts are applied
  tags String[]

Array of strings to help group Products together
  type String

Either a type of 'single' or 'bundle'. Defaults to 'single' 
  includedItems Object[]

Array of items that are included in a bundle 
    name String

The name of the included item
    posId String

The posId of the included item
    quantity String

The quantity of the included item
    unitPrice String

The unitPrice of the included item
    options Object[]

Array of options that can be added to the Product
      posId String

The POS id of the option
      name String

The display name of the option
      min String

The minimum number that can be selected (0 for no min)
      max String

The maximum number that can be selected (0 for no max)
      variants Object[]

The available Variants for the option
        posId String

The POS id of the Variant
        name String

The display name of the Variant
        price String

The price of the Variant in cents
  surcounts Object[]

Array of Surcount objects.
    posId String

Id of the item in the POS. Providing this will allow the POS to correctly print and report sales.
    rewardId String

Id of the Reward that created this Surcount
    name String

Name of item.
    description String

Description of item.
    amount String

The amount to surcharge/discount (positive/negative integer)
    value String

The value of the surcounts in cents. Accepts integer or string of integers. This value should be calculated if the Surcount is % based.
  options Object[]

Array of options that can be added to the Product
    posId String

The POS id of the option
    name String

The display name of the option
    variants Object[]

The available Variants for the option
      posId String

The POS id of the Variant
      name String

The display name of the Variant
      price String

The price of the Variant in cents
unapprovedItems Object[]

Array of Product objects that have a status that is NOT accepted.
  posId String

The POS id of the Product
  name String

The display name of the Product
  quantity String

The quantity ordered
  description String

A short description of the Product
  unitPrice String

The price of the Product in cents
  totalBeforeSurcounts String

The price of the line item before the Surcounts are applied
  totalAfterSurcounts String

The price of the line item after the Surcounts are applied
  tags String[]

Array of strings to help group Products together
  type String

Either a type of 'single' or 'bundle'. Defaults to 'single' 
  includedItems Object[]

Array of items that are included in a bundle 
    name String

The name of the included item
    posId String

The posId of the included item
    quantity String

The quantity of the included item
    unitPrice String

The unitPrice of the included item
    options Object[]

Array of options that can be added to the Product
      posId String

The POS id of the option
      name String

The display name of the option
      min String

The minimum number that can be selected (0 for no min)
      max String

The maximum number that can be selected (0 for no max)
      variants Object[]

The available Variants for the option
        posId String

The POS id of the Variant
        name String

The display name of the Variant
        price String

The price of the Variant in cents
  surcounts Object[]

Array of Surcount objects.
    posId String

Id of the item in the POS. Providing this will allow the POS to correctly print and report sales.
    rewardId String

Id of the Reward that created this Surcount
    name String

Name of item.
    description String

Description of item.
    amount String

The amount to surcharge/discount (positive/negative integer)
    value String

The value of the surcounts in cents. Accepts integer or string of integers. This value should be calculated if the Surcount is % based.
  options Object[]

Array of options that can be added to the Product
    posId String

The POS id of the option
    name String

The display name of the option
    variants Object[]

The available Variants for the option
      posId String

The POS id of the Variant
      name String

The display name of the Variant
      price String

The price of the Variant in cents
consumer String

An object containing Consumer details.
  name String

The name of the consumer
  phone String

The phone of the consumer
  email String

The email of the consumer
  address String

An object containing Consumer Address details.
    line1 String

The street number and name.
    city String

City.
    state String

State.
    postalCode String

Postal code.
    country String

2-character Country Code.
  notes String

Free-text entry for consumer notes such as "Allergic to nuts".
surcounts Object[]

Array of Surcount objects.
  posId String

Id of the item in the POS
  rewardId String

Id of the Reward that created this Surcount
  name String

Name of item.
  description String

Description of item.
  amount String

The amount to surcharge/discount (positive/negative integer)
  value String

The value of the surcounts in cents. Accepts integer or string of integers. This value should be calculated if the Surcount is % based.
checkin Object

An object containing Checkin details.
  id String

The checkin ID
  tableNames String

Array of table names used in the checkin.
  covers String

Number of covers
  updatedAt String

Checkin last update date
  createdAt String

Checkin creation date
  uri String

URI of the Checkin
rejectionCode String

The code for a rejection. More information can be found by a GET on /rejection-codes/:rejectionCode. Will not return if not set.
rejectionReason String

The reason defined by the POS as why the order was rejected. Will not return if not set.
updatedAt String

Order last update date
createdAt String

Order creation date
version String

An obfuscated string representation of the version
uri String

URI of the order
transactionsUri String

URI of the Transactions associated with the order

 

Examples

Response

{
  "id": "1634",
  "status": "accepted",
  "phase": "ordered",
  "manuallyAccepted": false, 
  "checkinId": "3",
  "locationId": "Xuy8K3a0",
  "memberId": "332",
  "notes":"Well done toast",
  "requiredAt":null,
  "availableEta":null, 
  "surcounts": [],
  "items": [
    {
      "uuid":"43g25532h235-f34f23f34f34-f3432g23g32",
      "posId":"lol12",
      "name":"Toasted Sourdough Bread & Eggs",
      "quantity":1,
      "description":"Just ye old classic",
      "unitPrice":"1100",
      "totalBeforeSurcounts":"1100",
      "totalAfterSurcounts":"1100",
      "type": "single", 
      "includedItems": [], 
      "surcounts": [],
      "options": []
    }
  ],
 "unapprovedItems": [
   {
      "uuid":"32f342f3-f34f23f34f34-f3432g23g32",
      "name":"Coke",
      "status":"pending",
      "description":"classic cola",
      "unitPrice":"450",
      "posId":"rwqed1",
      "quantity":1,
      "type": "single", 
      "includedItems": [], 
      "surcounts": [],
      "options": []
    }
  ],
  "consumer":{
    "name": "Tony Tamplin",
    "phone":"0121211212",
    "email":"t@mail.com",
    "address":{
      "line1":"St Kilda Rd",
      "line2":"Level 6, 616 St Kilda Rd"
      "city":"Melbourne"
      "state":"VIC"
      "postalCode":"3180"
      "country":"AU"
    }
  },
  "updatedAt": "2016-08-18T04:58:38.485Z",
  "createdAt": "2016-08-18T04:58:38.485Z",
  "version":"iwgjr2NJ014",
  "uri": "https://sandbox.doshii.co/pos/v3/orders/1634",
  "transactionsUri": "https://sandbox.doshii.co/pos/v3/orders/1634/transactions"
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.