Popular

↑↓ move ↵ open All results →

Integration API · Products

Get a product

GEThttps://{store}/api/v1/integrations/products/{id}

One product by its id in this store. include=offers adds its variants.

Integration key with the catalog:read ability: Authorization: Bearer {key}.

Path parameters

idintegerrequired
Product id in this store.

Query parameters

includestring
offers adds the variants.
offers

Responses

200The product. 
{
    "data": {
        "id": 12,
        "name": "Навушники Sonar ANC повнорозмірні",
        "description": "Активне шумозаглушення, 40 годин роботи.",
        "sku": "SONAR-ANC-BLK",
        "thumbnail_url": "https://your-store.storeforma.shop/media/12/sonar-anc.webp",
        "quantity": 24,
        "currency_code": "UAH",
        "min_price": 599900,
        "max_price": 599900,
        "weight": 0.32,
        "length": null,
        "height": null,
        "width": null,
        "has_offers": false,
        "is_archived": false,
        "category_id": 7,
        "attributes": [
            {
                "handle": "kolir",
                "name": "Колір",
                "type": "swatch",
                "unit": null,
                "group": null,
                "variant_axis": false,
                "values": [
                    "Чорний"
                ]
            },
            {
                "handle": "vaga",
                "name": "Вага",
                "type": "number",
                "unit": "г",
                "group": "Загальні",
                "variant_axis": false,
                "values": [
                    "320 г"
                ]
            }
        ],
        "input_options": [
            {
                "key": "hraviiuvannia",
                "label": "Гравіювання",
                "type": "text",
                "required": false,
                "price": 10000,
                "max": 30,
                "choices": []
            }
        ],
        "created_at": "2026-10-01 10:12:00",
        "updated_at": "2026-10-12 08:40:00",
        "offers": [
            {
                "id": 15,
                "sku": "SONAR-ANC-BLK",
                "price": 599900,
                "quantity": 24,
                "properties": [
                    {
                        "name": "Колір",
                        "value": "Чорний"
                    }
                ]
            }
        ]
    }
}
404No product with this id. 
{
    "code": "not_found",
    "message": "not_found",
    "field": null
}
401Missing, unknown or revoked key. 
{
    "code": "unauthenticated",
    "message": "Integration key is inactive.",
    "field": null
}
403The key lacks catalog:read, or the store’s plan has no API access. 
{
    "code": "forbidden",
    "message": "Integration key cannot catalog:read.",
    "field": null
}
422A field is invalid; field names it. 
{
    "code": "validation_error",
    "message": "name is required.",
    "field": "name"
}
429More than 60 requests a minute for this key. Wait Retry-After seconds. 
{
    "code": "rate_limited",
    "message": "Too many integration requests.",
    "field": null
}