{
"title": "<string>",
"images": [
{
"url": "<string>",
"external_media_id": "<string>",
"alt_text": "<string>",
"role": "<string>",
"position": 0,
"width": 1,
"height": 1
}
],
"handle": "<string>",
"canonical_url": "<string>",
"enabled": true,
"available": true,
"rating": 2.5,
"review_count": 1,
"price": {
"amount": "79.00",
"currency": "USD"
},
"compare_at_price": {
"amount": "79.00",
"currency": "USD"
},
"variants": [
{
"source_variant_id": "<string>",
"option_values": {},
"title": "<string>",
"sku": "<string>",
"canonical_url": "<string>",
"available": true,
"inventory_quantity": 123,
"inventory_observed_at": "2023-11-07T05:31:56Z",
"inventory_policy": "<string>",
"inventory_item_id": "<string>",
"image_url": "<string>",
"media": [
{
"external_media_id": "<string>",
"url": "<string>",
"role": "<string>",
"position": 0
}
]
}
],
"variants_complete": false,
"options": [
{
"key": "<string>",
"values": [
{
"source_value": "<string>",
"display_label": "<string>",
"normalized_value": "<string>",
"position": 0,
"swatch": {
"label": "<string>",
"color": "<string>",
"colors": [
"<string>"
],
"image_url": "<string>",
"raw_css": "<string>"
}
}
],
"source_name": "<string>",
"presentation_role": "auto",
"position": 0,
"source_size_system": "<string>"
}
],
"size_charts": [
{
"url": "<string>",
"external_id": "<string>",
"content": {},
"applies_to": {},
"locale": "<string>"
}
],
"garment_measurements": [
{
"value": 1,
"size_label": "<string>",
"raw_text": "<string>",
"source": "<string>",
"confidence": 0.5
}
],
"model_observations": [
{
"name": "<string>",
"size_worn": "<string>",
"measurements": {},
"source": "<string>",
"evidence": [
"<string>"
]
}
],
"brand": "<string>",
"product_type": "<string>",
"description": "<string>",
"custom_instructions": "<string>",
"prompt_tag": "<string>",
"source_active": true,
"source_status_raw": "<string>",
"source_updated_at": "2023-11-07T05:31:56Z",
"schema_version": 2
}Catalog product input
Product-level fields for current JSON catalog writes.
A new product requires title and images. For an existing product,
every field is optional and omitted fields stay unchanged.
5001 - 500 elementsShow child attributes
Show child attributes
Required when storefront URL resolution matches by handle.
2558192Whether the product can use the fitting room. This is separate from sale availability.
Source-reported sale availability for a product without exact variants. Variant availability takes precedence when variants exist.
Current overall customer rating.
0 <= x <= 5Number of reviews represented by the overall rating.
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
5000- Option 1
- Option 2
Show child attributes
Show child attributes
When true, omitted variants become inactive. Use with an empty array for a variantless product.
Auto-derived from variant option values when omitted.
20Show child attributes
Show child attributes
50- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes
250Show child attributes
Show child attributes
50Show child attributes
Show child attributes
255255655364096Concise garment naming override; auto-detected when omitted.
255255Show child attributes
Show child attributes
Omit for version 2. Use 1 only for an existing image-only legacy integration.
1, 2