Since: v3.4
Update or assign the operating hours for a location. See Effective Dating for more information.
PUT ~/hours
Headers
Field | Type | Description |
---|---|---|
Authorization | String |
Bearer authentication token prefixed with |
Content-Type | String |
Request content type, must be 'application/json' |
vendor | String |
The POS vendor name retrieved from Doshii dashboard |
Parameters
Field | Type | Description |
---|---|---|
standard | Boolean |
Indicates whether or not these operating hours are considered part of the standard hours for this location. |
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. |
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 |
operatingHours | Object[] |
The trading hours for the location. See Effective Dating for more information. |
standard | Boolean |
Indicates whether or not these operating hours are considered part of the standard hours for this location. |
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. |
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
[{
status: 'closed',
daysOfWeek: ['mon']
}, {
status: 'open',
time: {
from: '11:30',
to: '14:30'
},
daysOfWeek: ['tue', 'wed', 'thu', 'fri', 'sat', 'sun']
}, {
status: 'open',
time: {
from: '17:30',
to: '21:00'
},
daysOfWeek: ['tue', 'wed', 'thu', 'sun']
}, {
status: 'open',
time: {
from: '17:30',
to: '21:30'
},
daysOfWeek: ['fri', 'sat']
}, {
status: 'closed',
dates: [{
day: 1,
month: 1
}]
}, {
status: 'closed',
dates: [{
day: 24,
month: 12
}, {
day: 26,
month: 12
}]
}]
Comments
0 comments
Please sign in to leave a comment.