Skip to main content
POST
/
v1
/
partner
/
products
/
:productId
/
sync
Create Shopify sync configuration for a product
curl --request POST \
  --url http://localhost:3000/v1/partner/products/:productId/sync \
  --header 'Content-Type: application/json' \
  --data '
{
  "shopify_store_domain": "<string>",
  "shopify_handle": "<string>",
  "sync_preferences": {
    "enable_sync": false,
    "sync_name": false,
    "sync_description": false,
    "sync_images": false,
    "sync_retail_price": false,
    "sync_barcode": false,
    "sync_size": false
  }
}
'
{
  "sync": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scraped_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "shopify_store_domain": "<string>",
    "shopify_handle": "<string>",
    "sync_name": true,
    "sync_description": true,
    "sync_images": true,
    "sync_retail_price": true,
    "sync_barcode": true,
    "sync_size": true,
    "is_enabled": true,
    "last_sync_at": "<string>",
    "last_sync_status": "success",
    "last_sync_error": "<string>",
    "locally_modified_fields": [
      "<string>"
    ],
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Path Parameters

productId
string<uuid>
required

Body

application/json
shopify_store_domain
string
required
shopify_handle
string
required
sync_preferences
object
required

Response

Sync configuration created

sync
object
required