Admin API

Payment pages

Single product pages with their own checkout, and their A/B tests.

GETPayment pages, newest first
POSTCreate a payment page (a draft until published)
GETOne payment page
PATCHChange the draft (and the address); buyers see it after the next publish
GETA page's A/B tests, newest first, with results
POSTStart an A/B test on a published page
POSTStop an A/B test; choosing B applies its changes to the page and publishes it
POSTMake the draft live
POSTTake the page offline
GETVisitors, checkout starts, orders, revenue and conversion for every page over a period
GETPrivacy, terms, refund and shipping policies
PUTSave the store text of a policy (an empty body goes back to the template)

Payment pages, newest first

GET/admin/2026-11/pages

scope read_pages

Query parameters

limitinteger
Items per page, 1 to 250.
Default 50 · 1 to 250
afterstring
Cursor from a previous next_cursor.
Up to 512 characters
statusenum
One of draft published unpublished
qstring
Words in the title or address.
Up to 100 characters

Response 200

dataarray of objectrequired
data[].idID (pag_...)required
data[].slugstringrequired
data[].statusenumrequired
One of draft published unpublished
data[].draftobjectrequired
data[].draft.templateenumrequired
One of single_product digital_download course booking community donation
data[].draft.titlestringrequired
At least 1 characters · Up to 120 characters
data[].draft.descriptionstringrequired
Up to 5000 characters
data[].draft.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
data[].draft.product_idID (prd_...) or nullrequired
data[].draft.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
data[].draft.bump_textstringrequired
Up to 200 characters
data[].draft.button_labelstringrequired
At least 1 characters · Up to 40 characters
data[].draft.faqarray of objectrequired
Up to 10 items
data[].draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
data[].draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
data[].draft.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
data[].draft.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
data[].draft.pay_what_you_want.enabledbooleanrequired
data[].draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
data[].draft.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
data[].draft.questions[].idstringrequired
data[].draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
data[].draft.questions[].requiredbooleanrequired
data[].draft.sales_limitinteger or nullrequired
Default null
data[].draft.ends_attimestamp or nullrequired
Default null
data[].draft.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
data[].draft.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
data[].draft.allow_couponsbooleanrequired
Default true
data[].draft.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
data[].draft.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
data[].draft.highlightsarray of stringrequired
Up to 12 items
data[].draft.reviewsarray of objectrequired
Up to 10 items
data[].draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
data[].draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
data[].draft.reviews[].ratingintegerrequired
1 to 5
data[].draft.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
data[].draft.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
data[].draft.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
data[].draft.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
data[].draft.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
data[].draft.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
data[].draft.offer_timerobjectrequired
An offer timer and where it shows (D-111).
data[].draft.offer_timer.enabledbooleanrequired
Default false
data[].draft.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
data[].draft.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
data[].draft.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
data[].draft.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
data[].draft.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
data[].draft.support_emailstring or nullrequired
Default null
data[].draft.support_phonestring or nullrequired
Default null
data[].draft.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
data[].draft.policiesobjectrequired
This page's own policies; empty ones use the store policy.
data[].draft.policies.termsstringrequired
Up to 20000 characters
data[].draft.policies.refundstringrequired
Up to 20000 characters
data[].draft.policies.privacystringrequired
Up to 20000 characters
data[].draft.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
data[].draft.seo_titlestringrequired
Up to 70 characters
data[].draft.seo_descriptionstringrequired
Up to 320 characters
data[].draft.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
data[].draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
data[].draft.blocks[].enabledbooleanrequired
data[].publishedobject or nullrequired
data[].published.templateenumrequired
One of single_product digital_download course booking community donation
data[].published.titlestringrequired
At least 1 characters · Up to 120 characters
data[].published.descriptionstringrequired
Up to 5000 characters
data[].published.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
data[].published.product_idID (prd_...) or nullrequired
data[].published.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
data[].published.bump_textstringrequired
Up to 200 characters
data[].published.button_labelstringrequired
At least 1 characters · Up to 40 characters
data[].published.faqarray of objectrequired
Up to 10 items
data[].published.faq[].qstringrequired
At least 1 characters · Up to 200 characters
data[].published.faq[].astringrequired
At least 1 characters · Up to 1000 characters
data[].published.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
data[].published.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
data[].published.pay_what_you_want.enabledbooleanrequired
data[].published.pay_what_you_want.min_amountintegerrequired
100 to 10000000
data[].published.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
data[].published.questions[].idstringrequired
data[].published.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
data[].published.questions[].requiredbooleanrequired
data[].published.sales_limitinteger or nullrequired
Default null
data[].published.ends_attimestamp or nullrequired
Default null
data[].published.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
data[].published.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
data[].published.allow_couponsbooleanrequired
Default true
data[].published.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
data[].published.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
data[].published.highlightsarray of stringrequired
Up to 12 items
data[].published.reviewsarray of objectrequired
Up to 10 items
data[].published.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
data[].published.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
data[].published.reviews[].ratingintegerrequired
1 to 5
data[].published.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
data[].published.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
data[].published.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
data[].published.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
data[].published.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
data[].published.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
data[].published.offer_timerobjectrequired
An offer timer and where it shows (D-111).
data[].published.offer_timer.enabledbooleanrequired
Default false
data[].published.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
data[].published.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
data[].published.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
data[].published.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
data[].published.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
data[].published.support_emailstring or nullrequired
Default null
data[].published.support_phonestring or nullrequired
Default null
data[].published.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
data[].published.policiesobjectrequired
This page's own policies; empty ones use the store policy.
data[].published.policies.termsstringrequired
Up to 20000 characters
data[].published.policies.refundstringrequired
Up to 20000 characters
data[].published.policies.privacystringrequired
Up to 20000 characters
data[].published.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
data[].published.seo_titlestringrequired
Up to 70 characters
data[].published.seo_descriptionstringrequired
Up to 320 characters
data[].published.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
data[].published.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
data[].published.blocks[].enabledbooleanrequired
data[].has_unpublished_changesbooleanrequired
data[].published_attimestamp or nullrequired
data[].salesobjectrequired
data[].sales.ordersintegerrequired
data[].sales.totalintegerrequired
data[].created_attimestamprequired
data[].updated_attimestamprequired
has_morebooleanrequired
next_cursorstring or nullrequired

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/pages \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "slug": "festive-saree",
      "status": "draft",
      "draft": {
        "template": "single_product",
        "title": "Festive saree",
        "description": "Hand block printed cotton.",
        "description_html": "",
        "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "bump_text": "Hand block printed cotton.",
        "button_label": "string",
        "faq": [
          {}
        ],
        "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "pay_what_you_want": {
          "enabled": false,
          "min_amount": 49900
        },
        "questions": [
          {}
        ],
        "sales_limit": 1,
        "ends_at": "2026-11-04T10:00:00.000Z",
        "delivery_url": "https://example.com",
        "thank_you_url": "https://example.com",
        "allow_coupons": true,
        "badge": "",
        "highlights_title": "What you get",
        "highlights": [
          "string"
        ],
        "reviews": [
          {}
        ],
        "accent": "indigo",
        "style": "spotlight",
        "video_url": "https://example.com",
        "show_sales_count": false,
        "show_countdown": true,
        "product_page": false,
        "offer_timer": {
          "enabled": false,
          "mode": "end_date",
          "minutes": 30,
          "label": "Offer ends in",
          "places": [],
          "style": "boxes"
        },
        "support_email": "buyer@example.com",
        "support_phone": "+919876543210",
        "thank_you_message": "",
        "policies": {
          "terms": "",
          "refund": "",
          "privacy": ""
        },
        "sections": [
          {}
        ],
        "seo_title": "",
        "seo_description": "",
        "blocks": [
          {}
        ]
      },
      "published": {
        "template": "single_product",
        "title": "Festive saree",
        "description": "Hand block printed cotton.",
        "description_html": "",
        "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "bump_text": "Hand block printed cotton.",
        "button_label": "string",
        "faq": [
          {}
        ],
        "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "pay_what_you_want": {
          "enabled": false,
          "min_amount": 49900
        },
        "questions": [
          {}
        ],
        "sales_limit": 1,
        "ends_at": "2026-11-04T10:00:00.000Z",
        "delivery_url": "https://example.com",
        "thank_you_url": "https://example.com",
        "allow_coupons": true,
        "badge": "",
        "highlights_title": "What you get",
        "highlights": [
          "string"
        ],
        "reviews": [
          {}
        ],
        "accent": "indigo",
        "style": "spotlight",
        "video_url": "https://example.com",
        "show_sales_count": false,
        "show_countdown": true,
        "product_page": false,
        "offer_timer": {
          "enabled": false,
          "mode": "end_date",
          "minutes": 30,
          "label": "Offer ends in",
          "places": [],
          "style": "boxes"
        },
        "support_email": "buyer@example.com",
        "support_phone": "+919876543210",
        "thank_you_message": "",
        "policies": {
          "terms": "",
          "refund": "",
          "privacy": ""
        },
        "sections": [
          {}
        ],
        "seo_title": "",
        "seo_description": "",
        "blocks": [
          {}
        ]
      },
      "has_unpublished_changes": false,
      "published_at": "2026-11-04T10:00:00.000Z",
      "sales": {
        "orders": 1,
        "total": 49900
      },
      "created_at": "2026-11-04T10:00:00.000Z",
      "updated_at": "2026-11-04T10:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJpZCI6Ii4uLiJ9"
}

Create a payment page (a draft until published)

POST/admin/2026-11/pages

scope write_pagesIdempotency-Key required

Headers

Idempotency-Keystringrequired
Unique key for this request. Retries with the same key return the first response.
At least 1 characters · Up to 255 characters
X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Request body

titlestringrequired
At least 1 characters · Up to 120 characters
templateenum
One of single_product digital_download course booking community donation
Default "single_product"
product_idID (prd_...) or null
Default null
slugstring
At least 2 characters · Up to 60 characters

Response 201

idID (pag_...)required
slugstringrequired
statusenumrequired
One of draft published unpublished
draftobjectrequired
draft.templateenumrequired
One of single_product digital_download course booking community donation
draft.titlestringrequired
At least 1 characters · Up to 120 characters
draft.descriptionstringrequired
Up to 5000 characters
draft.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
draft.product_idID (prd_...) or nullrequired
draft.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
draft.bump_textstringrequired
Up to 200 characters
draft.button_labelstringrequired
At least 1 characters · Up to 40 characters
draft.faqarray of objectrequired
Up to 10 items
draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
draft.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
draft.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
draft.pay_what_you_want.enabledbooleanrequired
draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
draft.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
draft.questions[].idstringrequired
draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
draft.questions[].requiredbooleanrequired
draft.sales_limitinteger or nullrequired
Default null
draft.ends_attimestamp or nullrequired
Default null
draft.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
draft.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
draft.allow_couponsbooleanrequired
Default true
draft.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
draft.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
draft.highlightsarray of stringrequired
Up to 12 items
draft.reviewsarray of objectrequired
Up to 10 items
draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
draft.reviews[].ratingintegerrequired
1 to 5
draft.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
draft.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
draft.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
draft.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
draft.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
draft.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
draft.offer_timerobjectrequired
An offer timer and where it shows (D-111).
draft.offer_timer.enabledbooleanrequired
Default false
draft.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
draft.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
draft.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
draft.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
draft.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
draft.support_emailstring or nullrequired
Default null
draft.support_phonestring or nullrequired
Default null
draft.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
draft.policiesobjectrequired
This page's own policies; empty ones use the store policy.
draft.policies.termsstringrequired
Up to 20000 characters
draft.policies.refundstringrequired
Up to 20000 characters
draft.policies.privacystringrequired
Up to 20000 characters
draft.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
draft.seo_titlestringrequired
Up to 70 characters
draft.seo_descriptionstringrequired
Up to 320 characters
draft.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
draft.blocks[].enabledbooleanrequired
publishedobject or nullrequired
published.templateenumrequired
One of single_product digital_download course booking community donation
published.titlestringrequired
At least 1 characters · Up to 120 characters
published.descriptionstringrequired
Up to 5000 characters
published.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
published.product_idID (prd_...) or nullrequired
published.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
published.bump_textstringrequired
Up to 200 characters
published.button_labelstringrequired
At least 1 characters · Up to 40 characters
published.faqarray of objectrequired
Up to 10 items
published.faq[].qstringrequired
At least 1 characters · Up to 200 characters
published.faq[].astringrequired
At least 1 characters · Up to 1000 characters
published.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
published.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
published.pay_what_you_want.enabledbooleanrequired
published.pay_what_you_want.min_amountintegerrequired
100 to 10000000
published.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
published.questions[].idstringrequired
published.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
published.questions[].requiredbooleanrequired
published.sales_limitinteger or nullrequired
Default null
published.ends_attimestamp or nullrequired
Default null
published.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
published.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
published.allow_couponsbooleanrequired
Default true
published.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
published.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
published.highlightsarray of stringrequired
Up to 12 items
published.reviewsarray of objectrequired
Up to 10 items
published.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
published.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
published.reviews[].ratingintegerrequired
1 to 5
published.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
published.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
published.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
published.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
published.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
published.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
published.offer_timerobjectrequired
An offer timer and where it shows (D-111).
published.offer_timer.enabledbooleanrequired
Default false
published.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
published.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
published.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
published.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
published.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
published.support_emailstring or nullrequired
Default null
published.support_phonestring or nullrequired
Default null
published.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
published.policiesobjectrequired
This page's own policies; empty ones use the store policy.
published.policies.termsstringrequired
Up to 20000 characters
published.policies.refundstringrequired
Up to 20000 characters
published.policies.privacystringrequired
Up to 20000 characters
published.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
published.seo_titlestringrequired
Up to 70 characters
published.seo_descriptionstringrequired
Up to 320 characters
published.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
published.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
published.blocks[].enabledbooleanrequired
has_unpublished_changesbooleanrequired
published_attimestamp or nullrequired
salesobjectrequired
sales.ordersintegerrequired
sales.totalintegerrequired
created_attimestamprequired
updated_attimestamprequired

Errors

400	`idempotency_key_required`	Every POST needs an Idempotency-Key header.
400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
409	`conflict`	The request conflicts with the current state of the object.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
422	`idempotency_key_reused`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X POST https://api.storelyne.com/admin/2026-11/pages \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Festive saree"
}'

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "title": "Festive saree"
  }),
});
const data = await res.json();

Response 201

{
  "id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "slug": "festive-saree",
  "status": "draft",
  "draft": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "published": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "has_unpublished_changes": false,
  "published_at": "2026-11-04T10:00:00.000Z",
  "sales": {
    "orders": 1,
    "total": 49900
  },
  "created_at": "2026-11-04T10:00:00.000Z",
  "updated_at": "2026-11-04T10:00:00.000Z"
}

One payment page

GET/admin/2026-11/pages/{id}

scope read_pages

Path parameters

idID (pag_...)required

Response 200

idID (pag_...)required
slugstringrequired
statusenumrequired
One of draft published unpublished
draftobjectrequired
draft.templateenumrequired
One of single_product digital_download course booking community donation
draft.titlestringrequired
At least 1 characters · Up to 120 characters
draft.descriptionstringrequired
Up to 5000 characters
draft.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
draft.product_idID (prd_...) or nullrequired
draft.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
draft.bump_textstringrequired
Up to 200 characters
draft.button_labelstringrequired
At least 1 characters · Up to 40 characters
draft.faqarray of objectrequired
Up to 10 items
draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
draft.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
draft.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
draft.pay_what_you_want.enabledbooleanrequired
draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
draft.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
draft.questions[].idstringrequired
draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
draft.questions[].requiredbooleanrequired
draft.sales_limitinteger or nullrequired
Default null
draft.ends_attimestamp or nullrequired
Default null
draft.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
draft.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
draft.allow_couponsbooleanrequired
Default true
draft.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
draft.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
draft.highlightsarray of stringrequired
Up to 12 items
draft.reviewsarray of objectrequired
Up to 10 items
draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
draft.reviews[].ratingintegerrequired
1 to 5
draft.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
draft.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
draft.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
draft.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
draft.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
draft.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
draft.offer_timerobjectrequired
An offer timer and where it shows (D-111).
draft.offer_timer.enabledbooleanrequired
Default false
draft.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
draft.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
draft.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
draft.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
draft.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
draft.support_emailstring or nullrequired
Default null
draft.support_phonestring or nullrequired
Default null
draft.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
draft.policiesobjectrequired
This page's own policies; empty ones use the store policy.
draft.policies.termsstringrequired
Up to 20000 characters
draft.policies.refundstringrequired
Up to 20000 characters
draft.policies.privacystringrequired
Up to 20000 characters
draft.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
draft.seo_titlestringrequired
Up to 70 characters
draft.seo_descriptionstringrequired
Up to 320 characters
draft.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
draft.blocks[].enabledbooleanrequired
publishedobject or nullrequired
published.templateenumrequired
One of single_product digital_download course booking community donation
published.titlestringrequired
At least 1 characters · Up to 120 characters
published.descriptionstringrequired
Up to 5000 characters
published.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
published.product_idID (prd_...) or nullrequired
published.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
published.bump_textstringrequired
Up to 200 characters
published.button_labelstringrequired
At least 1 characters · Up to 40 characters
published.faqarray of objectrequired
Up to 10 items
published.faq[].qstringrequired
At least 1 characters · Up to 200 characters
published.faq[].astringrequired
At least 1 characters · Up to 1000 characters
published.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
published.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
published.pay_what_you_want.enabledbooleanrequired
published.pay_what_you_want.min_amountintegerrequired
100 to 10000000
published.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
published.questions[].idstringrequired
published.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
published.questions[].requiredbooleanrequired
published.sales_limitinteger or nullrequired
Default null
published.ends_attimestamp or nullrequired
Default null
published.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
published.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
published.allow_couponsbooleanrequired
Default true
published.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
published.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
published.highlightsarray of stringrequired
Up to 12 items
published.reviewsarray of objectrequired
Up to 10 items
published.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
published.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
published.reviews[].ratingintegerrequired
1 to 5
published.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
published.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
published.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
published.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
published.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
published.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
published.offer_timerobjectrequired
An offer timer and where it shows (D-111).
published.offer_timer.enabledbooleanrequired
Default false
published.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
published.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
published.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
published.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
published.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
published.support_emailstring or nullrequired
Default null
published.support_phonestring or nullrequired
Default null
published.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
published.policiesobjectrequired
This page's own policies; empty ones use the store policy.
published.policies.termsstringrequired
Up to 20000 characters
published.policies.refundstringrequired
Up to 20000 characters
published.policies.privacystringrequired
Up to 20000 characters
published.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
published.seo_titlestringrequired
Up to 70 characters
published.seo_descriptionstringrequired
Up to 320 characters
published.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
published.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
published.blocks[].enabledbooleanrequired
has_unpublished_changesbooleanrequired
published_attimestamp or nullrequired
salesobjectrequired
sales.ordersintegerrequired
sales.totalintegerrequired
created_attimestamprequired
updated_attimestamprequired

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "slug": "festive-saree",
  "status": "draft",
  "draft": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "published": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "has_unpublished_changes": false,
  "published_at": "2026-11-04T10:00:00.000Z",
  "sales": {
    "orders": 1,
    "total": 49900
  },
  "created_at": "2026-11-04T10:00:00.000Z",
  "updated_at": "2026-11-04T10:00:00.000Z"
}

Change the draft (and the address); buyers see it after the next publish

PATCH/admin/2026-11/pages/{id}

scope write_pages

Path parameters

idID (pag_...)required

Headers

X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Request body

slugstring
At least 2 characters · Up to 60 characters
draftobject
draft.templateenum
One of single_product digital_download course booking community donation
draft.titlestring
At least 1 characters · Up to 120 characters
draft.descriptionstring
Up to 5000 characters
draft.description_htmlstring
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
draft.product_idID (prd_...) or null
draft.bump_product_idID (prd_...) or null
An optional add-on offered with a checkbox (order bump).
draft.bump_textstring
Up to 200 characters
draft.button_labelstring
At least 1 characters · Up to 40 characters
draft.faqarray of object
Up to 10 items
draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
draft.cover_file_idID (fil_...) or null
An uploaded image shown at the top of the page.
Default null
draft.pay_what_you_wantobject or null
Buyers choose the price, at least min_amount (paise).
Default null
draft.pay_what_you_want.enabledbooleanrequired
draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
draft.questionsarray of object
Asked on the page; the answers go on the order.
Up to 5 items
draft.questions[].idstringrequired
draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
draft.questions[].requiredbooleanrequired
draft.sales_limitinteger or null
Default null
draft.ends_attimestamp or null
Default null
draft.delivery_urlstring or null
A link the buyer gets after paying (a course, a group, a meeting).
Default null
draft.thank_you_urlstring or null
Where to send the buyer after the thank-you page.
Default null
draft.allow_couponsboolean
Default true
draft.badgestring
A short line above the title, such as Live on 16 November.
Up to 60 characters
draft.highlights_titlestring
Default "What you get" · Up to 80 characters
draft.highlightsarray of string
Up to 12 items
draft.reviewsarray of object
Up to 10 items
draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
draft.reviews[].ratingintegerrequired
1 to 5
draft.accentenum
One of indigo blue teal green orange rose charcoal
Default "indigo"
draft.styleenum
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
draft.video_urlstring or null
A YouTube video shown under the cover.
Default null
draft.show_sales_countboolean
Show how many people bought, once there are 10 or more.
Default false
draft.show_countdownboolean
Count down to the end date when there is one.
Default true
draft.product_pageboolean
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
draft.offer_timerobject
An offer timer and where it shows (D-111).
Default {}
draft.offer_timer.enabledboolean
Default false
draft.offer_timer.modeenum
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
draft.offer_timer.minutesinteger
Default 30 · 5 to 10080
draft.offer_timer.labelstring
Default "Offer ends in" · Up to 80 characters
draft.offer_timer.placesarray of enum
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
draft.offer_timer.styleenum
One of boxes inline
Default "boxes"
draft.support_emailstring or null
Default null
draft.support_phonestring or null
Default null
draft.thank_you_messagestring
Shown to the buyer after paying.
Up to 500 characters
draft.policiesobject
This page's own policies; empty ones use the store policy.
Default {}
draft.policies.termsstring
Up to 20000 characters
draft.policies.refundstring
Up to 20000 characters
draft.policies.privacystring
Up to 20000 characters
draft.sectionsarray of object
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
draft.seo_titlestring
Up to 70 characters
draft.seo_descriptionstring
Up to 320 characters
draft.blocksarray of object
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
draft.blocks[].enabledbooleanrequired

Response 200

idID (pag_...)required
slugstringrequired
statusenumrequired
One of draft published unpublished
draftobjectrequired
draft.templateenumrequired
One of single_product digital_download course booking community donation
draft.titlestringrequired
At least 1 characters · Up to 120 characters
draft.descriptionstringrequired
Up to 5000 characters
draft.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
draft.product_idID (prd_...) or nullrequired
draft.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
draft.bump_textstringrequired
Up to 200 characters
draft.button_labelstringrequired
At least 1 characters · Up to 40 characters
draft.faqarray of objectrequired
Up to 10 items
draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
draft.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
draft.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
draft.pay_what_you_want.enabledbooleanrequired
draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
draft.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
draft.questions[].idstringrequired
draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
draft.questions[].requiredbooleanrequired
draft.sales_limitinteger or nullrequired
Default null
draft.ends_attimestamp or nullrequired
Default null
draft.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
draft.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
draft.allow_couponsbooleanrequired
Default true
draft.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
draft.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
draft.highlightsarray of stringrequired
Up to 12 items
draft.reviewsarray of objectrequired
Up to 10 items
draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
draft.reviews[].ratingintegerrequired
1 to 5
draft.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
draft.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
draft.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
draft.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
draft.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
draft.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
draft.offer_timerobjectrequired
An offer timer and where it shows (D-111).
draft.offer_timer.enabledbooleanrequired
Default false
draft.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
draft.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
draft.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
draft.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
draft.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
draft.support_emailstring or nullrequired
Default null
draft.support_phonestring or nullrequired
Default null
draft.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
draft.policiesobjectrequired
This page's own policies; empty ones use the store policy.
draft.policies.termsstringrequired
Up to 20000 characters
draft.policies.refundstringrequired
Up to 20000 characters
draft.policies.privacystringrequired
Up to 20000 characters
draft.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
draft.seo_titlestringrequired
Up to 70 characters
draft.seo_descriptionstringrequired
Up to 320 characters
draft.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
draft.blocks[].enabledbooleanrequired
publishedobject or nullrequired
published.templateenumrequired
One of single_product digital_download course booking community donation
published.titlestringrequired
At least 1 characters · Up to 120 characters
published.descriptionstringrequired
Up to 5000 characters
published.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
published.product_idID (prd_...) or nullrequired
published.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
published.bump_textstringrequired
Up to 200 characters
published.button_labelstringrequired
At least 1 characters · Up to 40 characters
published.faqarray of objectrequired
Up to 10 items
published.faq[].qstringrequired
At least 1 characters · Up to 200 characters
published.faq[].astringrequired
At least 1 characters · Up to 1000 characters
published.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
published.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
published.pay_what_you_want.enabledbooleanrequired
published.pay_what_you_want.min_amountintegerrequired
100 to 10000000
published.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
published.questions[].idstringrequired
published.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
published.questions[].requiredbooleanrequired
published.sales_limitinteger or nullrequired
Default null
published.ends_attimestamp or nullrequired
Default null
published.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
published.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
published.allow_couponsbooleanrequired
Default true
published.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
published.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
published.highlightsarray of stringrequired
Up to 12 items
published.reviewsarray of objectrequired
Up to 10 items
published.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
published.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
published.reviews[].ratingintegerrequired
1 to 5
published.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
published.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
published.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
published.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
published.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
published.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
published.offer_timerobjectrequired
An offer timer and where it shows (D-111).
published.offer_timer.enabledbooleanrequired
Default false
published.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
published.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
published.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
published.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
published.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
published.support_emailstring or nullrequired
Default null
published.support_phonestring or nullrequired
Default null
published.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
published.policiesobjectrequired
This page's own policies; empty ones use the store policy.
published.policies.termsstringrequired
Up to 20000 characters
published.policies.refundstringrequired
Up to 20000 characters
published.policies.privacystringrequired
Up to 20000 characters
published.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
published.seo_titlestringrequired
Up to 70 characters
published.seo_descriptionstringrequired
Up to 320 characters
published.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
published.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
published.blocks[].enabledbooleanrequired
has_unpublished_changesbooleanrequired
published_attimestamp or nullrequired
salesobjectrequired
sales.ordersintegerrequired
sales.totalintegerrequired
created_attimestamprequired
updated_attimestamprequired

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
409	`conflict`	The request conflicts with the current state of the object.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X PATCH https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R \
  -H "Authorization: Bearer pat_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "festive-saree",
  "draft": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton."
  }
}'

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R', {
  method: 'PATCH',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "slug": "festive-saree",
    "draft": {
      "template": "single_product",
      "title": "Festive saree",
      "description": "Hand block printed cotton."
    }
  }),
});
const data = await res.json();

Response 200

{
  "id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "slug": "festive-saree",
  "status": "draft",
  "draft": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "published": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "has_unpublished_changes": false,
  "published_at": "2026-11-04T10:00:00.000Z",
  "sales": {
    "orders": 1,
    "total": 49900
  },
  "created_at": "2026-11-04T10:00:00.000Z",
  "updated_at": "2026-11-04T10:00:00.000Z"
}

A page's A/B tests, newest first, with results

GET/admin/2026-11/pages/{id}/experiments

scope read_pages

Path parameters

idID (pag_...)required

Response 200

dataarray of objectrequired
data[].idID (exp_...)required
data[].page_idID (pag_...)required
data[].namestringrequired
data[].statusenumrequired
One of running ended
data[].changesobjectrequired
data[].changes.titlestring
At least 1 characters · Up to 120 characters
data[].changes.button_labelstring
At least 1 characters · Up to 40 characters
data[].changes.styleenum
One of spotlight modern elegant bold noir sunrise minimal glass
data[].changes.accentenum
One of indigo blue teal green orange rose charcoal
data[].changes.cover_file_idID (fil_...) or null
data[].changes.descriptionstring
The short pitch under the title.
Up to 300 characters
data[].changes.description_htmlstring
The long, formatted description (rich text, sanitised like the page description).
Up to 100000 characters
data[].changes.badgestring
The small label above the title.
Up to 40 characters
data[].changes.hero_layoutenum
One of split banner stacked
data[].changes.hidden_sectionsarray of string
Section ids hidden in B.
Up to 30 items
data[].changes.offer_timerboolean
Turn the offer timer on (true) or off (false) in B.
data[].splitintegerrequired
Percent of visitors who see variant B.
data[].goalenumrequired
One of purchase checkout_start revenue
data[].min_visitorsintegerrequired
data[].ends_atstring or nullrequired
data[].auto_stopbooleanrequired
data[].ended_reasonenum or nullrequired
One of seller winner_found end_date
data[].winnerenum or nullrequired
One of a b
data[].started_atstringrequired
data[].ended_atstring or nullrequired
data[].resultsobject or nullrequired
Null when analytics is not configured.
data[].results.aobjectrequired
data[].results.a.visitorsintegerrequired
data[].results.a.buy_clicksintegerrequired
Visitors who started buying (pressed the buy button).
data[].results.a.purchasesintegerrequired
Visitors who paid.
data[].results.a.revenueintegerrequired
data[].results.a.conversionnumberrequired
purchases / visitors, 0 to 1.
data[].results.a.checkout_ratenumberrequired
buy_clicks / visitors, 0 to 1.
data[].results.a.revenue_per_visitorintegerrequired
Paise per visitor.
data[].results.a.goal_ratenumberrequired
The rate of the test goal, 0 to 1.
data[].results.bobjectrequired
data[].results.b.visitorsintegerrequired
data[].results.b.buy_clicksintegerrequired
Visitors who started buying (pressed the buy button).
data[].results.b.purchasesintegerrequired
Visitors who paid.
data[].results.b.revenueintegerrequired
data[].results.b.conversionnumberrequired
purchases / visitors, 0 to 1.
data[].results.b.checkout_ratenumberrequired
buy_clicks / visitors, 0 to 1.
data[].results.b.revenue_per_visitorintegerrequired
Paise per visitor.
data[].results.b.goal_ratenumberrequired
The rate of the test goal, 0 to 1.
data[].results.liftnumber or nullrequired
Relative change of B over A in conversion; null without data.
data[].results.chance_b_betternumber or nullrequired
Probability (0 to 1) that B converts better than A.
data[].results.verdictenumrequired
One of collecting a_leads b_leads a_wins b_wins no_difference

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/experiments \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/experiments', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "exp_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "page_id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "name": "Festive saree",
      "status": "running",
      "changes": {
        "title": "Festive saree",
        "button_label": "string",
        "style": "spotlight",
        "accent": "indigo",
        "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
        "description": "Hand block printed cotton.",
        "description_html": "<p>Hand block printed cotton.</p>",
        "badge": "string",
        "hero_layout": "split",
        "hidden_sections": [
          "string"
        ],
        "offer_timer": false
      },
      "split": 1,
      "goal": "purchase",
      "min_visitors": 1,
      "ends_at": "string",
      "auto_stop": false,
      "ended_reason": "seller",
      "winner": "a",
      "started_at": "string",
      "ended_at": "string",
      "results": {
        "a": {
          "visitors": 1,
          "buy_clicks": 1,
          "purchases": 1,
          "revenue": 49900,
          "conversion": 1,
          "checkout_rate": 1,
          "revenue_per_visitor": 49900,
          "goal_rate": 1
        },
        "b": {
          "visitors": 1,
          "buy_clicks": 1,
          "purchases": 1,
          "revenue": 49900,
          "conversion": 1,
          "checkout_rate": 1,
          "revenue_per_visitor": 49900,
          "goal_rate": 1
        },
        "lift": 1,
        "chance_b_better": 1,
        "verdict": "collecting"
      }
    }
  ]
}

Start an A/B test on a published page

POST/admin/2026-11/pages/{id}/experiments

scope write_pagesIdempotency-Key required

Path parameters

idID (pag_...)required

Headers

Idempotency-Keystringrequired
Unique key for this request. Retries with the same key return the first response.
At least 1 characters · Up to 255 characters
X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Request body

namestringrequired
At least 1 characters · Up to 80 characters
changesobjectrequired
changes.titlestring
At least 1 characters · Up to 120 characters
changes.button_labelstring
At least 1 characters · Up to 40 characters
changes.styleenum
One of spotlight modern elegant bold noir sunrise minimal glass
changes.accentenum
One of indigo blue teal green orange rose charcoal
changes.cover_file_idID (fil_...) or null
changes.descriptionstring
The short pitch under the title.
Up to 300 characters
changes.description_htmlstring
The long, formatted description (rich text, sanitised like the page description).
Up to 100000 characters
changes.badgestring
The small label above the title.
Up to 40 characters
changes.hero_layoutenum
One of split banner stacked
changes.hidden_sectionsarray of string
Section ids hidden in B.
Up to 30 items
changes.offer_timerboolean
Turn the offer timer on (true) or off (false) in B.
splitinteger
Default 50 · 10 to 90
goalenum
What decides the winner: purchases, starting checkout, or revenue per visitor.
One of purchase checkout_start revenue
Default "purchase"
min_visitorsinteger
Per variant, before a winner is called.
Default 100 · 50 to 100000
ends_attimestamp or null
Stop the test at this time.
Default null
auto_stopboolean
End the test by itself when a winner is clear, applying B if it wins.
Default false

Response 201

idID (exp_...)required
page_idID (pag_...)required
namestringrequired
statusenumrequired
One of running ended
changesobjectrequired
changes.titlestring
At least 1 characters · Up to 120 characters
changes.button_labelstring
At least 1 characters · Up to 40 characters
changes.styleenum
One of spotlight modern elegant bold noir sunrise minimal glass
changes.accentenum
One of indigo blue teal green orange rose charcoal
changes.cover_file_idID (fil_...) or null
changes.descriptionstring
The short pitch under the title.
Up to 300 characters
changes.description_htmlstring
The long, formatted description (rich text, sanitised like the page description).
Up to 100000 characters
changes.badgestring
The small label above the title.
Up to 40 characters
changes.hero_layoutenum
One of split banner stacked
changes.hidden_sectionsarray of string
Section ids hidden in B.
Up to 30 items
changes.offer_timerboolean
Turn the offer timer on (true) or off (false) in B.
splitintegerrequired
Percent of visitors who see variant B.
goalenumrequired
One of purchase checkout_start revenue
min_visitorsintegerrequired
ends_atstring or nullrequired
auto_stopbooleanrequired
ended_reasonenum or nullrequired
One of seller winner_found end_date
winnerenum or nullrequired
One of a b
started_atstringrequired
ended_atstring or nullrequired
resultsobject or nullrequired
Null when analytics is not configured.
results.aobjectrequired
results.a.visitorsintegerrequired
results.a.buy_clicksintegerrequired
Visitors who started buying (pressed the buy button).
results.a.purchasesintegerrequired
Visitors who paid.
results.a.revenueintegerrequired
results.a.conversionnumberrequired
purchases / visitors, 0 to 1.
results.a.checkout_ratenumberrequired
buy_clicks / visitors, 0 to 1.
results.a.revenue_per_visitorintegerrequired
Paise per visitor.
results.a.goal_ratenumberrequired
The rate of the test goal, 0 to 1.
results.bobjectrequired
results.b.visitorsintegerrequired
results.b.buy_clicksintegerrequired
Visitors who started buying (pressed the buy button).
results.b.purchasesintegerrequired
Visitors who paid.
results.b.revenueintegerrequired
results.b.conversionnumberrequired
purchases / visitors, 0 to 1.
results.b.checkout_ratenumberrequired
buy_clicks / visitors, 0 to 1.
results.b.revenue_per_visitorintegerrequired
Paise per visitor.
results.b.goal_ratenumberrequired
The rate of the test goal, 0 to 1.
results.liftnumber or nullrequired
Relative change of B over A in conversion; null without data.
results.chance_b_betternumber or nullrequired
Probability (0 to 1) that B converts better than A.
results.verdictenumrequired
One of collecting a_leads b_leads a_wins b_wins no_difference

Errors

400	`idempotency_key_required`	Every POST needs an Idempotency-Key header.
400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
409	`conflict`	The request conflicts with the current state of the object.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
422	`idempotency_key_reused`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X POST https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/experiments \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Festive saree",
  "changes": {
    "title": "Festive saree",
    "button_label": "string",
    "style": "spotlight"
  }
}'

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/experiments', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Festive saree",
    "changes": {
      "title": "Festive saree",
      "button_label": "string",
      "style": "spotlight"
    }
  }),
});
const data = await res.json();

Response 201

{
  "id": "exp_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "page_id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "name": "Festive saree",
  "status": "running",
  "changes": {
    "title": "Festive saree",
    "button_label": "string",
    "style": "spotlight",
    "accent": "indigo",
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "description": "Hand block printed cotton.",
    "description_html": "<p>Hand block printed cotton.</p>",
    "badge": "string",
    "hero_layout": "split",
    "hidden_sections": [
      "string"
    ],
    "offer_timer": false
  },
  "split": 1,
  "goal": "purchase",
  "min_visitors": 1,
  "ends_at": "string",
  "auto_stop": false,
  "ended_reason": "seller",
  "winner": "a",
  "started_at": "string",
  "ended_at": "string",
  "results": {
    "a": {
      "visitors": 1,
      "buy_clicks": 1,
      "purchases": 1,
      "revenue": 49900,
      "conversion": 1,
      "checkout_rate": 1,
      "revenue_per_visitor": 49900,
      "goal_rate": 1
    },
    "b": {
      "visitors": 1,
      "buy_clicks": 1,
      "purchases": 1,
      "revenue": 49900,
      "conversion": 1,
      "checkout_rate": 1,
      "revenue_per_visitor": 49900,
      "goal_rate": 1
    },
    "lift": 1,
    "chance_b_better": 1,
    "verdict": "collecting"
  }
}

Stop an A/B test; choosing B applies its changes to the page and publishes it

POST/admin/2026-11/pages/{id}/experiments/{experiment_id}/end

scope write_pagesIdempotency-Key required

Path parameters

idID (pag_...)required
experiment_idID (exp_...)required

Headers

Idempotency-Keystringrequired
Unique key for this request. Retries with the same key return the first response.
At least 1 characters · Up to 255 characters
X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Request body

winnerenum or nullrequired
One of a b

Response 200

idID (exp_...)required
page_idID (pag_...)required
namestringrequired
statusenumrequired
One of running ended
changesobjectrequired
changes.titlestring
At least 1 characters · Up to 120 characters
changes.button_labelstring
At least 1 characters · Up to 40 characters
changes.styleenum
One of spotlight modern elegant bold noir sunrise minimal glass
changes.accentenum
One of indigo blue teal green orange rose charcoal
changes.cover_file_idID (fil_...) or null
changes.descriptionstring
The short pitch under the title.
Up to 300 characters
changes.description_htmlstring
The long, formatted description (rich text, sanitised like the page description).
Up to 100000 characters
changes.badgestring
The small label above the title.
Up to 40 characters
changes.hero_layoutenum
One of split banner stacked
changes.hidden_sectionsarray of string
Section ids hidden in B.
Up to 30 items
changes.offer_timerboolean
Turn the offer timer on (true) or off (false) in B.
splitintegerrequired
Percent of visitors who see variant B.
goalenumrequired
One of purchase checkout_start revenue
min_visitorsintegerrequired
ends_atstring or nullrequired
auto_stopbooleanrequired
ended_reasonenum or nullrequired
One of seller winner_found end_date
winnerenum or nullrequired
One of a b
started_atstringrequired
ended_atstring or nullrequired
resultsobject or nullrequired
Null when analytics is not configured.
results.aobjectrequired
results.a.visitorsintegerrequired
results.a.buy_clicksintegerrequired
Visitors who started buying (pressed the buy button).
results.a.purchasesintegerrequired
Visitors who paid.
results.a.revenueintegerrequired
results.a.conversionnumberrequired
purchases / visitors, 0 to 1.
results.a.checkout_ratenumberrequired
buy_clicks / visitors, 0 to 1.
results.a.revenue_per_visitorintegerrequired
Paise per visitor.
results.a.goal_ratenumberrequired
The rate of the test goal, 0 to 1.
results.bobjectrequired
results.b.visitorsintegerrequired
results.b.buy_clicksintegerrequired
Visitors who started buying (pressed the buy button).
results.b.purchasesintegerrequired
Visitors who paid.
results.b.revenueintegerrequired
results.b.conversionnumberrequired
purchases / visitors, 0 to 1.
results.b.checkout_ratenumberrequired
buy_clicks / visitors, 0 to 1.
results.b.revenue_per_visitorintegerrequired
Paise per visitor.
results.b.goal_ratenumberrequired
The rate of the test goal, 0 to 1.
results.liftnumber or nullrequired
Relative change of B over A in conversion; null without data.
results.chance_b_betternumber or nullrequired
Probability (0 to 1) that B converts better than A.
results.verdictenumrequired
One of collecting a_leads b_leads a_wins b_wins no_difference

Errors

400	`idempotency_key_required`	Every POST needs an Idempotency-Key header.
400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
409	`conflict`	The request conflicts with the current state of the object.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
422	`idempotency_key_reused`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X POST https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/experiments/exp_01JCG8ZQ5S7T0V4X8K2M3N6P9R/end \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "winner": "a"
}'

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/experiments/exp_01JCG8ZQ5S7T0V4X8K2M3N6P9R/end', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "winner": "a"
  }),
});
const data = await res.json();

Response 200

{
  "id": "exp_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "page_id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "name": "Festive saree",
  "status": "running",
  "changes": {
    "title": "Festive saree",
    "button_label": "string",
    "style": "spotlight",
    "accent": "indigo",
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "description": "Hand block printed cotton.",
    "description_html": "<p>Hand block printed cotton.</p>",
    "badge": "string",
    "hero_layout": "split",
    "hidden_sections": [
      "string"
    ],
    "offer_timer": false
  },
  "split": 1,
  "goal": "purchase",
  "min_visitors": 1,
  "ends_at": "string",
  "auto_stop": false,
  "ended_reason": "seller",
  "winner": "a",
  "started_at": "string",
  "ended_at": "string",
  "results": {
    "a": {
      "visitors": 1,
      "buy_clicks": 1,
      "purchases": 1,
      "revenue": 49900,
      "conversion": 1,
      "checkout_rate": 1,
      "revenue_per_visitor": 49900,
      "goal_rate": 1
    },
    "b": {
      "visitors": 1,
      "buy_clicks": 1,
      "purchases": 1,
      "revenue": 49900,
      "conversion": 1,
      "checkout_rate": 1,
      "revenue_per_visitor": 49900,
      "goal_rate": 1
    },
    "lift": 1,
    "chance_b_better": 1,
    "verdict": "collecting"
  }
}

Make the draft live

POST/admin/2026-11/pages/{id}/publish

scope write_pagesIdempotency-Key required

Path parameters

idID (pag_...)required

Headers

Idempotency-Keystringrequired
Unique key for this request. Retries with the same key return the first response.
At least 1 characters · Up to 255 characters
X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Response 200

idID (pag_...)required
slugstringrequired
statusenumrequired
One of draft published unpublished
draftobjectrequired
draft.templateenumrequired
One of single_product digital_download course booking community donation
draft.titlestringrequired
At least 1 characters · Up to 120 characters
draft.descriptionstringrequired
Up to 5000 characters
draft.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
draft.product_idID (prd_...) or nullrequired
draft.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
draft.bump_textstringrequired
Up to 200 characters
draft.button_labelstringrequired
At least 1 characters · Up to 40 characters
draft.faqarray of objectrequired
Up to 10 items
draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
draft.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
draft.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
draft.pay_what_you_want.enabledbooleanrequired
draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
draft.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
draft.questions[].idstringrequired
draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
draft.questions[].requiredbooleanrequired
draft.sales_limitinteger or nullrequired
Default null
draft.ends_attimestamp or nullrequired
Default null
draft.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
draft.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
draft.allow_couponsbooleanrequired
Default true
draft.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
draft.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
draft.highlightsarray of stringrequired
Up to 12 items
draft.reviewsarray of objectrequired
Up to 10 items
draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
draft.reviews[].ratingintegerrequired
1 to 5
draft.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
draft.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
draft.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
draft.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
draft.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
draft.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
draft.offer_timerobjectrequired
An offer timer and where it shows (D-111).
draft.offer_timer.enabledbooleanrequired
Default false
draft.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
draft.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
draft.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
draft.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
draft.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
draft.support_emailstring or nullrequired
Default null
draft.support_phonestring or nullrequired
Default null
draft.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
draft.policiesobjectrequired
This page's own policies; empty ones use the store policy.
draft.policies.termsstringrequired
Up to 20000 characters
draft.policies.refundstringrequired
Up to 20000 characters
draft.policies.privacystringrequired
Up to 20000 characters
draft.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
draft.seo_titlestringrequired
Up to 70 characters
draft.seo_descriptionstringrequired
Up to 320 characters
draft.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
draft.blocks[].enabledbooleanrequired
publishedobject or nullrequired
published.templateenumrequired
One of single_product digital_download course booking community donation
published.titlestringrequired
At least 1 characters · Up to 120 characters
published.descriptionstringrequired
Up to 5000 characters
published.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
published.product_idID (prd_...) or nullrequired
published.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
published.bump_textstringrequired
Up to 200 characters
published.button_labelstringrequired
At least 1 characters · Up to 40 characters
published.faqarray of objectrequired
Up to 10 items
published.faq[].qstringrequired
At least 1 characters · Up to 200 characters
published.faq[].astringrequired
At least 1 characters · Up to 1000 characters
published.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
published.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
published.pay_what_you_want.enabledbooleanrequired
published.pay_what_you_want.min_amountintegerrequired
100 to 10000000
published.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
published.questions[].idstringrequired
published.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
published.questions[].requiredbooleanrequired
published.sales_limitinteger or nullrequired
Default null
published.ends_attimestamp or nullrequired
Default null
published.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
published.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
published.allow_couponsbooleanrequired
Default true
published.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
published.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
published.highlightsarray of stringrequired
Up to 12 items
published.reviewsarray of objectrequired
Up to 10 items
published.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
published.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
published.reviews[].ratingintegerrequired
1 to 5
published.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
published.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
published.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
published.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
published.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
published.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
published.offer_timerobjectrequired
An offer timer and where it shows (D-111).
published.offer_timer.enabledbooleanrequired
Default false
published.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
published.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
published.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
published.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
published.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
published.support_emailstring or nullrequired
Default null
published.support_phonestring or nullrequired
Default null
published.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
published.policiesobjectrequired
This page's own policies; empty ones use the store policy.
published.policies.termsstringrequired
Up to 20000 characters
published.policies.refundstringrequired
Up to 20000 characters
published.policies.privacystringrequired
Up to 20000 characters
published.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
published.seo_titlestringrequired
Up to 70 characters
published.seo_descriptionstringrequired
Up to 320 characters
published.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
published.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
published.blocks[].enabledbooleanrequired
has_unpublished_changesbooleanrequired
published_attimestamp or nullrequired
salesobjectrequired
sales.ordersintegerrequired
sales.totalintegerrequired
created_attimestamprequired
updated_attimestamprequired

Errors

400	`idempotency_key_required`	Every POST needs an Idempotency-Key header.
400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
422	`idempotency_key_reused`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X POST https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/publish \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)"

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/publish', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
const data = await res.json();

Response 200

{
  "id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "slug": "festive-saree",
  "status": "draft",
  "draft": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "published": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "has_unpublished_changes": false,
  "published_at": "2026-11-04T10:00:00.000Z",
  "sales": {
    "orders": 1,
    "total": 49900
  },
  "created_at": "2026-11-04T10:00:00.000Z",
  "updated_at": "2026-11-04T10:00:00.000Z"
}

Take the page offline

POST/admin/2026-11/pages/{id}/unpublish

scope write_pagesIdempotency-Key required

Path parameters

idID (pag_...)required

Headers

Idempotency-Keystringrequired
Unique key for this request. Retries with the same key return the first response.
At least 1 characters · Up to 255 characters
X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Response 200

idID (pag_...)required
slugstringrequired
statusenumrequired
One of draft published unpublished
draftobjectrequired
draft.templateenumrequired
One of single_product digital_download course booking community donation
draft.titlestringrequired
At least 1 characters · Up to 120 characters
draft.descriptionstringrequired
Up to 5000 characters
draft.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
draft.product_idID (prd_...) or nullrequired
draft.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
draft.bump_textstringrequired
Up to 200 characters
draft.button_labelstringrequired
At least 1 characters · Up to 40 characters
draft.faqarray of objectrequired
Up to 10 items
draft.faq[].qstringrequired
At least 1 characters · Up to 200 characters
draft.faq[].astringrequired
At least 1 characters · Up to 1000 characters
draft.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
draft.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
draft.pay_what_you_want.enabledbooleanrequired
draft.pay_what_you_want.min_amountintegerrequired
100 to 10000000
draft.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
draft.questions[].idstringrequired
draft.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
draft.questions[].requiredbooleanrequired
draft.sales_limitinteger or nullrequired
Default null
draft.ends_attimestamp or nullrequired
Default null
draft.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
draft.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
draft.allow_couponsbooleanrequired
Default true
draft.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
draft.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
draft.highlightsarray of stringrequired
Up to 12 items
draft.reviewsarray of objectrequired
Up to 10 items
draft.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
draft.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
draft.reviews[].ratingintegerrequired
1 to 5
draft.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
draft.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
draft.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
draft.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
draft.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
draft.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
draft.offer_timerobjectrequired
An offer timer and where it shows (D-111).
draft.offer_timer.enabledbooleanrequired
Default false
draft.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
draft.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
draft.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
draft.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
draft.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
draft.support_emailstring or nullrequired
Default null
draft.support_phonestring or nullrequired
Default null
draft.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
draft.policiesobjectrequired
This page's own policies; empty ones use the store policy.
draft.policies.termsstringrequired
Up to 20000 characters
draft.policies.refundstringrequired
Up to 20000 characters
draft.policies.privacystringrequired
Up to 20000 characters
draft.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
draft.seo_titlestringrequired
Up to 70 characters
draft.seo_descriptionstringrequired
Up to 320 characters
draft.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
draft.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
draft.blocks[].enabledbooleanrequired
publishedobject or nullrequired
published.templateenumrequired
One of single_product digital_download course booking community donation
published.titlestringrequired
At least 1 characters · Up to 120 characters
published.descriptionstringrequired
Up to 5000 characters
published.description_htmlstringrequired
The full description with formatting, shown under the cover (cleaned of scripts).
Up to 100000 characters
published.product_idID (prd_...) or nullrequired
published.bump_product_idID (prd_...) or nullrequired
An optional add-on offered with a checkbox (order bump).
published.bump_textstringrequired
Up to 200 characters
published.button_labelstringrequired
At least 1 characters · Up to 40 characters
published.faqarray of objectrequired
Up to 10 items
published.faq[].qstringrequired
At least 1 characters · Up to 200 characters
published.faq[].astringrequired
At least 1 characters · Up to 1000 characters
published.cover_file_idID (fil_...) or nullrequired
An uploaded image shown at the top of the page.
Default null
published.pay_what_you_wantobject or nullrequired
Buyers choose the price, at least min_amount (paise).
Default null
published.pay_what_you_want.enabledbooleanrequired
published.pay_what_you_want.min_amountintegerrequired
100 to 10000000
published.questionsarray of objectrequired
Asked on the page; the answers go on the order.
Up to 5 items
published.questions[].idstringrequired
published.questions[].labelstringrequired
At least 1 characters · Up to 120 characters
published.questions[].requiredbooleanrequired
published.sales_limitinteger or nullrequired
Default null
published.ends_attimestamp or nullrequired
Default null
published.delivery_urlstring or nullrequired
A link the buyer gets after paying (a course, a group, a meeting).
Default null
published.thank_you_urlstring or nullrequired
Where to send the buyer after the thank-you page.
Default null
published.allow_couponsbooleanrequired
Default true
published.badgestringrequired
A short line above the title, such as Live on 16 November.
Up to 60 characters
published.highlights_titlestringrequired
Default "What you get" · Up to 80 characters
published.highlightsarray of stringrequired
Up to 12 items
published.reviewsarray of objectrequired
Up to 10 items
published.reviews[].namestringrequired
At least 1 characters · Up to 60 characters
published.reviews[].textstringrequired
At least 1 characters · Up to 500 characters
published.reviews[].ratingintegerrequired
1 to 5
published.accentenumrequired
One of indigo blue teal green orange rose charcoal
Default "indigo"
published.styleenumrequired
Type and colour style of the page.
One of spotlight modern elegant bold noir sunrise minimal glass
Default "modern"
published.video_urlstring or nullrequired
A YouTube video shown under the cover.
Default null
published.show_sales_countbooleanrequired
Show how many people bought, once there are 10 or more.
Default false
published.show_countdownbooleanrequired
Count down to the end date when there is one.
Default true
published.product_pagebooleanrequired
Use this page as the product's page in the online store: /products/<handle> shows this page, with its A/B test and analytics (D-119).
Default false
published.offer_timerobjectrequired
An offer timer and where it shows (D-111).
published.offer_timer.enabledbooleanrequired
Default false
published.offer_timer.modeenumrequired
end_date counts to ends_at; evergreen gives each visitor the same minutes from their first visit.
One of end_date evergreen
Default "end_date"
published.offer_timer.minutesintegerrequired
Default 30 · 5 to 10080
published.offer_timer.labelstringrequired
Default "Offer ends in" · Up to 80 characters
published.offer_timer.placesarray of enumrequired
One of top_bar hero buy_box sticky_bar
Default ["top_bar","buy_box"] · Up to 4 items
published.offer_timer.styleenumrequired
One of boxes inline
Default "boxes"
published.support_emailstring or nullrequired
Default null
published.support_phonestring or nullrequired
Default null
published.thank_you_messagestringrequired
Shown to the buyer after paying.
Up to 500 characters
published.policiesobjectrequired
This page's own policies; empty ones use the store policy.
published.policies.termsstringrequired
Up to 20000 characters
published.policies.refundstringrequired
Up to 20000 characters
published.policies.privacystringrequired
Up to 20000 characters
published.sectionsarray of objectrequired
The page, section by section (D-94). Empty for pages made before sections; the API fills them.
Up to 40 items
published.seo_titlestringrequired
Up to 70 characters
published.seo_descriptionstringrequired
Up to 320 characters
published.blocksarray of objectrequired
Page sections in order; the order bump shows inside the price section.
Default [{"type":"hero","enabled":true},{"type":"highlights","enabled":true},{"type":"price","enabled":true},{"type":"bump","enabled":true},{"type":"reviews","enabled":true},{"type":"faq","enabled":true}] · Up to 6 items
published.blocks[].typeenumrequired
One of hero highlights price bump reviews faq
published.blocks[].enabledbooleanrequired
has_unpublished_changesbooleanrequired
published_attimestamp or nullrequired
salesobjectrequired
sales.ordersintegerrequired
sales.totalintegerrequired
created_attimestamprequired
updated_attimestamprequired

Errors

400	`idempotency_key_required`	Every POST needs an Idempotency-Key header.
400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
404	`resource_not_found`	The object does not exist or belongs to another store.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
422	`idempotency_key_reused`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X POST https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/unpublish \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)"

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R/unpublish', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Idempotency-Key': crypto.randomUUID(),
  },
});
const data = await res.json();

Response 200

{
  "id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "slug": "festive-saree",
  "status": "draft",
  "draft": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "published": {
    "template": "single_product",
    "title": "Festive saree",
    "description": "Hand block printed cotton.",
    "description_html": "",
    "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "bump_text": "Hand block printed cotton.",
    "button_label": "string",
    "faq": [
      {
        "q": "string",
        "a": "string"
      }
    ],
    "cover_file_id": "fil_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
    "pay_what_you_want": {
      "enabled": false,
      "min_amount": 49900
    },
    "questions": [
      {
        "id": "string",
        "label": "string",
        "required": false
      }
    ],
    "sales_limit": 1,
    "ends_at": "2026-11-04T10:00:00.000Z",
    "delivery_url": "https://example.com",
    "thank_you_url": "https://example.com",
    "allow_coupons": true,
    "badge": "",
    "highlights_title": "What you get",
    "highlights": [
      "string"
    ],
    "reviews": [
      {
        "name": "Festive saree",
        "text": "Hand block printed cotton.",
        "rating": 1
      }
    ],
    "accent": "indigo",
    "style": "spotlight",
    "video_url": "https://example.com",
    "show_sales_count": false,
    "show_countdown": true,
    "product_page": false,
    "offer_timer": {
      "enabled": false,
      "mode": "end_date",
      "minutes": 30,
      "label": "Offer ends in",
      "places": [
        "top_bar"
      ],
      "style": "boxes"
    },
    "support_email": "buyer@example.com",
    "support_phone": "+919876543210",
    "thank_you_message": "",
    "policies": {
      "terms": "",
      "refund": "",
      "privacy": ""
    },
    "sections": [
      {
        "id": "string",
        "hidden": false,
        "style": {
          "padding": "none",
          "width": "narrow",
          "text": "small",
          "align": "left"
        },
        "type": "hero",
        "settings": {
          "layout": "stacked",
          "badge": "",
          "show_cover": true,
          "show_video": true
        }
      }
    ],
    "seo_title": "",
    "seo_description": "",
    "blocks": [
      {
        "type": "hero",
        "enabled": false
      }
    ]
  },
  "has_unpublished_changes": false,
  "published_at": "2026-11-04T10:00:00.000Z",
  "sales": {
    "orders": 1,
    "total": 49900
  },
  "created_at": "2026-11-04T10:00:00.000Z",
  "updated_at": "2026-11-04T10:00:00.000Z"
}

Visitors, checkout starts, orders, revenue and conversion for every page over a period

GET/admin/2026-11/pages/stats

scope read_pages

Query parameters

periodenum
One of 7d 30d 90d all
Default "30d"

Response 200

periodenumrequired
One of 7d 30d 90d all
dataarray of objectrequired
data[].page_idID (pag_...)required
data[].visitorsinteger or nullrequired
Null when the analytics store is not connected.
data[].checkout_startsinteger or nullrequired
data[].ordersintegerrequired
data[].revenueintegerrequired
Paid orders from the page, in paise.
data[].conversionnumber or nullrequired
Orders divided by visitors.
data[].revenue_per_visitorinteger or nullrequired

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/pages/stats \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/pages/stats', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "period": "7d",
  "data": [
    {
      "page_id": "pag_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "visitors": 1,
      "checkout_starts": 1,
      "orders": 1,
      "revenue": 49900,
      "conversion": 1,
      "revenue_per_visitor": 49900
    }
  ]
}

Privacy, terms, refund and shipping policies

GET/admin/2026-11/policies

scope read_pages

Response 200

dataarray of objectrequired
data[].kindenumrequired
One of privacy terms refund shipping
data[].titlestringrequired
data[].bodystringrequired
Plain text; blank lines separate paragraphs.
data[].is_templatebooleanrequired
True until the seller saves their own text.
data[].updated_attimestamp or nullrequired

Errors

401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/policies \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/policies', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "data": [
    {
      "kind": "privacy",
      "title": "Festive saree",
      "body": "string",
      "is_template": false,
      "updated_at": "2026-11-04T10:00:00.000Z"
    }
  ]
}

Save the store text of a policy (an empty body goes back to the template)

PUT/admin/2026-11/policies/{kind}

scope write_pages

Path parameters

kindenumrequired
One of privacy terms refund shipping

Headers

X-CSRF-Tokenstring
Required with a seller session cookie: the value of the orb_csrf cookie.

Request body

bodystringrequired
Up to 20000 characters

Response 200

kindenumrequired
One of privacy terms refund shipping
titlestringrequired
bodystringrequired
Plain text; blank lines separate paragraphs.
is_templatebooleanrequired
True until the seller saves their own text.
updated_attimestamp or nullrequired

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl -X PUT https://api.storelyne.com/admin/2026-11/policies/privacy \
  -H "Authorization: Bearer pat_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "body": "string"
}'

const res = await fetch('https://api.storelyne.com/admin/2026-11/policies/privacy', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "body": "string"
  }),
});
const data = await res.json();

Response 200

{
  "kind": "privacy",
  "title": "Festive saree",
  "body": "string",
  "is_template": false,
  "updated_at": "2026-11-04T10:00:00.000Z"
}