Changes (polling)
Incremental sync feeds for partners without webhooks.
/changes/productsIncremental product sync. Pass updatedSince on the first call, then follow meta.pagination.nextCursor until hasMore is false; persist the last cursor and resume from it next time. Always walks ascending by updatedAt, so a row updated mid-walk is still delivered. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Page size, 1..200. Defaults to 50. min 1 · max 200 · default 50 |
cursor | query | string | Opaque cursor from a previous response meta.pagination.nextCursor. |
order | query | string | Sort direction on the collection sort key. One of: "asc", "desc" default "desc" |
includeTotal | query | string | When true, meta.pagination.total carries the full matching count (an extra COUNT query). |
channel | query | string | Marketplace channel. One of: "tiktok", "ebay", "etsy", "amazon" |
status | query | string | DoctorX-side listing lifecycle state. One of: "draft", "ready", "live", "error", "archived" |
source | query | string | How the listing entered DoctorX. One of: "template", "pod", "pulled", "csv", "crawlbot" |
templateId | query | string | DoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
shopId | query | string | Only products carrying a shop-sync on this shop. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
syncStatus | query | string | Narrow the shopId match to a specific push state, e.g. One of: "pending", "syncing", "synced", "failed" |
drxSku | query | string | Exact match on the seller design SKU. |
search | query | string | Free-text match on title, category, template name, seller SKU, tags, and the variant SKUs, and on the name, code and search terms of the template the product is bound to: each word may match the product or its template, so a title word and a template code together find it. A channel name or listing-status word in English or Vietnamese matches that field. Whitespace is collapsed and the term is folded, so the match is case- and accent-insensitive ( |
updatedSince | query | string (date-time) | string (date) | Only products updated at or after this instant. Pair it with |
sortBy | query | string | Sort key. STATED rather than inferred from One of: "createdAt", "updatedAt" default "createdAt" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/products' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/changes/ordersIncremental order sync, same cursor contract as /changes/products. Covers created, updated, status-changed, cancelled and tracking changes in one stream, since all of them touch updatedAt. It ALSO covers a settlement reconcile, which rewrites the fee fields without any seller action. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Page size, 1..200. Defaults to 50. min 1 · max 200 · default 50 |
cursor | query | string | Opaque cursor from a previous response meta.pagination.nextCursor. |
order | query | string | Sort direction on the collection sort key. One of: "asc", "desc" default "desc" |
includeTotal | query | string | When true, meta.pagination.total carries the full matching count (an extra COUNT query). |
channel | query | string | Marketplace channel. One of: "tiktok", "ebay", "etsy", "amazon" |
shopId | query | string | DoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
status | query | string | Channel-neutral order state. One of: "AWAITING_PAYMENT", "AWAITING_SHIPMENT", "SHIPPED", "DELIVERED", "COMPLETED", "CANCELLED", "RETURN_REQUESTED", "REFUNDED" |
fulfillmentStatus | query | string | POD fulfilment state, independent of the marketplace order state. One of: "UNFULFILLED", "QUEUED", "SENT_TO_SUPPLIER", "IN_PRODUCTION", "FULFILLED", "FAILED" |
search | query | string | Free-text match on marketplace order id, the marketplace's own order number ( |
searchIn | query | string | Narrows One of: "all", "product", "order", "buyer", "tracking" |
placedFrom | query | string (date-time) | string (date) | Lower bound on placedAt, inclusive. |
placedTo | query | string (date-time) | string (date) | Upper bound on placedAt, inclusive. |
updatedSince | query | string (date-time) | string (date) | Only orders updated at or after this instant. Use for incremental sync. |
sortBy | query | string | Sort key. Pair One of: "placedAt", "updatedAt" default "placedAt" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/orders' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/changes/returnsIncremental return sync. This is the feed the return lifecycle had NO equivalent of: order.return_created fires once, and a return changing state does not touch its order's updatedAt, so /changes/orders could not see it either. Walks ascending by the CHANNEL's own update time. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Page size, 1..200. Defaults to 50. min 1 · max 200 · default 50 |
cursor | query | string | Opaque cursor from a previous response meta.pagination.nextCursor. |
order | query | string | Sort direction on the collection sort key. One of: "asc", "desc" default "desc" |
includeTotal | query | string | When true, meta.pagination.total carries the full matching count (an extra COUNT query). |
channel | query | string | Marketplace channel. One of: "tiktok", "ebay", "etsy", "amazon" |
shopId | query | string | DoctorX resource id: a UUID in canonical 8-4-4-4-12 hex form. Version and variant bits are not constrained. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
orderId | query | string | Only returns against this DoctorX order. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
status | query | string | Exact match on the channel's own status wording ( |
updatedSince | query | string (date-time) | string (date) | Only returns whose CHANNEL update time is at or after this instant. Use for incremental sync. |
sortBy | query | string | Sort key. Pair One of: "returnUpdatedAt", "returnCreatedAt" default "returnUpdatedAt" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/returns' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/changes/templatesIncremental template sync, same cursor contract as /changes/products. A template carries the category, policies and variation axes every product built from it inherits, so a partner mirroring the catalog has to follow it as well as the products. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Page size, 1..200. Defaults to 50. min 1 · max 200 · default 50 |
cursor | query | string | Opaque cursor from a previous response meta.pagination.nextCursor. |
order | query | string | Sort direction on the collection sort key. One of: "asc", "desc" default "desc" |
includeTotal | query | string | When true, meta.pagination.total carries the full matching count (an extra COUNT query). |
channel | query | string | Marketplace channel. One of: "tiktok", "ebay", "etsy", "amazon" |
category | query | string | |
search | query | string | Free-text match on template name, seller template code and search terms, and on the category and title template of each of its channels (a term may mix the template text with one channel). A channel name in English or Vietnamese matches the channel. Whitespace is collapsed and the term is folded, so the match is case- and accent-insensitive ( |
includeHidden | query | string | |
preset | query | string | Return the PRESET library instead: this tenant’s presets plus every GLOBAL preset. |
updatedSince | query | string (date-time) | string (date) | Only templates changed at or after this instant. Pair it with |
sortBy | query | string | Sort key. STATED rather than inferred from One of: "createdAt", "updatedAt" default "createdAt" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/templates' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/changes/shopsIncremental sync of connection state. Covers a shop connecting, disconnecting, losing its grant, changing its listing restriction or moving its balance, all of which alter what a publish will do. The webhook equivalents (shop.*) cover only the first three. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Page size, 1..200. Defaults to 50. min 1 · max 200 · default 50 |
cursor | query | string | Opaque cursor from a previous response meta.pagination.nextCursor. |
order | query | string | Sort direction on the collection sort key. One of: "asc", "desc" default "desc" |
includeTotal | query | string | When true, meta.pagination.total carries the full matching count (an extra COUNT query). |
channel | query | string | Filter to one channel. One of: "tiktok", "ebay", "etsy", "amazon" |
status | query | string | Filter to one authorization status. One of: "connected", "expired", "revoked", "disconnected", "error", "paused" |
search | query | string | Free-text match on shop name, custom name, shop code, channel shop id, region, market and currency. A channel or status word in English or Vietnamese matches that field. Whitespace is collapsed and the term is folded, so the match is case- and accent-insensitive ( |
updatedSince | query | string (date-time) | string (date) | Only shops changed at or after this instant. Pair it with |
sortBy | query | string | Sort key. STATED rather than inferred from One of: "connectedAt", "updatedAt" default "connectedAt" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/shops' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/changes/ledger-entriesIncremental Etsy and Amazon ledger sync, across the key's shops. Delivers every entry DoctorX records (including an Amazon transaction that arrives after its date) and every entry whose figures or status change afterwards (an Amazon transaction moving from DEFERRED to RELEASED), ascending by when DoctorX wrote it. Pass updatedSince on the first call, follow meta.pagination.nextCursor until hasMore is false, and keep the last cursor to resume. The ledger is read from the marketplace every 6 hours and on POST /finances/sync. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
updatedSince | query | string (date-time) | string (date) | Only entries DoctorX recorded or changed at or after this instant. Omitted: from the beginning. |
shopId | query | string | Restrict to one shop. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
channel | query | string | Marketplace channel. One of: "tiktok", "ebay", "etsy", "amazon" |
limit | query | integer | Entries per page, 1..200. min 1 · max 200 · default 50 |
cursor | query | string | Opaque: pass back |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/ledger-entries' \
-H "Authorization: Bearer $DOCTORX_API_KEY"/changes/payoutsIncremental payout sync. Keyed on when DoctorX last WROTE the row rather than on settledAt, because a statement is re-pulled and re-reconciled after it first lands: a feed keyed on the settlement date would never re-deliver a payout whose figures had since been corrected. A change appears here once it is two minutes old, and resuming from your cursor never skips one. For anything more urgent, use webhooks.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
limit | query | integer | Page size, 1..200. Defaults to 50. min 1 · max 200 · default 50 |
cursor | query | string | Opaque cursor from a previous response meta.pagination.nextCursor. |
order | query | string | Sort direction on the collection sort key. One of: "asc", "desc" default "desc" |
includeTotal | query | string | When true, meta.pagination.total carries the full matching count (an extra COUNT query). |
shopId | query | string | Restrict to one shop. pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ |
channel | query | string | Marketplace channel. One of: "tiktok", "ebay", "etsy", "amazon" |
status | query | string | One of: "PAID", "PROCESSING" |
settledFrom | query | string (date-time) | string (date) | Inclusive lower bound on settledAt. |
settledTo | query | string (date-time) | string (date) | Inclusive upper bound on settledAt. |
updatedSince | query | string (date-time) | string (date) | Only payouts DoctorX wrote at or after this instant. Distinct from |
sortBy | query | string | Sort key. Pair One of: "settledAt", "updatedAt" default "settledAt" |
Responses
| Status | Meaning (body: error envelope) |
|---|---|
| 400 | Validation failed, or the request is not valid for this resource. |
| 401 | The API key is missing, unknown, revoked or expired. |
| 403 | The API key lacks the required scope, or is not bound to this shop. |
| 404 | No such resource for this tenant. |
| 409 | The request conflicts with the current state (see |
| 422 | The marketplace rejected the request; |
| 429 | Back off and retry. |
| 500 | A defect on our side ( |
Request sample
curl -X GET 'https://api.doctorx.vn/api/public/v1/changes/payouts' \
-H "Authorization: Bearer $DOCTORX_API_KEY"