Skip to main content

API Documentation

Technical API reference for Maestro Theme Scheduler (if applicable).

Overview​

This section provides API documentation for developers who want to integrate with Maestro Theme Scheduler programmatically.

Authentication​

API requests require authentication. Contact support for API access credentials.

Endpoints​

Get Schedules​

Retrieve all schedules for your store.

GET /api/v1/schedules

Response:

{
  "schedules": [
    {
      "id": "schedule_id",
      "target_type": "section",
      "target_id": "section_id",
      "start_time": "2024-01-01T00:00:00Z",
      "end_time": "2024-01-31T23:59:59Z",
      "action": "show",
      "status": "active"
    }
  ]
}

Create Schedule​

Create a new schedule.

POST /api/v1/schedules

Request Body:

{
  "target_type": "section",
  "target_id": "section_id",
  "start_time": "2024-01-01T00:00:00Z",
  "end_time": "2024-01-31T23:59:59Z",
  "action": "show"
}

Update Schedule​

Update an existing schedule.

PUT /api/v1/schedules/{schedule_id}

Delete Schedule​

Delete a schedule.

DELETE /api/v1/schedules/{schedule_id}

Rate Limits​

API requests are rate-limited. Contact support for rate limit details.

Error Handling​

All errors follow a standard format:

{
  "error": {
    "code": "error_code",
    "message": "Error description"
  }
}

Webhooks​

Configure webhooks to receive notifications about schedule execution.

Webhook Events​

  • schedule.executed - Schedule executed successfully
  • schedule.failed - Schedule execution failed
  • schedule.created - New schedule created
  • schedule.updated - Schedule updated
  • schedule.deleted - Schedule deleted

Support​

For API access and support: