PUT Data
Api-docs for RC: https://api-rc.quinyx.com/v2/docs (select “opening-hours” definition)
Api-docs: https://api.quinyx.com/v2/docs (select “opening-hours” definition)
Base URL can be found on links above for both environments. The remainder of this article should be considered a complement to the above Open API documentation.
PUT/groups/{groupId}/opening-hours/{openingHoursId}
This API call edits/updates the opening hour details.
Field description
Mandatory fields will be marked with a * icon.
Endpoint
- groupId*: The group ID of your Quinyx account.
- openingHoursId*: The ID of the specific opening hours you want to update.
Request body
- groupId*: The group ID of your Quinyx account.
- name*: The name of the opening hours.
- startDate*: The start date of your opening hour.
- endDate: The end date of your opening hours. This is only mandatory for the special type opening hours, like bank holidays etc.
- type*: The type of opening hours. This can either be "Standard" or "Special".
- weekdayHours*:
- weekday*: The specific day of the week's opening hours
- startTime*: The start time of the opening hours (e.g. 08:00).
- endTime*: The end time of the opening hours (e.g. 17:00).
- open*: A boolean. If set to true, the business is open. If set to false, the business is closed.
Response
- groupId*: The group ID of your Quinyx account.
- name*: The name of the opening hours.
- startDate*: The start date of your opening hour.
- endDate: The end date of your opening hours. This is only mandatory for the special type opening hours, like bank holidays etc.
- type*: The type of opening hours. This can either be "Standard" or "Special".
- weekdayHours*:
- weekday*: The specific day of the week's opening hours
- startTime*: The start time of the opening hours (e.g. 08:00).
- endTime*: The end time of the opening hours (e.g. 17:00).
- open*: A boolean. If set to true, the business is open. If set to false, the business is closed.
Example
End point
For the RC environment: https://api-rc.quinyx.com/v2/opening-hours/groups/123/opening-hours/234
Request body
{
"groupId": 1234,
"name": "string",
"startDate": "2023-03-15",
"endDate": "2023-04-20",
"type": "STANDARD",
"weekdayHours": [
{
"weekday": "1",
"startTime": "14:00",
"endTime": "17:00",
"open": true
}
]
}
Response
{
"groupId": 1234,
"name": "string",
"startDate": "2023-03-15",
"endDate": "2023-04-20",
"type": "STANDARD",
"weekdayHours":
[
{
"weekday": "1"
"startTime": "14:00",
"endTime": "17:00",
"open": true
}
]
}