Admin API

Checkout

Checkout attempts, payment methods and what happened in each attempt.

GETShipping rate and the store state used for GST
PATCHSet the flat shipping rate, the free shipping threshold and the store state
GETCheckouts left without an order after 60 minutes, newest first

Shipping rate and the store state used for GST

GET/admin/2026-11/checkout/settings

scope read_store

Response 200

flat_shippingintegerrequired
free_shipping_overinteger or nullrequired
store_statestring or nullrequired
gst_registeredbooleanrequired
False: the store charges no GST (D-101).
gstinstring 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/checkout/settings \
  -H "Authorization: Bearer pat_live_..."

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

Response 200

{
  "flat_shipping": 1,
  "free_shipping_over": 1,
  "store_state": "string",
  "gst_registered": false,
  "gstin": "string"
}

Set the flat shipping rate, the free shipping threshold and the store state

PATCH/admin/2026-11/checkout/settings

scope write_store

Headers

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

Request body

flat_shippinginteger
0 to 10000000
free_shipping_overinteger or null
store_statestring or null
gst_registeredboolean
gstinstring or null

Response 200

flat_shippingintegerrequired
free_shipping_overinteger or nullrequired
store_statestring or nullrequired
gst_registeredbooleanrequired
False: the store charges no GST (D-101).
gstinstring 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 PATCH https://api.storelyne.com/admin/2026-11/checkout/settings \
  -H "Authorization: Bearer pat_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "flat_shipping": 1,
  "free_shipping_over": 1,
  "store_state": "string"
}'

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

Response 200

{
  "flat_shipping": 1,
  "free_shipping_over": 1,
  "store_state": "string",
  "gst_registered": false,
  "gstin": "string"
}

Checkouts left without an order after 60 minutes, newest first

GET/admin/2026-11/checkouts/abandoned

scope read_checkouts

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

Response 200

dataarray of objectrequired
data[].idID (chk_...)required
data[].buyerobjectrequired
data[].buyer.namestringrequired
data[].buyer.emailstring or nullrequired
data[].buyer.phonestring or nullrequired
data[].totalintegerrequired
data[].itemsintegerrequired
data[].recoveredbooleanrequired
The same cart was checked out again and the order placed.
data[].abandoned_attimestamprequired
data[].created_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/checkouts/abandoned \
  -H "Authorization: Bearer pat_live_..."

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

Response 200

{
  "data": [
    {
      "id": "chk_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "buyer": {
        "name": "Festive saree",
        "email": "buyer@example.com",
        "phone": "+919876543210"
      },
      "total": 49900,
      "items": 1,
      "recovered": false,
      "abandoned_at": "2026-11-04T10:00:00.000Z",
      "created_at": "2026-11-04T10:00:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": "eyJpZCI6Ii4uLiJ9"
}