Articles in this section

See more

Get Orders

Avatar
Greg
  • Updated
Follow

Retrieve the basic header/summary information for all the active Orders for this Location.

This endpoint will only return the "linked" Orders. See GET /unlinked_orders for more info.

This endpoint accepts several query parameters to filter the data returned. Data will be returned chronologically.

GET ~/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
Accept-Encodingoptional String

Using compression on the response will improve the response times of this endpoint. Using this header will indicate to Doshii that the JSON response should be compressed (e.g. Accept-Encoding: gzip)

Parameters

Field Type Description
statusoptional String

Comma separated list of statuses. Defaults to accepting all. eg. pending,accepted. See Status and the Order State Machine for more information.
fromoptional Integer

The date and time (seconds since Epoch) <= Order's creation time. Eg. 1481979234
tooptional Integer

The date and time (seconds since Epoch) >= Order's creation time. Eg. 1482197552
updatedFromoptional Integer

The date and time (seconds since Epoch) <= Order's last update time. Eg. 1481979234
updatedTooptional Integer

The date and time (seconds since Epoch) >= Order's last update time. Eg. 1482197552
offsetoptional Integer

Number of matching records to skip before returning the appropriate rows. Default: 0
limitoptional Integer

Max number of records to return. Default is 50 (Maximum: 250)
orderoptional String

Sorts orders in chronological order based on createdAt or updatedAt. Default is createdAt.

Response

Field Type Description
id String

posId of the order
uri String

The relevant URI of the resource
status String

The current status of the order. See Status and the Order State Machine for more information.
doshiiId String

 The Doshii id of the unlinked order to retrieve

Examples

Response

[
  {
    "id": "1",
    "uri": "https://sandbox.doshii.co/pos/v3/orders/1",
    "status": "pending"
  }
]

 

Related articles

Comments

0 comments

Please sign in to leave a comment.