Get variants of an item

Retrieve all active variants for a specific parent item.
Use this endpoint when an item has optionName set (indicating it has variants).

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Responses

🟢200OK

application/json

Variants retrieved successfully

Body

Example

{
    "status": "success",
    "message": "Variants fetched successfully",
    "data": {
        "variants": [
            {
                "_id": "507f1f77bcf86cd799439021",
                "name": "Pizza Margherita",
                "description": "Classic Italian pizza",
                "basePrice": 50,
                "discount": null,
                "isActive": true,
                "isAvailable": true,
                "isGroupAvailable": true,
                "order": 1,
                "vendor": "507f1f77bcf86cd799439013",
                "category": "507f1f77bcf86cd799439012",
                "prepTime": "20 minutes",
                "imagePath": null,
                "optionName": "Small",
                "parentItem": "507f1f77bcf86cd799439012",
                "isVariant": true,
                "createdAt": "2024-01-01T00:00:00.000Z",
                "updatedAt": "2024-01-01T00:00:00.000Z"
            },
            {
                "_id": "507f1f77bcf86cd799439022",
                "name": "Pizza Margherita",
                "description": "Classic Italian pizza",
                "basePrice": 75,
                "discount": null,
                "isActive": true,
                "isAvailable": true,
                "isGroupAvailable": true,
                "order": 2,
                "vendor": "507f1f77bcf86cd799439013",
                "category": "507f1f77bcf86cd799439012",
                "prepTime": "20 minutes",
                "imagePath": null,
                "optionName": "Medium",
                "parentItem": "507f1f77bcf86cd799439012",
                "isVariant": true,
                "createdAt": "2024-01-01T00:00:00.000Z",
                "updatedAt": "2024-01-01T00:00:00.000Z"
            },
            {
                "_id": "507f1f77bcf86cd799439023",
                "name": "Pizza Margherita",
                "description": "Classic Italian pizza",
                "basePrice": 100,
                "discount": null,
                "isActive": true,
                "isAvailable": true,
                "isGroupAvailable": true,
                "order": 3,
                "vendor": "507f1f77bcf86cd799439013",
                "category": "507f1f77bcf86cd799439012",
                "prepTime": "20 minutes",
                "imagePath": null,
                "optionName": "Large",
                "parentItem": "507f1f77bcf86cd799439012",
                "isVariant": true,
                "createdAt": "2024-01-01T00:00:00.000Z",
                "updatedAt": "2024-01-01T00:00:00.000Z"
            }
        ]
    }
}

🟠404Not Found

🔴500Internal Server Error

Get variants of an item

Request

Responses