List and filter selling plans

List and filter selling plans

get
Authorizations
Query parameters
namestringOptional

Filter by selling plan name or internal name

pageintegerOptional

Page number for pagination

per_pageintegerOptional

Number of items per page

Header parameters
X-Auth-TokenstringRequired

API key for authentication

Responses
200
A paginated list of selling plans
application/json
get
GET /api/v1/external/preorders HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Accept: */*
{
  "selling_plans": [
    {
      "id": "text",
      "name": "text",
      "internal_name": "text",
      "enabled": true,
      "selling_plan_product_variants_count": 1,
      "created_at": "2025-07-01T17:02:53.328Z",
      "updated_at": "2025-07-01T17:02:53.328Z",
      "shopify_variant_ids": [
        1
      ]
    }
  ],
  "meta": {
    "total_count": 1,
    "page": 1,
    "per_page": 1,
    "total_pages": 1
  }
}

Last updated