List and filter selling plans

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

GET/external/preorders

Costs 1 rate-limit point · Rate limits

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.

Query parameters

namestring
Filter by selling plan name or internal name
pageinteger
Page number for pagination
per_pageinteger
Number of items per page

Headers

X-Auth-TokenstringRequired
API key for authentication

Returns

selling_plansarray of objects
Show 8 child attributesHide child attributes
- idstring
  Unique identifier for the selling plan
- namestring
  Display name of the selling plan
- internal_namestring
  Internal name for the selling plan
- enabledboolean
  Whether the selling plan is enabled
- selling_plan_product_variants_countinteger
  Number of product variants associated with this selling plan
- created_atstring
  Timestamp when the selling plan was created
- updated_atstring
  Timestamp when the selling plan was last updated
- shopify_variant_idsarray of integers
  List of Shopify variant IDs associated with this selling plan
metaobject
Show 4 child attributesHide child attributes
- total_countinteger
  Example: 3
- pageinteger
  Example: 1
- per_pageinteger
  Example: 25
- total_pagesinteger
  Example: 1

Errors

400

Bad request

401

Unauthorized

GET/external/preorders

curl "https://app.stoqapp.com/api/v1/external/preorders" \
  -H "X-Auth-Token: $STOQ_API_KEY"

const res = await fetch("https://app.stoqapp.com/api/v1/external/preorders", {
  headers: {
    "X-Auth-Token": process.env.STOQ_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.stoqapp.com/api/v1/external/preorders",
    headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.stoqapp.com/api/v1/external/preorders")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "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
  }
}