Get Product by Slug

GET

{store_url}/api/v1/products/{slug}

Retrieves detailed product information using the product’s slug instead of its ID.

This endpoint is commonly used on SEO-friendly product pages, where products are identified by human-readable URLs.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠422Validation Error

🟠401Unauthorized

🔴500Internal Server error

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request GET '{store_url}/api/v1/products/nike-air-max-90' \
--header 'Content-Type: application/json' \
--data '{
    "includes": [
        "variants",
        "reviews",
        "images"
    ]
}'

Response Example

200 - Example 1

{
    "id": "faa1de09-1e0a-4184-9573-9e639e6d0764",
    "product_class": "grouped_product",
    "sku": "helllo",
    "barcode": "",
    "parent_id": null,
    "name": "Bag",
    "slug": "test-4",
    "price": 1000,
    "short_description": {
        "ar": "وصف مختصر للمنتج",
        "en": "Short product description."
    },
    "sale_price": 850,
    "formatted_price": "SAR 1,000.00",
    "formatted_sale_price": "SAR 850.00",
    "currency": "SAR",
    "currency_symbol": "SAR",
    "attributes": [],
    "categories": [],
    "display_order": 32766,
    "has_options": true,
    "has_fields": false,
    "images": [],
    "videos": [],
    "is_draft": false,
    "quantity": 19,
    "is_infinite": false,
    "html_url": "https://osama.zid.store/products/test-4",
    "weight": {
        "value": 0,
        "unit": "kg"
    },
    "keywords": [
        "bag",
        "strawberries"
    ],
    "requires_shipping": true,
    "is_taxable": true,
    "structure": "standalone",
    "seo": {
        "title": {
            "ar": "حقيبة",
            "en": "Bag"
        },
        "description": {
            "ar": "وصف المنتج",
            "en": "Product description"
        }
    },
    "rating": {
        "average": 0,
        "total_count": 0,
        "1_ratings": {
            "percentage": 0,
            "count": 0
        },
        "2_ratings": {
            "percentage": 0,
            "count": 0
        },
        "3_ratings": {
            "percentage": 0,
            "count": 0
        },
        "4_ratings": {
            "percentage": 0,
            "count": 0
        },
        "5_ratings": {
            "percentage": 0,
            "count": 0
        }
    },
    "store_id": 3,
    "purchase_restrictions": {
        "min_quantity_per_cart": 1,
        "max_quantity_per_cart": 5,
        "availability_period_start": null,
        "availability_period_end": null,
        "sale_price_period_start": null,
        "sale_price_period_end": null
    },
    "metafields": [],
    "meta": {
        "location_id": "1",
        "childs": [],
        "parents": []
    },
    "related_products_settings": "",
    "related_products_title": {
        "ar": "منتجات ذات صلة",
        "en": "Related products"
    },
    "badge": {
        "body": {
            "ar": "string",
            "en": "string"
        },
        "icon": {
            "code": "string"
        },
        "is_example": true
    },
    "variants": [],
    "description": {
        "ar": "وصف كامل للمنتج",
        "en": "Full product description."
    },
    "custom_user_input_fields": [],
    "custom_option_fields": [],
    "options": [
        {
            "id": "226cb1df-07e6-4a4a-ba55-49134d371ed2",
            "name": "Images",
            "name_i18n": {
                "ar": "صور",
                "en": "Images"
            },
            "slug": "images",
            "choices": [
                "Image 1",
                "Image 2"
            ],
            "choices_metadata": {
                "Image 1": {
                    "id": "948781ef-1117-495c-aea0-f10c8ed7141e",
                    "value": {
                        "ar": "صورة 1",
                        "en": "Image 1"
                    },
                    "type": "icon",
                    "type_value": "https://media.zid.store/attribute-values/images/b59274ca-95c9-47ce-852e-20f5167e4807.jpg"
                },
                "Image 2": {
                    "id": "f7a3da23-d906-4404-afd2-860046e028ff",
                    "value": {
                        "ar": "صورة 2",
                        "en": "Image 2"
                    },
                    "type": "icon",
                    "type_value": "https://media.zid.store/attribute-values/images/a8d34fca-201c-4a72-8b40-8fb11d978491.jpg"
                }
            }
        },
        {
            "id": "eb8f05b2-2928-43b4-b2b2-3144f3aacb24",
            "name": "Colors",
            "name_i18n": {
                "ar": "الألوان",
                "en": "Colors"
            },
            "slug": "colors",
            "choices": [
                "Black",
                "White",
                "Blue"
            ],
            "choices_metadata": {
                "Black": {
                    "id": "a3b083be-1b2d-4ea1-acda-b8c289366787",
                    "value": {
                        "ar": "أسود",
                        "en": "Black"
                    },
                    "type": "color",
                    "type_value": "#000000"
                },
                "White": {
                    "id": "d5458526-9a61-4387-a5cf-7e3363b1b274",
                    "value": {
                        "ar": "أبيض",
                        "en": "White"
                    },
                    "type": "default",
                    "type_value": null
                },
                "Blue": {
                    "id": "7c6c59a6-fcc6-4e2c-a5ca-c2d567218771",
                    "value": {
                        "ar": "أزرق",
                        "en": "Blue"
                    },
                    "type": "color",
                    "type_value": "#0000FF"
                }
            }
        }
    ],
    "related_products": [],
    "group_products": null,
    "stocks": [],
    "sold_products_count": 0,
    "created_at": "2025-10-28T08:21:10.679886Z",
    "updated_at": "2025-11-18T14:24:07.432413Z"
}

Modified at 2026-07-29 13:10:56

Create Product Question

Get Selection Groups