Articles in this section

See more

Get Locations

Avatar
Greg
  • Updated
Follow

Retrieve all Locations associated with the App/Partner

GET ~/locations

Headers

Field Type Description
Accept-Encodingoptional String

Using compression on the response may 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)

Response

Field Type Description
id String

Unique hashed id for this Location. See Hashed Location IDs
name String

The name of the Location
addressLine1 String

The street number and name
addressLine2 String

Apartment/unit/level/suite
city String

City
state String

State
country String

2-character Country Code. Eg: AU for Australia
postalCode String

Postcode
phoneNumber String

Phone Number
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 String

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'.
organisationId String

The hashed id of the Organisation this Location belongs to. See Hashed Organisation IDs
updatedAt Date

Date when the record was last updated
createdAt Date

Date when the record was created
uri String

A URL to retrieve the specific location.

Example

Response

[
  {
    "id":"w41pRr8v",
    "name":"Chicken's R Us",
    "addressLine1":"608 St Kilda Road",
    "city":"Melbourne",
    "state":"VIC",
    "postalCode":"3004",
    "country":"AU",
    "phoneNumber":"01234567890",
    "capability": {
      "healthCheck": "supported",
      "orderPreProcess": "supported"
    },
    "updatedAt": "2016-08-18T04:58:38.485Z",
    "createdAt": "2016-08-18T04:58:38.485Z",
    "uri": "https://sandbox.doshii.co/partner/v3/locations/w41pRr8v"
  }
]

Related articles

Comments

0 comments

Please sign in to leave a comment.