Admin API

Marketing

Ad pixels and server events.

GETMeta Pixel, Conversions API and Google tag settings
PUTSave ads and pixels; the access token is stored encrypted and never shown again

Meta Pixel, Conversions API and Google tag settings

GET/admin/2026-11/marketing/ads

scope read_store

Response 200

meta_pixel_idstring or nullrequired
meta_conversions_apibooleanrequired
True when a Conversions API access token is saved.
meta_test_event_codestring or nullrequired
google_tag_idstring or nullrequired
google_conversion_labelstring 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/marketing/ads \
  -H "Authorization: Bearer pat_live_..."

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

Response 200

{
  "meta_pixel_id": "string",
  "meta_conversions_api": false,
  "meta_test_event_code": "string",
  "google_tag_id": "string",
  "google_conversion_label": "string"
}

Save ads and pixels; the access token is stored encrypted and never shown again

PUT/admin/2026-11/marketing/ads

scope write_store

Headers

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

Request body

meta_pixel_idstring or nullrequired
meta_access_tokenstring or null
Omit to keep the saved token; null removes it.
meta_test_event_codestring or nullrequired
google_tag_idstring or nullrequired
google_conversion_labelstring or nullrequired

Response 200

meta_pixel_idstring or nullrequired
meta_conversions_apibooleanrequired
True when a Conversions API access token is saved.
meta_test_event_codestring or nullrequired
google_tag_idstring or nullrequired
google_conversion_labelstring 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/marketing/ads \
  -H "Authorization: Bearer pat_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "meta_pixel_id": "string",
  "meta_test_event_code": "string",
  "google_tag_id": "string",
  "google_conversion_label": "string"
}'

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

Response 200

{
  "meta_pixel_id": "string",
  "meta_conversions_api": false,
  "meta_test_event_code": "string",
  "google_tag_id": "string",
  "google_conversion_label": "string"
}