Create a new selling plan

Create a new selling plan

post

Authorizations

ApiKeyAuth

X-Auth-TokenstringRequired

Header parameters

X-Auth-TokenstringRequired

API key for authentication

Body

application/json

Responses

201

Selling plan created successfully

application/json

401

Unauthorized

422

Validation errors

application/json

post

/preorders

HTTPcURLJavaScriptPython

POST /api/v1/external/preorders HTTP/1.1
Host: app.stoqapp.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 1758

{
  "selling_plan": {
    "name": "text",
    "internal_name": "text",
    "enabled": true,
    "billing_type": "exact_time",
    "billing_at": "2026-01-15T05:23:57.658Z",
    "billing_after_n_intervals": 1,
    "billing_after_interval_type": "day",
    "billing_checkout_charge_amount": 1,
    "billing_checkout_charge_percentage": 1,
    "billing_checkout_charge_type": "percentage",
    "billing_title": "text",
    "billing_description": "text",
    "delivery_type": "anchor",
    "delivery_at": "2026-01-15T05:23:57.658Z",
    "delivery_after_n_intervals": 1,
    "delivery_after_interval_type": "day",
    "inventory_reserve_type": "on_sale",
    "inventory_provider": "stoq",
    "pricing_type": "percentage",
    "pricing_amount": 1,
    "pricing_percentage": 1,
    "quantity_limit_text": "text",
    "preorder_button_text": "text",
    "preorder_button_text_color": "text",
    "preorder_button_background_color": "text",
    "preorder_button_colors_enabled": true,
    "preorder_discounted_price_enabled": true,
    "preorder_button_description": "text",
    "preorder_button_description_background_color": "text",
    "preorder_button_description_border_radius": "text",
    "preorder_button_description_quantity_limit_suffix": "text",
    "preorder_button_description_shipping_text_prefix": "text",
    "preorder_button_description_show_quantity_limit": true,
    "preorder_button_description_show_shipping": true,
    "preorder_button_description_text_color": "text",
    "preorder_badge_enabled": true,
    "preorder_badge_text": "text",
    "preorder_badge_text_color": "text",
    "preorder_badge_background_color": "text",
    "preorder_shipping_text": "text",
    "shipping_text": "text",
    "shipping_line_item_property_enabled": true,
    "shipping_applies_to_all_products": true,
    "discount_text": "text",
    "preorder_tags": "text",
    "product_variants_source": "all",
    "product_variants_source_id": 1,
    "markets_enabled": true,
    "shopify_market_ids": [
      1
    ],
    "auto_collect_payment": true,
    "use_shopify_selling_plan": true
  }
}

{
  "id": "text",
  "name": "text",
  "internal_name": "text",
  "enabled": true,
  "billing_type": "exact_time",
  "billing_at": "2026-01-15T05:23:57.658Z",
  "billing_after_n_intervals": 1,
  "billing_after_interval_type": "day",
  "billing_checkout_charge_amount": 1,
  "billing_checkout_charge_percentage": 1,
  "billing_checkout_charge_type": "percentage",
  "billing_title": "text",
  "billing_description": "text",
  "delivery_type": "anchor",
  "delivery_at": "2026-01-15T05:23:57.658Z",
  "delivery_after_n_intervals": 1,
  "delivery_after_interval_type": "day",
  "inventory_reserve_type": "on_sale",
  "inventory_provider": "stoq",
  "pricing_type": "percentage",
  "pricing_amount": 1,
  "pricing_percentage": 1,
  "quantity_limit_text": "text",
  "preorder_button_text": "text",
  "preorder_button_text_color": "text",
  "preorder_button_background_color": "text",
  "preorder_button_colors_enabled": true,
  "preorder_discounted_price_enabled": true,
  "preorder_button_description": "text",
  "preorder_button_description_background_color": "text",
  "preorder_button_description_border_radius": "text",
  "preorder_button_description_quantity_limit_suffix": "text",
  "preorder_button_description_shipping_text_prefix": "text",
  "preorder_button_description_show_quantity_limit": true,
  "preorder_button_description_show_shipping": true,
  "preorder_button_description_text_color": "text",
  "preorder_badge_enabled": true,
  "preorder_badge_text": "text",
  "preorder_badge_text_color": "text",
  "preorder_badge_background_color": "text",
  "preorder_shipping_text": "text",
  "shipping_text": "text",
  "shipping_line_item_property_enabled": true,
  "shipping_applies_to_all_products": true,
  "discount_text": "text",
  "preorder_tags": "text",
  "product_variants_source": "all",
  "product_variants_source_id": 1,
  "selling_plan_product_variants_count": 1,
  "shopify_selling_plan_id": 1,
  "shopify_selling_plan_group_id": 1,
  "use_shopify_selling_plan": true,
  "shop_id": 1,
  "market_id": 1,
  "created_at": "2026-01-15T05:23:57.658Z",
  "updated_at": "2026-01-15T05:23:57.658Z",
  "discarded_at": "2026-01-15T05:23:57.658Z",
  "ongoing_job": true,
  "shopify_variant_ids": [
    1
  ]
}