Skip to content

Sync products from Shopify

Request

Kicks off a job that syncs product data (products, variant options, option values and variants) from the account's configured Shopify connection. Rejected with 409 if a sync is already in progress for the account. Poll the returned job by id to track progress.

Security
bearerToken
curl -i -X POST \
  https://api-v2.dash.app/shopify-product-sync-jobs \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
idstringrequired

Unique identifier of the job that has been created

Example:"be161977-d44e-4888-af3c-66522e223963"
accountIdstringrequired

The ID of the account the job is happening in

Example:"cfb665ca-ce35-4418-b9d5-70ee815db4bd"
creatorIdstringrequired

The ID of the User who created the job

Example:"google-oauth2|110955770826801837334"
typestringrequired

The job type

Value:"IN_PROGRESS"
Discriminator
progressobjectrequired
statusstringrequired
Enum:"PENDING""STARTING""STARTED""STOPPING"
Response
{
  "id": "be161977-d44e-4888-af3c-66522e223963",
  "accountId": "cfb665ca-ce35-4418-b9d5-70ee815db4bd",
  "creatorId": "google-oauth2|110955770826801837334",
  "type": "IN_PROGRESS",
  "progress": {
    "steps": [ … ]
  },
  "status": "PENDING"
}