Create Bundle Offer

POST

https://api.zid.sa/v1/managers/store/discounts/bundle-offers

Creates a new bundle offer for the store.

🔑Scopes

third_bundle_offers_write - Bundle Offers Write

Authentication is partner OAuth Bearer authentication. A partner application should send Authorization: Bearer token and does not need X-MANAGER-TOKEN.

Also, Create specifically checks the products.bundle_offers package feature; the other three write endpoints do not.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Bodyapplication/json

🟠401Unauthorized

🔴500Internal Server error

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.zid.sa/v1/managers/store/discounts/bundle-offers' \
--header 'Authorization: Bearer <partner-token>' \
--header 'Content-Type: application/json' \
--data '{
    "code": "bundle_offer",
    "name": {
        "en": "Buy 2 shirts, get 1 free",
        "ar": "اشترِ قميصين واحصل على واحد مجانًا"
    },
    "description": {
        "en": "Limited time",
        "ar": "لفترة محدودة"
    },
    "start_date": "2026-09-01",
    "end_date": "2026-09-30",
    "conditions_criteria": "all",
    "enabled": true,
    "auto_adding": true,
    "conditions": [
        {
            "field": "products_quantity",
            "operator": "greater_than_or_equal",
            "value": 2,
            "applies_to": "product",
            "product_ids": [
                "1f0c8a2e-6b41-4f0a-9d2c-77a1b3e5c904"
            ]
        }
    ],
    "actions": [
        {
            "field": "products",
            "type": "percentage",
            "value": 100,
            "products_quantity": 1,
            "applies_to": "product",
            "product_ids": [
                "3a7d5b19-2c88-4e6f-b1a0-5d9e2f4c7601"
            ],
            "free_item_selection_strategy": "lowest"
        }
    ]
}'

Response Example

200 - Example 1

{
    "status": "object",
    "discount_rule": {
        "id": "9f2c1d80-4a3b-4c11-8e77-2b6d5a0f3e14",
        "name": {
            "en": "Buy 2 shirts, get 1 free",
            "ar": "اشترِ قميصين واحصل على واحد مجانًا"
        },
        "description": {
            "en": "Limited time",
            "ar": "لفترة محدودة"
        },
        "code": "bundle_offer",
        "conditions": [
            {
                "field": "products_quantity",
                "operator": "greater_than_or_equal",
                "value": 2,
                "applies_to": "product",
                "product_ids": [
                    "1f0c8a2e6b414f0a9d2c77a1b3e5c904"
                ],
                "category_ids": [
                    "12345"
                ],
                "products": [],
                "categories": null
            }
        ],
        "actions": [
            {
                "field": "products",
                "type": "percentage",
                "value": 100,
                "products_quantity": 1,
                "applies_to": "product",
                "product_ids": [
                    "3a7d5b192c884e6fb1a05d9e2f4c7601"
                ],
                "category_ids": [
                    "12345"
                ],
                "free_item_selection_strategy": "lowest",
                "products": [],
                "categories": null
            }
        ],
        "conditions_criteria": "all",
        "uses_total": 100,
        "uses_customer": 1,
        "enabled": true,
        "auto_adding": true,
        "status_code": "active",
        "start_date": "2026-09-01",
        "end_date": "2026-09-30",
        "meta": {
            "auto_add_products": true
        },
        "channel": null,
        "channel_name": null
    },
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

Modified at 2026-08-19 10:24:30

View Bundle Offer

Update Bundle Offer