POST/schedule

Create Schedule

Create schedule

Implementation Notes

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.

Parameter Details:

scheduleName: The name under which the schedule will be created.
shopId: A unique ID generated when creating the shop.
year:
- "*" – No specification.
- "2025" – Single year.
- "2025,2026" – Multiple years.
month:
- "*" – All 12 months.
- "1" – January
  "2" – February
  ...
  "12" – December
- "1,3" – January & March.
dow (Day of the Week):
- "*" – 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:
- "*" – All days in the month.
- "1-31" – Day of the month. Can be passed as an expression (e.g., "1,3,5").
hour:
- "*" – Every hour.
- "0-23" – Specific hours (e.g., "1,3,5").
minute:
- "0-59" – A single minute value (e.g., "30").
startDate: Date when the schedule starts.
endDate: Date when the schedule ends. If undefined, the schedule runs indefinitely.

Mandatory Fields:

scheduleName
shopId
year
month
dow
day
hour
minute
startDate
endDate

Note:
Schedule times are in UTC by default (hh:mm format, 24-hour — e.g., 16:30).

POST/schedule

Parameter Details

Name	In	Type	Required	Description
`body`	body	`object`	Required	none
`» scheduleName`	body	`string`	Optional	Name of the schedule.
`» shopId`	body	`integer`	Optional	Unique ID generated when creating the shop.
`» year`	body	`string(date)`	Optional	Year(s) the schedule runs.
`» month`	body	`string`	Optional	Month(s) the schedule runs.
`» dow`	body	`string`	Optional	Days of the week the schedule runs.
`» day`	body	`string`	Optional	Days of the month the schedule runs.
`» hour`	body	`string`	Optional	Hours the schedule runs.
`» minute`	body	`string`	Optional	Minutes the schedule runs.
`» startDate`	body	`string(date)`	Optional	Start date of the schedule (UTC format).
`» endDate`	body	`string(date)`	Optional	End date of the schedule. If undefined, 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 /schedule \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

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
}

PreviousDelete Shop

NextList Schedules

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

About Us

Careers