Skip to main content
GET
Error

Authorizations

X-Internal-Token
string
header
required

The data-platform SERVICE token (DATA_PLATFORM_API_TOKEN) in the X-Internal-Token header. Guards the machine-only incremental CDC export; not a user credential and never a POS session — reachable only server-to-server.

Path Parameters

resource
string
required

The registry name of the resource (table) to stream. Known: products, skus, prices, brands, suppliers, taxonomyAxes, promotions, coupons, customers, inventoryStock, inventoryMovements, transactions, transactionItems, salesTickets, stores, regions. An unknown name is a 404.

Minimum string length: 1

Query Parameters

since
string<date-time>

ISO 8601 EXCLUSIVE lower bound on updated_at (updated_at > since). Use for the first pull or a coarse restart; omit for a full snapshot. Superseded by cursor.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
cursor
string

Opaque page token from a prior response's nextCursor. Resumes STRICTLY after the last returned (updated_at, id), so a tie on updated_at never dups or skips. When present it supersedes since. A malformed cursor is a 400.

Minimum string length: 1
limit
integer

Max rows to return (default 200, clamped to 500). Fetch further pages via nextCursor while hasMore is true.

Required range: 1 <= x <= 9007199254740991

Response

One page of changed rows (incl. tombstones) plus the next-page cursor.

One page of changed rows (incl. tombstones) plus the next-page cursor.

items
object[]
required

The changed rows for this page (may be empty).

nextCursor
string | null
required

Opaque token for the next page, or null when the feed is drained.

hasMore
boolean
required

Whether more rows remain beyond this page.