GET/schedule

Get Schedule

Retrieves the list of active schedules. Optionally, a specific schedule can be retrieved by passing an ID as a query parameter.

GET/schedule

Optional Fields

Implementation Notes

Retrieves the list of active schedules. Optionally, a specific schedule can be retrieved by passing an ID as a query parameter.

Parameter Details

Name	In	Type	Required	Description
`id`	query	`integer`	Optional	none

Responses

Status	Meaning	Description	Schema
200	OK	Schedule(s) retrieved successfully	`Inline`
400	Bad Request	Bad Request	None
401	Unauthorized	Authentication Failed or Account validity Expired	None
429	Too Many Requests	Too Many Requests	None
500	Internal Server Error	Internal Server Error	None

Example Request

# You can also use wget
curl -X GET /schedule \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "scheduleId": 0,
  "scheduleName": "string",
  "shopId": 0,
  "year": "string",
  "month": "string",
  "dow": "string",
  "day": "string",
  "hour": "string",
  "minute": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

PreviousCreate Schedule

NextUpdate Schedule

Need Support?

Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.

Contact Support