Create Scheduled Job
Schedules a new job to modify item status, price, tags, categories, or collections at a specified future date. Supports products, tags, images, prices, and variants.
POST
/api/v1/{team_slug}/{app_slug}/schedule- API
- Management
- OpenAPI
- management-api
- Updated
- Apr 26, 2026
management-api:POST:/api/v1/{team_slug}/{app_slug}/schedule
Schedules a new job to modify item status, price, tags, categories, or collections at a specified future date. Supports products, tags, images, prices, and variants.
API ownership
- API family: Management API
- Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
- Do not use from: Browser-only storefront code or public clients.
- Guide route: /apis/management/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
Operation
- Method:
POST - Path:
/api/v1/\{team_slug\}/\{app_slug\}/schedule - Summary: Create Scheduled Job
- Description: Schedules a new job to modify item status, price, tags, categories, or collections at a specified future date. Supports products, tags, images, prices, and variants.
- OpenAPI contract: management-api
- Operation ID: Not documented in the OpenAPI contract.
Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| app_slug | path | Yes | string | App slug |
| team_slug | path | Yes | string | Team slug |
Request body
- Required: Yes
- Description: Scheduling data
- Content: application/json (object)
Create Scheduling Payload
| Property | Type | Required | Details |
|---|---|---|---|
add_categories | string[] | No | - |
add_collections | string[] | No | - |
add_tags | string[] | No | - |
execute_at | string | Yes | Execute at is the date when the product should change date. This date need to follow the format YYYY-MM-DD |
item_id | string | Yes | - |
item_type | enum("product", "tag", "image", "price", "variant") | Yes | - |
remove_categories | string[] | No | - |
remove_collections | string[] | No | - |
remove_tags | string[] | No | - |
to_market_id | string | No | Market ID for market status change. Only used when item_type is product |
to_market_status | enum("active", "inactive", "draft", "archived") | No | Target market status. Only used when item_type is product |
to_on_sale | boolean | No | Used to change if a price is on sale on a specific date. Only used when item_type is price |
to_price_with_tax | integer | No | Used to change the price on a specific date. Only used when item_type is price |
to_sale_price_with_tax | integer | No | Used to change the sale price on a specific date. Only used when item_type is price |
to_start_sale_timestamp | string | No | Used to set the start sale timestamp on a specific date. Only used when item_type is price. Expects RFC3339 format. |
to_status | enum("active", "inactive", "archived", "draft") | No | - |
to_stop_sale_timestamp | string | No | Used to set the stop sale timestamp on a specific date. Only used when item_type is price. Expects RFC3339 format. |
to_store_group_id | string | No | Store group ID for market status change. Only used when item_type is product |
Generated example (synthetic):
{
"add_categories": [
"string"
],
"add_collections": [
"string"
],
"add_tags": [
"string"
],
"execute_at": "string",
"item_id": "string",
"item_type": "product",
"remove_categories": [
"string"
],
"remove_collections": [
"string"
],
"remove_tags": [
"string"
],
"to_market_id": "string",
"to_market_status": "active",
"to_on_sale": false,
"to_price_with_tax": 0,
"to_sale_price_with_tax": 0,
"to_start_sale_timestamp": "string",
"to_status": "active",
"to_stop_sale_timestamp": "string",
"to_store_group_id": "string"
}Responses
| Status | Description | Content |
|---|---|---|
| 200 | Job is scheduled | application/json (object) |
| 400 | Invalid request (e.g. bad UUID, validation error) | application/json (object) |
| 401 | Unauthorized access | application/json (object) |
| 500 | Internal server error | application/json (object) |
200 - object
Scheduling Response
| Property | Type | Required | Details |
|---|---|---|---|
data | object | No | - |
details | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes |
success | boolean | No | - |
Job
| Property | Type | Required | Details |
|---|---|---|---|
add_category_names | string[] | No | - |
add_collection_names | string[] | No | - |
add_tag_names | string[] | No | - |
execute_at | string | No | Date when the job should run |
finished_at | string | No | If a job is finished will this timestamp be filled |
id | string | No | - |
item_id | string | No | - |
item_name | string | No | - |
item_type | string | No | - |
remove_category_names | string[] | No | - |
remove_collection_names | string[] | No | - |
remove_tag_names | string[] | No | - |
to_amount_cents_with_tax | integer | No | - |
to_market_id | string | No | - |
to_market_status | string | No | - |
to_on_sale | boolean | No | - |
to_sale_amount_cents_with_tax | integer | No | - |
to_start_sale_timestamp | string | No | - |
to_status | string | No | - |
to_stop_sale_timestamp | string | No | - |
to_store_group_id | string | No | - |
{
"data": {
"add_category_names": [
"string"
],
"add_collection_names": [
"string"
],
"add_tag_names": [
"string"
],
"execute_at": "string",
"finished_at": "string",
"id": "string",
"item_id": "string",
"item_name": "string",
"item_type": "string",
"remove_category_names": [
"string"
],
"remove_collection_names": [
"string"
],
"remove_tag_names": [
"string"
],
"to_amount_cents_with_tax": 0,
"to_market_id": "string",
"to_market_status": "string",
"to_on_sale": false,
"to_sale_amount_cents_with_tax": 0,
"to_start_sale_timestamp": "string",
"to_status": "string",
"to_stop_sale_timestamp": "string",
"to_store_group_id": "string"
},
"details": [
"string"
],
"success": false
}400 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}401 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}500 - object
Error Message
| Property | Type | Required | Details |
|---|---|---|---|
details | string[] | No | - |
message | string | No | - |
success | boolean | No | - |
Generated example (synthetic):
{
"details": [
"string"
],
"message": "string",
"success": false
}Contract identity
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Management API
- Method:
POST - Path:
/api/v1/\{team_slug\}/\{app_slug\}/schedule - Operation ID: Not documented in the OpenAPI contract.
- OpenAPI tag: Scheduling
- OpenAPI summary: Create Scheduled Job