Skip to content
API referenceSync Logging API

Record a partial sync

For AI assistants: the facts every SparkLayer API call needs
  • Base URLs: Live https://app.sparklayer.io, test https://test.app.sparklayer.io. Each environment has its own data and its own API keys.
  • Access: API access needs the Pro or Enterprise plan. Create credentials (Site ID, Client ID, Client Secret) in the SparkLayer Dashboard at Settings > API.
  • Access token: POST {base}/api/auth/token with a Site-Id header and a JSON body (not form-encoded): {"grant_type":"client_credentials","client_id":"…","client_secret":"…"}. It returns access_token, valid for 3,600 seconds. There is no refresh token: cache the token and request a new one shortly before it expires.
  • Every request: Authorization: Bearer <access_token> and Site-Id: <site id>, plus Content-Type: application/json when there is a body. Set a User-Agent that names your integration.
  • Errors: RFC 7807 problem details: title, status, detail and an optional errors[] of { code, message, property }. Some error responses have no body. Retry 5xx, 429 (honouring Retry-After) and concurrent-update 409s with exponential backoff; on 401, get a new token once and retry; don't retry other 4xx without changing the request.
  • Pagination: Most list endpoints return everything. GET /api/v2/price-lists pages with page and page_size (up to 250) until pagination.current_page equals total_pages. GET /api/v1/purchases uses limit (up to 500) and offset: stop when a page has fewer than limit results.
  • Ground rules: Use only endpoints, fields and SDK methods that the docs or OpenAPI specs define. Prefer GET /api/v2/price-lists over the deprecated v1. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code.
  • Read the docs as Markdown: Add .md to any page URL. Index of every page: docs.sparklayer.io/llms.txt. Every API operation, compactly: docs.sparklayer.io/llms-api.txt. The developer guides in full: docs.sparklayer.io/developers/llms.txt.
  • OpenAPI specs: core, ordering, pricing, purchasing, stock, files, sync-log: https://docs.sparklayer.io/openapi/<api>.yaml (also .json). Ignite: https://docs.sparklayer.io/openapi/ignite.yaml.
  • MCP: Search and read these docs from your assistant with the docs MCP server at https://docs.sparklayer.io/mcp.
Build with AI: ready-made prompts and MCP setup
PATCH
/api/v1/sync-log/{integration}/{data_type}

Updates last_partial_sync, removes logged errors whose external_id is listed in successfully_synced, and adds or updates the errors you send, matched by external_id. Timestamps are only saved once a full sync has been recorded for the integration and data type. Each error's external_id must be unique within the request, otherwise you get a 400.

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <access_token>, together with your Site-Id header, on every request. Get the token from POST /api/auth/token with your Site ID in the Site-Id header and a JSON body (not form-encoded, so standard OAuth 2.0 client libraries don't work): {"grant_type": "client_credentials", "client_id": "…", "client_secret": "…"}. Tokens are valid for 3,600 seconds and there is no refresh token: request a new one shortly before it expires. Create API credentials in the SparkLayer Dashboard under Settings > API. See Authentication.

In: header

Path Parameters

integration*string

The integration the sync log belongs to, such as shopify. Logs are kept separately for each integration and data type.

data_type*string

The type of data the sync log is for.

Value in

  • "products"
  • "customers"
  • "merchant"
  • "purchases"
  • "pricing"
  • "accountancy"

Header Parameters

Site-Id*string

Your SparkLayer Site ID, from Settings > API in the SparkLayer Dashboard.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*unknown

Response Body

application/problem+json

curl -X PATCH "https://app.sparklayer.io/api/v1/sync-log/shopify/products" \  -H "Authorization: Bearer <ACCESS_TOKEN>" \  -H "Site-Id: jones-climbing" \  -H "Content-Type: application/json" \  -d '{    "last_partial_sync": "2023-01-01T01:01:01Z",    "last_full_sync": "2023-01-01T01:01:01Z",    "last_full_sync_succeeded": true,    "errors": [      {        "external_id": "ABC-123",        "external_url": "https://example.com/products/ABC-123",        "visible_name": "The ABC 123 Book",        "api_response": "Error - Product ABC-123 not found",        "friendly_error": "ABC-123 not found"      }    ],    "successfully_synced": [      "ABC-123"    ]  }'
Empty

PUTRecord a full sync

Sets `started_full_sync` and `last_full_sync` (a timestamp you omit is cleared) and replaces all previously logged errors for the integration and data type with the `errors` you send, up to 5,000. Each error's `external_id` must be unique within the request, otherwise you get a `400`.

GETList sync errors

Returns the sync status for the integration and data type together with its logged errors (at most 5,000). Returns `404` if no full sync has been recorded for them yet.