Skip to main content
POST
/
api
/
integrations
/
{id}
/
synchronize
Synchronize an integration
curl --request POST \
  --url https://clarus-api.com/api/integrations/{id}/synchronize \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "data": {
    "id": 123,
    "type": "<string>",
    "attributes": {}
  }
}

​
Behavior

Triggers a background synchronization job for the integration. The sync type depends on the integration configuration.
Sync TypeDescription
OrdersImport new orders from the platform
ProductsSync product catalog changes
StockPush stock levels to the platform
Note: No request body required. The integration ID in the path is sufficient.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the integration to synchronize

Response

Synchronization triggered successfully

Standard successful response wrapper following JSON:API format

​
data
object

The response payload