Skip to main content
POST
/
api
/
v1
/
:team_slug
/
:app_slug
/
schedule
Error
A valid request URL is required to generate request examples
{
  "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": 123,
    "to_market_id": "<string>",
    "to_market_status": "<string>",
    "to_on_sale": true,
    "to_sale_amount_cents_with_tax": 123,
    "to_status": "<string>",
    "to_store_group_id": "<string>"
  },
  "details": [
    "<string>"
  ],
  "success": true
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Body

application/json

Scheduling data

​
execute_at
string
required

Execute at is the date when the product should change date. This date need to follow the format YYYY-MM-DD

​
item_id
string
required
​
item_type
enum<string>
required
Available options:
product,
tag,
image,
price,
variant
​
add_categories
string[]
​
add_collections
string[]
​
add_tags
string[]
​
remove_categories
string[]
​
remove_collections
string[]
​
remove_tags
string[]
​
to_market_id
string

Market ID for market status change. Only used when item_type is product

​
to_market_status
enum<string>

Target market status. Only used when item_type is product

Available options:
active,
inactive,
draft,
archived
​
to_on_sale
boolean

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

Used to change the price on a specific date. Only used when item_type is price

​
to_sale_price_with_tax
integer

Used to change the sale price on a specific date. Only used when item_type is price

​
to_status
enum<string>
Available options:
active,
inactive,
archived,
draft
​
to_store_group_id
string

Store group ID for market status change. Only used when item_type is product

Response

Job is scheduled

​
data
object
​
details
string[]

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