Poll for resources changed since a timestamp
Poll for resources changed since a timestamp, without pulling the whole collection. Wraps the store's own list endpoint with a filters= query, using whichever field that resource actually tracks changes by (products: edit_date, orders: status_date. other…
Request
- x-api-key: <your-api-key>
- Content-Type: application/json
This operation is read-only. Change the path values above and send.
Response
{
"count": 3,
"list": [
{}
],
"resource": "<resource>",
"since": "<since>"
}What it does
Poll for resources changed since a timestamp, without pulling the whole collection. Wraps the store's own list endpoint with a filters= query, using whichever field that resource actually tracks changes by (products: edit_date, orders: status_date. other resources aren't supported, since several don't track changes at all). "since" must be in the CONNECTED STORE'S OWN LOCAL TIME, not UTC. check GET /v1/shoper/shop's platformVersion call, or the store's own admin panel, for its timezone; this route does not convert it. Use ?site= to pick among several connected stores.
Request
Parameters
| Field | In | Type | Required | Description |
|---|---|---|---|---|
resource | query | enum | yes | Which resource to poll for changes |
since | query | string | yes | A date/time in the connected store's own local timezone, e.g. "2026-08-19 12:00:00" |
site | query | string | no | Which connected store; required only when several are connected |
Response
| Field | Type | Description |
|---|---|---|
count | integer | |
list | array<object> | |
resource | string | |
since | string |
Example response
{
"count": 3,
"list": [
{}
],
"resource": "<resource>",
"since": "<since>"
}Errors
Every error answers with the same envelope: an HTTP status, a machine code and a sentence.
400 | The body or a parameter failed validation. The details array names the field. |
401 | No key, a revoked key or a wrong header. Send x-api-key. |
402 | The wallet cannot cover this call. Top up or wait for the monthly grant. |
404 | The resource does not exist, or it is not yours. Both answer identically and cost nothing. |
429 | Over the per-minute quota of your tier. Back off and retry. |
5xx | Upstream refused or timed out. The call is not billed. |
Code
curl -X GET 'https://app.castomapi.com/v1/shoper/changes' \ -H 'x-api-key: <your-api-key>'
const res = await fetch('https://app.castomapi.com/v1/shoper/changes', {
method: 'GET',
headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);import { request } from 'node:https';
// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/shoper/changes', {
method: 'GET',
headers: { 'x-api-key': '<your-api-key>' }
});
const data = await res.json();
console.log(data);import requests
res = requests.get(
'https://app.castomapi.com/v1/shoper/changes',
headers={'x-api-key': '<your-api-key>'},
timeout=30,
)
print(res.json())<?php
$ch = curl_init('https://app.castomapi.com/v1/shoper/changes');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);Cost and limits
This operation costs 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire.
Rate limits per minute
| No key | 10 |
| Free | 60 |
| Pro | 300 |
| Enterprise | 1200 |
Questions
What does Poll for resources changed since a timestamp cost?
1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month.
How do I authenticate?
Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.
Can I send an Authorization: Bearer token instead?
Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.
What are the limits?
10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.
OpenAPI: https://app.castomapi.com/docs/json