Create sync job

Creates a new sync job for an integration with specified configuration

POST/v1/apps/{app_id}/integrations/{integration_id}/sync

integrations-api:POST:/v1/apps/{app_id}/integrations/{integration_id}/sync

Creates a new sync job for an integration with specified configuration

API ownership

API family: Integrations API
Best for: Integration records, setup verification, app and integration stats, and sync job operations.
Do not use from: Direct catalog, media, order, identity, or storefront reads and writes.
Guide route: /integrations

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Method: POST
Path: /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync
Summary: Create sync job
Description: Creates a new sync job for an integration with specified configuration
OpenAPI contract: integrations-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters

Name	In	Required	Type	Description
app_id	path	Yes	string	App UUID
integration_id	path	Yes	string	Integration UUID

Request bodyDocumented body

Property	Type	Required	Details
`full_sync`	boolean	No	-
`item_types`	object[]	No	-

Property	Type	Required	Details
`item_ids`	string[]	No	-
`type`	string	No	-

Generated example (synthetic):

{
  "full_sync": false,
  "item_types": [
    {
      "item_ids": [
        "string"
      ],
      "type": "string"
    }
  ]
}

Responses4 statuses

Status	Description	Content
200	Sync job created successfully	application/json
400	Invalid request	application/json (object)
404	Integration not found	application/json (object)
500	Internal server error	application/json (object)

Property	Type	Required	Details
`data`	object	No	-
`success`	boolean	No	-

Property	Type	Required	Details
`breakdown`	object	No	-
`jobs_created`	integer	No	-
`sync_id`	string	No	-

Generated example (synthetic):

{
  "data": {
    "breakdown": {},
    "jobs_created": 0,
    "sync_id": "string"
  },
  "success": false
}

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

Use these fields to confirm you are implementing the intended endpoint contract.