Articles in this section

Get Locations

Avatar
Greg
  • Updated
Follow

Retrieve all locations for a POS Vendor

GET ~/locations

Headers

Field Type Description
Authorization String

Bearer authentication token prefixed with Bearer and a space. See Authentication for more information. This endpoint uses the Vendor Authentication to authenticate.
Content-Type String

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

The POS vendor name retrieved from Doshii dashboard

Response

Field Type Description
id String

Hashed id for this Location
name String

The name of the Location
classification String

The classification of the Location (e.g. Bar, Restaurant, QSR, etc)
addressLine1 String

First line for address
addressLine2 String

Second line for address
city String

City of the Location
state String

State of the Location
country String

Country 2 letters identifier where the Location is in
postalCode String

Postcode of the Location
phoneNumber String

Phone number for the Location
latitude String

The location latitude coordinate
longitude String

The location longitude coordinate
timezone String

The location's timezone (if populated)
operatingHours Object[]

The trading hours for the location. See Effective Dating for more information.
  status String

Whether the venue is open or closed
  dates Object[]

Either an array with 1 or 2 PolicyDates. Two PolicyDates signify an inclusive range from PolicyDate1 to PolicyDate2
    day Number

The day of the month (1 - 31).
    month Number

The month of the year (1 - 12).
    year Number

The 4 digit year (e.g. 2019).
  time Object

An object specifying the time range that this is policy is in effect. e.g. 09:30 - 17:30
    from String

Time from. HH:mm 24 hour format.
    to String

Time to. HH:mm 24 hour format.
  daysOfWeek String[]

A set of mon | tue | wed | thu | fri | sat | sun.
  effective Object

Indicates when the policy becomes effective, for example, from the 1st of January 2020, etc
    from String

Policy is effective from (inclusive). yyyy-mm-dd format.
    to String

Policy is effective to (inclusive). yyyy-mm-dd format.
capability Object

List the current capabilities of this Location.
  healthCheck String Indicates whether or not the Location supports health checks. The values will either be 'supported' or 'unsupported'. If the property is omitted, it should be considered the same as 'unsupported'.
  orderPreProcess String Indicates whether or not the Location supports the ability to respond to the Order PreProcess request. The values will either be 'supported' or 'unsupported'. If the property is omitted, it should be considered the same as 'unsupported'.
vendorId String

The id of the vendor
organisationId String

The id of the Organisation
Organisation Object

The location's organisation object
  id String

The hashed id for the Organisation
  name String

Organisations' name
  phone String

Organisations' phone
  email String

Organisations' email
  addressLine1 String

Organisations' first line for address
  addressLine2 String

Organisations' second line for address
  city String

Organisations' city
  state String

Organisations' state
  postalCode String

Organisations' postalCode
  country String

Organisations' country 2 letters identifier
  createdAt String

Organisations' record creation date
  updatedAt String

Organisations' record last update date
  uri String

Organisations' object details url
token String

The location identifier token used for JWT authentication
apiVersion String

The version of the Doshii Api that this location supports
updatedAt String

Date when the record is last updated
createdAt String

Date when the record is created
uri String

The object details url

Examples

Response

{
  "id":"2X3b8q",
  "name":"Chicken's R Us",
  "classification":"Bar",
  "addressLine1":"616 St Kilda Road",
  "addressLine2":"Level 8",
  "city":"Melbourne",
  "state":"VIC",
  "postalCode":"3004",
  "country":"AU",
  "phoneNumber":"01234567890",
  "latitude":null,
  "longitude":null,
  "timezone": "Australia/Melbourne",
  "capability": {
    "healthCheck": "supported",
    "orderPreProcess": "supported"
  },
  "vendorId": "1",
  "organisationId": "5X3b8n",
  "Organisation": {
    "id": "5X3b8n",
    "name": "Test Org",
    "phone": "1234 567 891",
    "email": "test@org.com.au",
    "addressLine1": "616 St Kilda Road",
    "addressLine2": "Level 8",
    "city": "Melbourne",
    "state": "VIC",
    "country": "AU",
    "postalCode": null,
    "createdAt": "2016-06-22T00:35:54.967Z",
    "updatedAt": "2016-06-30T01:23:02.825Z",
    "uri": "https://sandbox.doshii.co/pos/v3/organisations/5X3b8n"
  },
  "createdAt": "2016-06-30T01:23:28.371Z",
  "updatedAt": "2016-08-18T03:20:32.720Z",
  "uri": "https://sandbox.doshii.co/pos/v3/location/2X3b8q"
}

 

Related articles

Comments

0 comments

Please sign in to leave a comment.