# Sync Part of AppEngine API Documentation. Full index: https://appengine.appmint.io/documentation.md ## GET /sync **Get sync information** `operationId: SyncController_syncInfo` Overall sync state for the platform. #### Signature ```http GET /sync () -> Sync information ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/info` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Responses | Status | Meaning | | --- | --- | | `200` | Sync information | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/info **Get organization sync info** `operationId: SyncController_info` Sync configuration and last-run detail for the calling org. #### Signature ```http GET /sync/info () -> Org sync info ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/status` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Responses | Status | Meaning | | --- | --- | | `200` | Org sync info | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/purge **Purge sync data** `operationId: SyncController_purge` Deletes the org's accumulated sync data. **This is a destructive operation exposed as a GET.** Anything that pre-fetches links, a browser address bar, or a crawler following a URL will trigger it. There is no confirmation body and no undo — the next sync has to rebuild everything from the source platform. #### Signature ```http GET /sync/purge () -> The purge result ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Notes - Destructive, and reachable by a plain GET. #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `POST /sync/trigger` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Responses | Status | Meaning | | --- | --- | | `200` | The purge result | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## POST /sync/queue **Queue a sync job** `operationId: SyncController_queueJob` Queues a sync job for processing. The body is the job configuration; an empty body is rejected. #### Signature ```http POST /sync/queue (body) -> The queued job ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors | Status | Code | Message | When | What to do | | --- | --- | --- | --- | --- | | `400` | EMPTY_DATA | Empty Data | The body is empty. | Supply a job configuration. | Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `POST /sync/trigger` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Request body The sync job configuration. ```json { "platform": "shopify", "syncType": "products" } ``` ### Responses | Status | Meaning | | --- | --- | | `201` | The queued job | | `400` | Empty Data — The body is empty. | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/pause/{name} **Pause a sync job** `operationId: SyncController_pause` Pauses a running sync job. **A state change exposed as a GET** — treat the URL as an action, not something safe to prefetch. Pausing stops new work; a job already mid-run finishes what it is doing. #### Signature ```http GET /sync/pause/{name} (name: string) -> The result ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Notes - Mutating GET. #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/resume/{name}` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | | `name` | path | string | yes | Sync job name. | ### Responses | Status | Meaning | | --- | --- | | `200` | The result | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/resume/{name} **Resume a sync job** `operationId: SyncController_resume` Resumes a paused sync job. Also a mutating GET. #### Signature ```http GET /sync/resume/{name} (name: string) -> The result ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Notes - Mutating GET. #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/pause/{name}` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | | `name` | path | string | yes | Sync job name. | ### Responses | Status | Meaning | | --- | --- | | `200` | The result | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## POST /sync/trigger **Trigger a sync** `operationId: SyncController_triggerSync` Manually runs a sync for a platform. `syncType` takes a single type **or an array** of types, so several can be triggered together. `options.force` overrides the guard that stops a sync starting while one is already running — which is exactly the guard that prevents two concurrent syncs writing over each other. Use it only when you know the previous run is genuinely dead. Without `startDate`/`endDate` the platform's own default window applies; supply them to back-fill. #### Signature ```http POST /sync/trigger (body) -> The triggered job ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Notes - `force` bypasses the concurrent-run guard. #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/platforms` - `GET /sync/status` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Request body What to sync. ```json { "platform": "shopify", "syncType": "products" } ``` ### Responses | Status | Meaning | | --- | --- | | `200` | Sync job triggered successfully | | `201` | The triggered job | | `400` | Invalid sync type or missing parameters | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## POST /sync/trigger/{platform}/{syncType} **Trigger a sync by URL** `operationId: SyncController_triggerSyncByParam` The same trigger, with the platform and sync type in the path instead of the body — convenient from a script or a webhook. `syncType` is optional; omitting it runs the platform's default set. #### Signature ```http POST /sync/trigger/{platform}/{syncType} (platform: string, syncType: string, body) -> The triggered job ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `POST /sync/trigger` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | | `platform` | path | string | yes | Platform to sync. | | `syncType` | path | string | yes | Sync type. Optional — omit for the platform default. | ### Request body Optional options. ```json { "force": false } ``` ### Responses | Status | Meaning | | --- | --- | | `201` | The triggered job | | `400` | Invalid sync type | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/platforms **List platforms and sync types** `operationId: SyncController_getAvailablePlatforms` Which platforms can be synced and which sync types each supports — read this before constructing a trigger, since the valid types differ per platform. #### Signature ```http GET /sync/platforms () -> Platforms and their sync types ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `POST /sync/trigger` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Responses | Status | Meaning | | --- | --- | | `200` | Platforms and their sync types | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/status **Get sync job status** `operationId: SyncController_getSyncStatus` The state of the org's sync jobs — what is running, what finished, what failed. #### Signature ```http GET /sync/status () -> Sync status ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/status/{platform}` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | ### Responses | Status | Meaning | | --- | --- | | `200` | Sync status | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. | ## GET /sync/status/{platform} **Get one platform's sync status** `operationId: SyncController_getPlatformSyncStatus` Sync state for a single platform. #### Signature ```http GET /sync/status/{platform} (platform: string) -> Platform sync status ``` #### Access Requires a bearer JWT (`Authorization: Bearer `). #### Errors Plus the standard platform errors: `401`, `403`, `429`, `500`. #### See also - `GET /sync/status` ### Parameters | Name | In | Type | Required | Description | | --- | --- | --- | --- | --- | | `orgid` | header | string | yes | Organization (tenant) identifier. Every request is scoped to this org; data from other orgs is never visible. Issued with your API credentials. | | `platform` | path | string | yes | Platform name. | ### Responses | Status | Meaning | | --- | --- | | `200` | Platform sync status | | `401` | Authentication failed: Invalid or expired token — The `Authorization` header is missing, malformed, or the JWT has expired. | | `403` | You do not have permission to perform this action — The caller is authenticated but lacks the role required by the endpoint, or is acting on another org. | | `429` | Too Many Requests — More than 100,000 requests from one IP within 5 minutes (configurable per deployment). CORS preflights and requests from inside the platform cluster are not counted. The limiter answers before the error filter, so the body is `{ statusCode, error, message }` with no `path`, `method` or `timeStamp`; the `RateLimit-*` response headers say when the window resets. | | `500` | An unexpected error occurred. Our team has been notified. — An unhandled server-side failure. |