Retrieving merchant opening hours

Edit on GitHub

This document describes how to retrieve merchant opening hours.

Retrieve merchant opening hours

To retrieve a merchant opening hours, send the request:


GET /merchants/{{merchantId}}/merchant-opening-hours


PATH PARAMETER DESCRIPTION
{{merchantId}} Unique identifier of a merchant to retrieve the addresses of. To get it, retrieve all merchants.
Note

This endpoint returns only active merchants. To learn how you can activate a merchant in the Back Office, see Activating and deactivating merchants.

Request

Request sample: GET http://glue.mysprykershop.com/merchants/MER000001/merchant-opening-hours

Response

Response sample: retrieve merchant opening hours
{
    "data": [
        {
            "type": "merchant-opening-hours",
            "id": "MER000001",
            "attributes": {
                "weekdaySchedule": [
                    {
                        "day": "MONDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "13:00:00.000000"
                    },
                    {
                        "day": "MONDAY",
                        "timeFrom": "14:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    },
                    {
                        "day": "TUESDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    },
                    {
                        "day": "WEDNESDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    },
                    {
                        "day": "THURSDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    },
                    {
                        "day": "FRIDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    },
                    {
                        "day": "SATURDAY",
                        "timeFrom": "07:00:00.000000",
                        "timeTo": "20:00:00.000000"
                    },
                    {
                        "day": "SUNDAY",
                        "timeFrom": null,
                        "timeTo": null
                    }
                ],
                "dateSchedule": [
                    {
                        "date": "2020-01-01",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "New Year's Day"
                    },
                    {
                        "date": "2020-04-10",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Good Friday"
                    },
                    {
                        "date": "2020-04-12",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Easter Sunday"
                    },
                    {
                        "date": "2020-04-13",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Easter Monday"
                    },
                    {
                        "date": "2020-05-01",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "May Day"
                    },
                    {
                        "date": "2020-05-21",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Ascension of Christ"
                    },
                    {
                        "date": "2020-05-31",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Whit Sunday"
                    },
                    {
                        "date": "2020-06-01",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Whit Monday"
                    },
                    {
                        "date": "2020-06-11",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "Corpus Christi"
                    },
                    {
                        "date": "2020-11-01",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "All Saints' Day"
                    },
                    {
                        "date": "2020-12-25",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "1st Christmas day"
                    },
                    {
                        "date": "2020-12-26",
                        "timeFrom": null,
                        "timeTo": null,
                        "note": "2nd Christmas day"
                    },
                    {
                        "date": "2021-11-28",
                        "timeFrom": "13:00:00.000000",
                        "timeTo": "18:00:00.000000",
                        "note": "Sunday Opening"
                    },
                    {
                        "date": "2021-12-31",
                        "timeFrom": "10:00:00.000000",
                        "timeTo": "17:00:00.000000",
                        "note": ""
                    }
                ]
            },
            "links": {
                "self": "http://glue.mysprykershop.com/merchants/MER000001/merchant-opening-hours"
            }
        }
    ],
    "links": {
        "self": "http://glue.mysprykershop.com/merchants/MER000001/merchant-opening-hours"
    }
}

ATTRIBUTE DESCRIPTION
weekdaySchedule Array of the schedule for weekdays.
weekdaySchedule.day Name of the day.
weekdaySchedule.timeFrom Time when the merchant starts working on a usual day.
weekdaySchedule.timeTo Time when the merchant stops working on a usual day.
dateSchedule Array of the schedule for special working days, like holidays.
dateSchedule.date Date of the special opening hours.
dateSchedule.timeFrom Time when the merchant starts working during the special working hours.
dateSchedule.timeTo Time when the merchant stops working during the special working hours.
dateSchedule.note Description of the special opening hours.

Possible errors

For statuses, see Reference information: GlueApplication errors.