List and filter selling plans

LegacyAPI v1 is the older API. It still works and is supported, but new integrations should use API v2. Migrating from v1 to v2

GET

/external/preorders

const url = 'https://app.stoqapp.com/api/v1/external/preorders';
const options = {method: 'GET', headers: {'X-Auth-Token': '<X-Auth-Token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://app.stoqapp.com/api/v1/external/preorders \
  --header 'X-Auth-Token: <X-Auth-Token>'

List the shop’s preorder selling plans, newest first, with page-based pagination. Optionally filter by name (matches the display or internal name). Returns a lightweight representation of each plan plus pagination metadata; use Get a Specific Selling Plan for the full object.

Authorizations

ApiKeyAuth

Parameters

Header Parameters

X-Auth-Token

required

string

API key for authentication

Query Parameters

name

string

Filter by selling plan name or internal name

page

integer

Page number for pagination

per_page

integer

Number of items per page

Responses

200

A paginated list of selling plans

application/json

object

selling_plans

Array<object>

Simplified selling plan object for list views

object

Unique identifier for the selling plan

string

name

Display name of the selling plan

string

internal_name

Internal name for the selling plan

string

enabled

Whether the selling plan is enabled

boolean

selling_plan_product_variants_count

Number of product variants associated with this selling plan

integer

created_at

Timestamp when the selling plan was created

string format: date-time

updated_at

Timestamp when the selling plan was last updated

string format: date-time

shopify_variant_ids

List of Shopify variant IDs associated with this selling plan

Array<integer>

meta

object

total_count

integer

page

integer

per_page

integer

total_pages

integer

Example

{
  "selling_plans": [
    {
      "id": "79b44c6c-ebc7-41d4-8a1b-573d7c693454",
      "name": "Summer Preorder",
      "internal_name": "summer-2026",
      "enabled": true,
      "selling_plan_product_variants_count": 12,
      "created_at": "2026-06-20T10:00:00Z",
      "updated_at": "2026-06-24T08:30:00Z",
      "shopify_variant_ids": [
        43900910010503,
        43900910010999
      ]
    }
  ],
  "meta": {
    "total_count": 3,
    "page": 1,
    "per_page": 25,
    "total_pages": 1
  }
}

400

Bad request

401

Unauthorized

Was this page helpful?

Still stuck? Ask Quinn or chat with support