GET
/schedules/{scheduleId}Get Schedule By Id
This endpoint retrieves a list of get schedule by id. Use the available filters and pagination parameters to refine your results.
GET
/schedules/{scheduleId}Mandatory Fields
- scheduleId
Note
For any technical assistance or feature requests, please contact our API support team.
Important Notes
- Always use HTTPS for API requests.
- Access tokens are valid for a limited time and should be refreshed periodically.
- Rate limiting applies to all endpoints to ensure system stability.
Parameter Details
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scheduleId | path | integer | Required | Unique identifier for the schedules. |
- All parameters should be formatted according to the types specified in the table above.
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Inline |
| 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 |
Response Notes
The response will include a status field indicating success or failure, along with the requested data or relevant error messages. Standard HTTP status codes are used to indicate the outcome of the request.
Example Request
# You can also use wget
curl -X GET /schedules/{scheduleId} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'
Example responses
200 Response
{
"scheduleId": 201,
"scheduleName": "sample_schedule_name",
"shopId": 1,
"year": "*",
"month": "*",
"dow": "*",
"day": "*",
"hour": "*",
"minute": "20",
"status": 1,
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}
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.