Skip to main content

Create Season

POST 

/api/v2/seasons

Create a season.

Required scope: products:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Body:

  • code (required, string, max 20): unique short code, e.g. FW26. Must not already be used by another season.
  • name (required, string, max 120)
  • starts_on (optional, date Y-m-d)
  • ends_on (optional, date Y-m-d, on or after starts_on)
  • status (optional): planned, selling or ended. A status you send is kept as set (status_manual becomes true) and the daily refresh leaves it alone. When omitted (or null) the status is set from the dates — planned before starts_on, ended after ends_on, selling in between or when there are no dates — and is kept in step with the dates every day (status_manual false). Send null on an update to hand a hand-picked status back to the dates.
  • sort_order (optional, integer 0–100000, default 100): display order.

Returns the new season. Season fields: id, code (short code such as SS26), name, starts_on and ends_on (Y-m-d dates or null), status (planned, selling or ended), status_manual (true when the status was picked by hand and no longer follows the dates), sort_order, created_at, updated_at (ISO 8601).

Requires a Bearer token with the products read/write scope and the settings.update permission.

Request​

Responses​

OK

Response Headers
    Content-Type