POST
/schedulesCreate Schedule
This API call allows a user to create a timetable for running a specific shop at a predetermined date and time on a set schedule. While creating the schedule, the user can also define the mode of delivery — either via a Web-Hook or a queue ID.
POST
/schedulesNote
Schedule times are in UTC by default (hh:mm format, 24-hour — e.g., 16:30).
Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
» scheduleName | body | string | Required | The name under which the schedule will be created. |
» shopId | body | integer | Required | A unique ID generated when creating the shop. |
» year | body | string(date) | Required | "*" – No specification, "2025" – Single year, "2025,2026" – Multiple years. |
» month | body | string | Required | "*" – All 12 months, "1" – January, "2" – February, ..., "12" – December, "1,3" – January & March. |
» dow | body | string | Required | "*" – All days, "0" – Sunday, "1" – Monday, "2" – Tuesday, "3" – Wednesday, "4" – Thursday, "5" – Friday, "6" – Saturday, "1,3,5" – Runs every Monday, Wednesday, and Friday. |
» day | body | string | Required | "*" – All days in the month, "1-31" – Day of the month. Can be passed as an expression (e.g., "1,3,5"). |
» hour | body | string | Required | "*" – Every hour, "0-23" – Specific hours (e.g., "1,3,5"). |
» minute | body | string | Required | "0-59" – A single minute value (e.g., "30"). |
» startDate | body | string(date) | Required | Date when the schedule starts. |
» endDate | body | string(date) | Required | Date when the schedule ends. If undefined, the schedule runs indefinitely. |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Created | |
| 400 | Bad Request | Bad Request | None |
| 401 | Unauthorized | Unauthorized | None |
| 403 | Forbidden | Forbidden - Access denied | None |
| 404 | Not Found | Schedule not found | 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 POST /schedules \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{"scheduleName":"string","shopId":0,"year":"string","month":"string","dow":"string","day":"string","hour":"string","minute":"string","startDate":"string","endDate":"string"}'
Body parameter
{
"scheduleName": "My Schedule",
"shopId": 0,
"year": "*",
"month": "*",
"dow": "*",
"day": "*",
"hour": "*",
"minute": "00",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
Example responses
201 Response
{
"message": "Schedule created successfully.",
"scheduleId": 1
}
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.