API Batch Import

Use file URL ingestion for scheduled catalogue synchronisation and larger datasets. Youzu fetches the file and processes it asynchronously.

Submit a file URL

Supply an HTTP or HTTPS URL and its format:

curl -X POST https://platform.youzu.ai/api/v1/admin/catalogue/ingest \
  -H "x-client-key: YOUR_CLIENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileUrl": "https://feeds.example.com/youzu/products.csv",
    "format": "csv"
  }'

Supported format values are csv, json, and xml. The URL must remain reachable by Youzu while the job is running and must resolve exclusively to public network addresses; loopback, private, link-local, and cluster-internal destinations are rejected. Do not put API credentials or other secrets in the URL.

A successful response confirms that the asynchronous request was accepted. It does not mean every product has finished processing. Follow Upload Product Data and Track Processing, then Check Moderation Results.

File structure

Every source record follows the Product Data Requirements. Source property names use camelCase, and externalRef, clientId, and catalogueId must not be supplied.

JSON

A JSON file contains an array of product objects. The products wrapper used by direct JSON ingestion is not part of the file.

[
  {
    "sku": "CHAIR-001",
    "name": {"en": "Ergonomic Office Chair"},
    "description": {"en": "Office chair with adjustable lumbar support"},
    "url": "https://shop.example.com/products/chair-001",
    "price": {"USD": 299.99},
    "inStock": true,
    "isPublished": true,
    "images": ["https://cdn.example.com/chair-001/front.jpg"],
    "dimensions": {"widthCm": 60, "heightCm": 120, "lengthCm": 70},
    "weightKg": 15.5,
    "brand": "ErgoDesigns"
  }
]

CSV and XML

Use a header or element for each camelCase product field. Encode structured values such as name, description, price, images, categories, dimensions, colour, and customProperties as valid JSON values in the corresponding cell or element.

Keep the feed UTF-8 encoded, give every row a stable catalogue-unique sku, and validate image and product URLs before publishing the file.