Theme Scheduler Pro API

Overview

You can use the API to create, read, update, and delete theme schedules. Each request requires an authorization header to be present with your API key as the value. 

Authorization

Generate your API key within the Product Scheduler Pro app. First, install the app from the Shopify app store. Then, generate your API key. 

Errors

The API uses standard HTTP response codes for success or failure of an API request. Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the parameters provided. Codes in the 5xx range are internal server errors. Please submit a support ticket if you encounter these at any time. 

Host

https://api.getnewclick.com

Resources

Create Schedule

Create a scheduled job. The scheduled job will run at the time you provide.

POST /api/public/schedules

Body Parameters (example)

{
    "shop": "senimanpins.myshopify.com",
    "publishDate": "2021-06-15",
    "publishTime": "09:37",
    "ISOString": "2021-06-16T04:37",
    "timezoneValue": "America/Los_Angeles",
    "themeId": "80552886409",
    "themeName": "test theme"
}

 

The Schedule Object

shop string *required

The .myshopify.com URL of a shop without https://

publishDate string *required

The start date of your event schedule. This will be the date your product is published. The status will change from "DRAFT" to "ACTIVE". Format is YYYY-MM-DD

publishTime string *required

The start time of your event schedule. This will be the time your product is published. Format is in 24 hour timehh:mm

ISOString  string *required 

The GMT start date/time of your event schedule in ISO format. This will be the time your product is published. Format is in 24 hour timeYYYY-MM-DDThh:mm:ss

timezoneValue  string *required 

Your timezone. This is the timezone used for the scheduled events. Format is Country/Region You can get your timezone using this javascript snippet:

const tzid = Intl.DateTimeFormat().resolvedOptions().timeZone;
console.log(tzid);

themeId string *required

The ID of your Shopify theme. Learn more about the Shopify theme object here.

 

themeName string *required

The name of your Shopify theme. Learn more about the Shopify theme object here.

 

 

Get Schedules 

Retrieves a list of all of your scheduled jobs. You only need to supply your myshopify URL.

GET /api/public/schedules

Query Parameters

{ shop: <yourstore.myshopify.com> }

 

Delete Schedule 

Delete a scheduled job. You only need to supply your myshopify URL and a schedule ID. 

DELETE /api/public/schedules

Body Parameters

{ shop: <yourstore.myshopify.com>, id: <SCHEDULE_ID>}