Themes built on the Twig templating engine are now deprecated and require migration to Vitrin to ensure continued support and compatibility with Zid.

List Bundle Offers

GET

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

This endpoint retrieves all available bundle offers for the store. Bundle offers are special promotions where customers can get a discount if they buy a specific bundle of products.

Bundle offers can now apply to specific products, categories, or all products using the new applies_to field. Additionally, you can now exclude on-sale products using the exclude_on_sale_products flag in both conditions and actions.

🔑Scopes

bundle_offers.read - Bundle Offers Read

Request

Query Params

Header Params

Body Params application/json

Example

[
    {
        "field": "products",
        "type": "fixed",
        "value": 99,
        "products_quantity": 1,
        "applies_to": "product",
        "product_ids": [
            "2b432b8a776d46f2853afc7ee634ff2c"
        ]
    }
]

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.zid.sa/v1/managers/store/discounts/bundle-offers?code&start_date&end_date&order_by&sort_by&page&per_page&search_term&status&type' \
--header 'Authorization: {{Autherization}}' \
--header 'X-Manager-Token: {{Access-Token}}' \
--header 'Accept-Language: en' \
--header 'Currency: SAR' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "field": "products",
        "type": "fixed",
        "value": 99,
        "products_quantity": 1,
        "applies_to": "product",
        "product_ids": [
            "2b432b8a776d46f2853afc7ee634ff2c"
        ]
    }
]'

Responses

🟢200Returns a list of all bundle offers for the store.

application/json

Body

Example

{
    "status": "string",
    "discount_rules": [
        {
            "id": "02ed8742-354d-4b44-8f3f-39766081c12e",
            "name": {
                "en": "string",
                "ar": "string"
            },
            "description": {
                "en": "string",
                "ar": "string"
            },
            "code": "bundle_offer",
            "conditions": [
                {
                    "field": "products_quantity",
                    "operator": ">=",
                    "value": 1,
                    "applies_to": "string",
                    "product_ids": [
                        "string"
                    ]
                }
            ],
            "actions": [
                {
                    "type": "percentage",
                    "field": "products",
                    "value": 100,
                    "applies_to": "string",
                    "product_ids": [
                        "string"
                    ],
                    "products_quantity": 1
                }
            ],
            "conditions_criteria": "all",
            "uses_total": 0,
            "uses_customer": 0,
            "enabled": true,
            "auto_adding": true,
            "status_code": "active",
            "start_date": "2019-08-24",
            "end_date": "2019-08-24",
            "meta": {
                "property1": "string",
                "property2": "string"
            },
            "channel": "catalog",
            "channel_name": {
                "en": "string",
                "ar": "string"
            }
        }
    ],
    "page": 1,
    "next_page": 0,
    "last_page": 1,
    "total": 50,
    "message": {
        "type": "string",
        "code": "string",
        "name": "string",
        "description": "string"
    }
}

🟠401Unauthorized

🔴500Internal Server error

Modified at 2026-02-06 07:47:21

Bundle Offers

Loyalty Program