Articles in this section

Create Location

Avatar
Greg
  • Updated
Follow

Create a location

POST ~/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

Parameters

Field Type Description
name String

The name of the Location
classificationoptional String

The classification of the Location. Supported values are: 'Accommodation', 'Amateur Sport', 'Bakery', 'Bar', 'Café', 'Cinema', 'Club', 'Education', 'Golf Club', 'Gym', 'Pub', 'QSR', 'Restaurant' and 'Takeaway Food'
addressLine1optional String

First line for address
addressLine2optional String

Second line for address
cityoptional String

City of the Location
stateoptional String

State of the Location
countryoptional String

Country 2 letters identifier where the Location is in
postalCodeoptional String

Postcode of the Location
phoneNumberoptional String

Phone number for the Location
latitudeoptional String

The location latitude coordinate
longitudeoptional String

The location longitude coordinate
timezoneoptional String 

The location's timezone using the zone identifier (e.g. Australia/Melbourne)
organisationId String

The organisations hashed Id
operatingHoursoptionalv3.4 Object[]

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

Whether the venue is open or closed
  datesoptional Object[]

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

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

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

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

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

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

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

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

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

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

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

List the current capabilities of this Location.
healthCheckoptional 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'.
orderPreProcessoptional 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'.

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
apiVersion String

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

The organisations hashed Id
token String

The location identifier token used for JWT authentication
updatedAt String

Date when the record is last updated
createdAt String

Date when the record is created
uri String

The object details url

 

Examples

Request

{
  "name":"Chicken's R Us",
  "classification":"Takeaway Food",
  "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",
  "organisation": "1X3sb8q",
  "capability": {
    "healthCheck": "supported",
    "orderPreProcess": "unsupported"
  }
} 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.