Admin API

Domains

Custom domains and their certificates.

GETDomains connected to this store
POSTConnect a domain; the answer says which DNS record to add
DELDisconnect a domain
POSTCheck the DNS and certificate now

Domains connected to this store

GET/admin/2026-11/domains

scope read_domains

Response 200

dataarray of objectrequired
data[].idID (dom_...)required
data[].hostnamestringrequired
data[].purposeenumrequired
One of store pages
data[].statusenumrequired
One of pending_dns issuing_ssl live failed
data[].kindenumrequired
apex: a bare domain like yourstore.in, which needs an A record (no CNAME allowed).
One of subdomain apex
data[].registrable_domainstringrequired
The domain as bought at the registrar, like yourstore.in.
data[].dns_recordobjectrequired
The record to add at the domain provider (name is the full hostname).
data[].dns_record.typeenumrequired
One of CNAME A
data[].dns_record.namestringrequired
data[].dns_record.valuestringrequired
data[].dns_recordsarray of objectrequired
Every record to add, as the DNS provider asks for it.
data[].dns_records[].typeenumrequired
One of CNAME A
data[].dns_records[].hoststringrequired
The record name as most providers ask for it: @ or the subdomain.
data[].dns_records[].valuestringrequired
data[].dns_records[].ttlintegerrequired
data[].checksobject or nullrequired
What the last check found.
data[].checks.dnsobjectrequired
data[].checks.dns.okbooleanrequired
data[].checks.dns.foundarray of objectrequired
data[].checks.dns.found[].typeenumrequired
One of CNAME A AAAA
data[].checks.dns.found[].valuestringrequired
data[].checks.dns.problemstring or nullrequired
What is wrong and the fix, when not ok.
data[].checks.httpsobject or nullrequired
The certificate check, once DNS is right.
data[].checks.https.okbooleanrequired
data[].checks.https.errorstring or nullrequired
data[].messagestringrequired
What is happening and what to do, in plain words.
data[].last_checked_attimestamp or nullrequired
data[].verified_attimestamp or nullrequired
data[].created_attimestamprequired

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/domains \
  -H "Authorization: Bearer pat_live_..."

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

Response 200

{
  "data": [
    {
      "id": "dom_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "hostname": "string",
      "purpose": "store",
      "status": "pending_dns",
      "kind": "subdomain",
      "registrable_domain": "string",
      "dns_record": {
        "type": "CNAME",
        "name": "Festive saree",
        "value": "string"
      },
      "dns_records": [
        {
          "type": "CNAME",
          "host": "string",
          "value": "string",
          "ttl": 1
        }
      ],
      "checks": {
        "dns": {
          "ok": false,
          "found": [],
          "problem": "string"
        },
        "https": {
          "ok": false,
          "error": "string"
        }
      },
      "message": "Hand block printed cotton.",
      "last_checked_at": "2026-11-04T10:00:00.000Z",
      "verified_at": "2026-11-04T10:00:00.000Z",
      "created_at": "2026-11-04T10:00:00.000Z"
    }
  ]
}

Connect a domain; the answer says which DNS record to add

POST/admin/2026-11/domains

A subdomain (www.yourstore.in) gets a CNAME to the store target; a bare domain (yourstore.in) gets an A record to the server. Checks run every minute for the first hour, then hourly, and daily once live.

scope write_domainsIdempotency-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

hostnamestringrequired
At least 4 characters · Up to 253 characters
purposeenum
One of store pages
Default "store"

Response 201

idID (dom_...)required
hostnamestringrequired
purposeenumrequired
One of store pages
statusenumrequired
One of pending_dns issuing_ssl live failed
kindenumrequired
apex: a bare domain like yourstore.in, which needs an A record (no CNAME allowed).
One of subdomain apex
registrable_domainstringrequired
The domain as bought at the registrar, like yourstore.in.
dns_recordobjectrequired
The record to add at the domain provider (name is the full hostname).
dns_record.typeenumrequired
One of CNAME A
dns_record.namestringrequired
dns_record.valuestringrequired
dns_recordsarray of objectrequired
Every record to add, as the DNS provider asks for it.
dns_records[].typeenumrequired
One of CNAME A
dns_records[].hoststringrequired
The record name as most providers ask for it: @ or the subdomain.
dns_records[].valuestringrequired
dns_records[].ttlintegerrequired
checksobject or nullrequired
What the last check found.
checks.dnsobjectrequired
checks.dns.okbooleanrequired
checks.dns.foundarray of objectrequired
checks.dns.found[].typeenumrequired
One of CNAME A AAAA
checks.dns.found[].valuestringrequired
checks.dns.problemstring or nullrequired
What is wrong and the fix, when not ok.
checks.httpsobject or nullrequired
The certificate check, once DNS is right.
checks.https.okbooleanrequired
checks.https.errorstring or nullrequired
messagestringrequired
What is happening and what to do, in plain words.
last_checked_attimestamp or nullrequired
verified_attimestamp or nullrequired
created_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/domains \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "hostname": "string"
}'

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

Response 201

{
  "id": "dom_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "hostname": "string",
  "purpose": "store",
  "status": "pending_dns",
  "kind": "subdomain",
  "registrable_domain": "string",
  "dns_record": {
    "type": "CNAME",
    "name": "Festive saree",
    "value": "string"
  },
  "dns_records": [
    {
      "type": "CNAME",
      "host": "string",
      "value": "string",
      "ttl": 1
    }
  ],
  "checks": {
    "dns": {
      "ok": false,
      "found": [
        {
          "type": "CNAME",
          "value": "string"
        }
      ],
      "problem": "string"
    },
    "https": {
      "ok": false,
      "error": "string"
    }
  },
  "message": "Hand block printed cotton.",
  "last_checked_at": "2026-11-04T10:00:00.000Z",
  "verified_at": "2026-11-04T10:00:00.000Z",
  "created_at": "2026-11-04T10:00:00.000Z"
}

Disconnect a domain

DEL/admin/2026-11/domains/{id}

scope write_domains

Path parameters

idID (dom_...)required

Headers

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

Response 204

No body.

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 -X DELETE https://api.storelyne.com/admin/2026-11/domains/dom_01JCG8ZQ5S7T0V4X8K2M3N6P9R \
  -H "Authorization: Bearer pat_live_..."

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

Response 204

No body.

Check the DNS and certificate now

POST/admin/2026-11/domains/{id}/check

scope write_domainsIdempotency-Key required

Path parameters

idID (dom_...)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 (dom_...)required
hostnamestringrequired
purposeenumrequired
One of store pages
statusenumrequired
One of pending_dns issuing_ssl live failed
kindenumrequired
apex: a bare domain like yourstore.in, which needs an A record (no CNAME allowed).
One of subdomain apex
registrable_domainstringrequired
The domain as bought at the registrar, like yourstore.in.
dns_recordobjectrequired
The record to add at the domain provider (name is the full hostname).
dns_record.typeenumrequired
One of CNAME A
dns_record.namestringrequired
dns_record.valuestringrequired
dns_recordsarray of objectrequired
Every record to add, as the DNS provider asks for it.
dns_records[].typeenumrequired
One of CNAME A
dns_records[].hoststringrequired
The record name as most providers ask for it: @ or the subdomain.
dns_records[].valuestringrequired
dns_records[].ttlintegerrequired
checksobject or nullrequired
What the last check found.
checks.dnsobjectrequired
checks.dns.okbooleanrequired
checks.dns.foundarray of objectrequired
checks.dns.found[].typeenumrequired
One of CNAME A AAAA
checks.dns.found[].valuestringrequired
checks.dns.problemstring or nullrequired
What is wrong and the fix, when not ok.
checks.httpsobject or nullrequired
The certificate check, once DNS is right.
checks.https.okbooleanrequired
checks.https.errorstring or nullrequired
messagestringrequired
What is happening and what to do, in plain words.
last_checked_attimestamp or nullrequired
verified_attimestamp or nullrequired
created_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/domains/dom_01JCG8ZQ5S7T0V4X8K2M3N6P9R/check \
  -H "Authorization: Bearer pat_live_..." \
  -H "Idempotency-Key: $(uuidgen)"

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

Response 200

{
  "id": "dom_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
  "hostname": "string",
  "purpose": "store",
  "status": "pending_dns",
  "kind": "subdomain",
  "registrable_domain": "string",
  "dns_record": {
    "type": "CNAME",
    "name": "Festive saree",
    "value": "string"
  },
  "dns_records": [
    {
      "type": "CNAME",
      "host": "string",
      "value": "string",
      "ttl": 1
    }
  ],
  "checks": {
    "dns": {
      "ok": false,
      "found": [
        {
          "type": "CNAME",
          "value": "string"
        }
      ],
      "problem": "string"
    },
    "https": {
      "ok": false,
      "error": "string"
    }
  },
  "message": "Hand block printed cotton.",
  "last_checked_at": "2026-11-04T10:00:00.000Z",
  "verified_at": "2026-11-04T10:00:00.000Z",
  "created_at": "2026-11-04T10:00:00.000Z"
}