ProductSyncRequest

Product sync request. FULL replaces entire catalog; INCREMENTAL adds/updates only the provided products.

syncTypestringrequired

FULL replaces entire catalog; INCREMENTAL adds/updates only sent products

Possible values: [FULL, INCREMENTAL]

Example: FULL

products object[]required

List of products (1-500 per batch)

Possible values: >= 1, <= 500

Array [

externalIdstringrequired

External product ID from the source system (e.g. WooCommerce product ID)

Possible values: non-empty

Example: prod_001

skustring

Stock keeping unit

Example: SKU-001

namestringrequired

Product display name

Possible values: <= 512 characters

Example: Zapatillas Running Pro

descriptionstring

Product description (plain text or HTML)

Possible values: <= 5000 characters

pricenumberrequired

Regular price

Possible values: >= 0

Example: 89.99

currencystring

ISO 4217 currency code

Possible values: <= 3 characters

Example: EUR

urlstringrequired

Canonical URL of the product page

Possible values: non-empty

Example: https://mitienda.com/prod_001

imageUrlstring

Main product image URL

Example: https://mitienda.com/images/prod_001.jpg

categoriesstring[]

Product categories

brandsstring[]

Product brands

inStockboolean

Whether product is currently in stock

stockQuantityint32

Available stock quantity

Example: 25

ratingnumber

Average rating (0.0-5.0)

Possible values: >= 0 and <= 5

Example: 4.5

reviewCountint32

Number of reviews

Example: 120

isActiveboolean

Whether product is active in the catalog

tagsstring[]

Product tags for search enrichment

salePricenumber

Sale/discounted price (if applicable)

Possible values: >= 0

Example: 69.99

parentExternalIdstring

Parent product external ID (for product variants)

attributes object

Custom attributes (key-value pairs)

property name*string

]

ProductSyncRequest

{
  "syncType": "FULL",
  "products": [
    {
      "externalId": "prod_001",
      "sku": "SKU-001",
      "name": "Zapatillas Running Pro",
      "description": "string",
      "price": 89.99,
      "currency": "EUR",
      "url": "https://mitienda.com/prod_001",
      "imageUrl": "https://mitienda.com/images/prod_001.jpg",
      "categories": [
        "string"
      ],
      "brands": [
        "string"
      ],
      "inStock": true,
      "stockQuantity": 25,
      "rating": 4.5,
      "reviewCount": 120,
      "isActive": true,
      "tags": [
        "string"
      ],
      "salePrice": 69.99,
      "parentExternalId": "string",
      "attributes": {}
    }
  ]
}