POST/schedule

Create Schedule

This endpoint allows you to create custom schedules for executing shops at specified dates and times.

Note: All schedules are queued at the fifty-fifth minute of the previous hour. Jobs scheduled within the current hour run the next day.

POST/schedule

Optional Fields

dow
endDate

Implementation Notes

This endpoint allows you to create custom schedules for executing shops at specified dates and times.

Parameter Details

Name	In	Type	Required	Description
`body`	body	`object`	Required	none
`» scheduleName`	body	`string`	Required	none
`» shopId`	body	`number`	Required	none
`» year`	body	`string`	Required	none
`» month`	body	`string`	Required	none
`» dow`	body	`string`	Optional	none
`» day`	body	`string`	Required	none
`» hour`	body	`string`	Required	none
`» minute`	body	`string`	Required	none
`» seconds`	body	`string`	Required	none
`» startDate`	body	`string(date)`	Required	none
`» endDate`	body	`string(date)`	Optional	none

Responses

Status	Meaning	Description	Schema
200	OK	Schedule created 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 POST /schedule \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "scheduleName": "Sample Schedule",
  "shopId": 1,
  "year": "*",
  "month": "1,2,12",
  "dow": "*",
  "day": "1,15",
  "hour": "0,12",
  "minute": "0",
  "seconds": "0",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24"
}

Example responses

200 Response

{
  "message": "Schedule Created Successfully",
  "scheduleId": 123
}

PreviousDelete Shop

NextGet 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