Retrieve all Bundle Offers

GET

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

Coupons and 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.

🔑Scopes

bundle_offers.read - Bundle Offers Read

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.zid.sa/v1v1/managers/store/discounts/bundle-offers?code&start_date&end_date&order_by&sort_by&page&per_page&search_term&status&type' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'X-Manager-Token: eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=' \
--header 'Accept-Language;' \
--header 'Currency;'

Response Example

{
  "status": {},
  "discount_rules": [
    {
      "id": "652285f7-11af-41ca-85cb-b2b9a18b9137",
      "name": {
        "en": "Buy One, Get One Free",
        "ar": "اشتر واحدة واحصل على واحدة مجانًا"
      },
      "description": {
        "en": "When you purchase this product, you will receive a 50% discount on selected products.",
        "ar": "عند شرائك لهذا المنتج، ستحصل على خصم 50% على المنتجات المختارة."
      },
      "code": "2FOR1BUNDLE",
      "conditions": [
        {
          "field": "products_quantity",
          "value": 1,
          "operator": ">=",
          "product_ids": [
            "string"
          ],
          "products": {
            "next": "string",
            "previous": "string",
            "count": 0,
            "results": [
              {
                "is_external_product": false,
                "id": null,
                "parent_id": null,
                "product_class": "string",
                "sku": "string",
                "barcode": "string",
                "name": {
                  "ar": "string",
                  "en": "string"
                },
                "slug": "string",
                "price": 0,
                "short_description": null,
                "sale_price": 50,
                "formatted_price": "10$",
                "formatted_sale_price": "8$",
                "currency": "string",
                "currency_symbol": "string",
                "attributes": [
                  {}
                ],
                "categories": [
                  {}
                ],
                "display_order": null,
                "has_options": false,
                "has_fields": true,
                "images": [
                  {}
                ],
                "is_draft": true,
                "quantity": null,
                "is_infinite": true,
                "html_url": "string",
                "weight": {
                  "value": 100,
                  "unit": "kg"
                },
                "keywords": [
                  {}
                ],
                "requires_shipping": true,
                "is_taxable": false,
                "structure": "string",
                "seo": {
                  "title": {
                    "ar": "string",
                    "en": "string"
                  },
                  "description": {}
                },
                "rating": {
                  "average": 3.9,
                  "total_count": 400,
                  "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": 0,
                "purchase_restrictions": {
                  "min_quantity_per_cart": null,
                  "max_quantity_per_cart": null,
                  "availability_period_start": null,
                  "availability_period_end": null,
                  "sale_price_period_start": "2024-09-18T21:00:00.000000Z",
                  "sale_price_period_end": "2024-09-19T20:59:59.000000Z"
                },
                "metafields": null,
                "meta": {},
                "badge": {
                  "body": {
                    "ar": "string",
                    "en": "string"
                  },
                  "icon": {
                    "code": "string"
                  }
                },
                "related_products_settings": "string",
                "related_products_title": null,
                "variants": [
                  {}
                ],
                "options": [
                  {}
                ],
                "cost": 0,
                "is_published": true,
                "waiting_customers_count": null,
                "description": {},
                "custom_user_input_fields": [
                  {}
                ],
                "custom_option_fields": [
                  {}
                ],
                "related_products": [
                  {}
                ],
                "next_product": null,
                "previous_product": null,
                "group_products": [
                  {
                    "id": "143",
                    "item": {
                      "id": "string",
                      "product_class": null,
                      "sku": "string",
                      "barcode": "string",
                      "parent_id": null,
                      "name": {
                        "ar": "string",
                        "en": "string"
                      },
                      "slug": "string",
                      "price": 0,
                      "short_description": null,
                      "sale_price": null,
                      "formatted_price": "string",
                      "formatted_sale_price": null,
                      "currency": "string",
                      "currency_symbol": "string",
                      "attributes": [
                        {}
                      ],
                      "categories": [
                        {}
                      ],
                      "display_order": null,
                      "has_options": true,
                      "has_fields": true,
                      "images": [
                        {}
                      ],
                      "is_draft": true,
                      "quantity": null,
                      "is_infinite": true,
                      "html_url": "string",
                      "weight": {
                        "value": null,
                        "unit": "string"
                      },
                      "keywords": [
                        {}
                      ],
                      "requires_shipping": true,
                      "is_taxable": true,
                      "structure": "string",
                      "seo": {
                        "title": {
                          "ar": "string",
                          "en": "string"
                        },
                        "description": {}
                      },
                      "rating": {
                        "average": 4.1,
                        "total_count": 50,
                        "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": 0,
                      "purchase_restrictions": {
                        "min_quantity_per_cart": null,
                        "max_quantity_per_cart": null,
                        "availability_period_start": null,
                        "availability_period_end": null
                      },
                      "metafields": null,
                      "meta": null,
                      "badge": null,
                      "related_products_settings": "string",
                      "related_products_title": null,
                      "created_at": "string",
                      "updated_at": "string",
                      "options": [
                        {}
                      ],
                      "group_products": null,
                      "stocks": [
                        {
                          "id": "string",
                          "location": {
                            "id": "string",
                            "name": {},
                            "type": "string"
                          },
                          "available_quantity": null,
                          "is_infinite": false
                        }
                      ]
                    },
                    "origin_product_id": "string",
                    "item_id": "string",
                    "item_quantity": 0,
                    "in_stock": true
                  }
                ],
                "stocks": [
                  {
                    "id": "string",
                    "location": {
                      "id": "string",
                      "name": {
                        "ar": "string"
                      },
                      "type": "string"
                    },
                    "available_quantity": null,
                    "is_infinite": true
                  }
                ],
                "sold_products_count": null,
                "created_at": "string",
                "updated_at": "string"
              }
            ],
            "filters": {}
          }
        }
      ],
      "actions": [
        {
          "type": "percentage",
          "field": "products",
          "value": 50,
          "product_ids": [
            "string"
          ],
          "products_quantity": 1,
          "products": {
            "next": "string",
            "previous": "string",
            "count": 0,
            "results": [
              {
                "is_external_product": false,
                "id": null,
                "parent_id": null,
                "product_class": "string",
                "sku": "string",
                "barcode": "string",
                "name": {
                  "ar": "string",
                  "en": "string"
                },
                "slug": "string",
                "price": 0,
                "short_description": null,
                "sale_price": 50,
                "formatted_price": "10$",
                "formatted_sale_price": "8$",
                "currency": "string",
                "currency_symbol": "string",
                "attributes": [
                  {}
                ],
                "categories": [
                  {}
                ],
                "display_order": null,
                "has_options": false,
                "has_fields": true,
                "images": [
                  {}
                ],
                "is_draft": true,
                "quantity": null,
                "is_infinite": true,
                "html_url": "string",
                "weight": {
                  "value": 100,
                  "unit": "kg"
                },
                "keywords": [
                  {}
                ],
                "requires_shipping": true,
                "is_taxable": false,
                "structure": "string",
                "seo": {
                  "title": {
                    "ar": "string",
                    "en": "string"
                  },
                  "description": {}
                },
                "rating": {
                  "average": 3.9,
                  "total_count": 400,
                  "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": 0,
                "purchase_restrictions": {
                  "min_quantity_per_cart": null,
                  "max_quantity_per_cart": null,
                  "availability_period_start": null,
                  "availability_period_end": null,
                  "sale_price_period_start": "2024-09-18T21:00:00.000000Z",
                  "sale_price_period_end": "2024-09-19T20:59:59.000000Z"
                },
                "metafields": null,
                "meta": {},
                "badge": {
                  "body": {
                    "ar": "string",
                    "en": "string"
                  },
                  "icon": {
                    "code": "string"
                  }
                },
                "related_products_settings": "string",
                "related_products_title": null,
                "variants": [
                  {}
                ],
                "options": [
                  {}
                ],
                "cost": 0,
                "is_published": true,
                "waiting_customers_count": null,
                "description": {},
                "custom_user_input_fields": [
                  {}
                ],
                "custom_option_fields": [
                  {}
                ],
                "related_products": [
                  {}
                ],
                "next_product": null,
                "previous_product": null,
                "group_products": [
                  {
                    "id": "143",
                    "item": {
                      "id": "string",
                      "product_class": null,
                      "sku": "string",
                      "barcode": "string",
                      "parent_id": null,
                      "name": {
                        "ar": "string",
                        "en": "string"
                      },
                      "slug": "string",
                      "price": 0,
                      "short_description": null,
                      "sale_price": null,
                      "formatted_price": "string",
                      "formatted_sale_price": null,
                      "currency": "string",
                      "currency_symbol": "string",
                      "attributes": [
                        {}
                      ],
                      "categories": [
                        {}
                      ],
                      "display_order": null,
                      "has_options": true,
                      "has_fields": true,
                      "images": [
                        {}
                      ],
                      "is_draft": true,
                      "quantity": null,
                      "is_infinite": true,
                      "html_url": "string",
                      "weight": {
                        "value": null,
                        "unit": "string"
                      },
                      "keywords": [
                        {}
                      ],
                      "requires_shipping": true,
                      "is_taxable": true,
                      "structure": "string",
                      "seo": {
                        "title": {
                          "ar": "string",
                          "en": "string"
                        },
                        "description": {}
                      },
                      "rating": {
                        "average": 4.1,
                        "total_count": 50,
                        "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": 0,
                      "purchase_restrictions": {
                        "min_quantity_per_cart": null,
                        "max_quantity_per_cart": null,
                        "availability_period_start": null,
                        "availability_period_end": null
                      },
                      "metafields": null,
                      "meta": null,
                      "badge": null,
                      "related_products_settings": "string",
                      "related_products_title": null,
                      "created_at": "string",
                      "updated_at": "string",
                      "options": [
                        {}
                      ],
                      "group_products": null,
                      "stocks": [
                        {
                          "id": "string",
                          "location": {
                            "id": "string",
                            "name": {},
                            "type": "string"
                          },
                          "available_quantity": null,
                          "is_infinite": false
                        }
                      ]
                    },
                    "origin_product_id": "string",
                    "item_id": "string",
                    "item_quantity": 0,
                    "in_stock": true
                  }
                ],
                "stocks": [
                  {
                    "id": "string",
                    "location": {
                      "id": "string",
                      "name": {
                        "ar": "string"
                      },
                      "type": "string"
                    },
                    "available_quantity": null,
                    "is_infinite": true
                  }
                ],
                "sold_products_count": null,
                "created_at": "string",
                "updated_at": "string"
              }
            ],
            "filters": {}
          }
        }
      ],
      "conditions_criteria": "all",
      "uses_total": 100,
      "uses_customer": 1,
      "enabled": true,
      "auto_adding": true,
      "status_code": "expired",
      "start_date": "2022-06-01",
      "end_date": "2022-06-30",
      "meta": {
        "category_id": "387031",
        "auto_add_products": true
      }
    }
  ],
  "page": 1,
  "next_page": null,
  "last_page": 1,
  "total": 1,
  "message": {}
}

Request

Query Params

code

string

optional

A code to filter the bundle offers. Example: bundle_offer.

start_date

string <date>

optional

A date to filter the bundle offers by their start dates. Supports standard comparison operators like >=.

end_date

string <date>

optional

A date to filter the bundle offers by their end dates.

order_by

string

optional

A field to order the bundle offers by. Example: start_date.

sort_by

string

optional

A sort direction. Example: desc.

page

integer

optional

The page number for pagination.

per_page

integer

optional

The number of results per page.

search_term

string

optional

A term to search the bundle offers by their names.

status

string

optional

The status of the bundle offers. The possible values are: expired, disabled, unstarted, active.

type

string

optional

The type of bundle offer.

Header Params

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

X-Manager-Token

string

required

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6Imh3L2dGbmJmRnVCOUY4WW5WQ2s3RFE9PSIsInZhbHVlIjoiZklpRnJyVGV1OWcrZUJBNk44bVp5SjZzSS92V3czcTJjbnJ2dFYvenZ3SFBtWHNSMFU3ZEMzZ0ZJNnpucVE4Ui9rNFdicUduOGpKUlg1VXdGOFFIaVUzZjZyUUZybWx3R0tNY3orUmxoUUUxQ29wSkEyVDZTVnVYb2dlUXJSVzBYVkdESjBpS0xiN05Hbndzc2wzV2N0YitGM1NEdkk4ckZZOTZsTFdEL1ZQRlJJTE5FQmttZng2elpwL1RCeXFRdUd1U3JTc0FHV1kySS80RFJaWlIyZ3gwM2FsQVRFbkt3VWtFOUQyKzdGOD0iLCJtYWMiOiJmZDQ0YzM4ODE0OWQxOWRhYWU0NDhhYmIzYzQ1MDAxMDAzODZjZGM3ZGM4NGJhMGNkMDEyYWZlM2UzYjAxMTI4IiwidGFnIjoiIn0=

Accept-Language

enum<string>

optional

Preferred language for the response. Defaults to en if not specified.

Allowed values:

enar

Example:

Currency

string

required

The currency in which the data should be returned. This should be provided as an ISO 4217 currency code. For example, SAR for Saudi Riyal, USD for United States Dollar, KWD for Kuwaiti Dinar, etc.

Example:

SAR

Responses

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

application/json

Body

status

object

optional

Response status

discount_rules

array[object (DiscountRule) {15}]

optional

Array of the store's bundle discount rules

string

optional

Unique identifier of the discount rule

Example:

652285f7-11af-41ca-85cb-b2b9a18b9137

name

object

optional

description

object

optional

code

string

optional

The discount code the Customer inserts on the checkout page in order to activate the bundle offer.

Example:

2FOR1BUNDLE

conditions

array[object (DiscountRuleCondition) {5}]

optional

Conditions required to activate the discount rule

actions

array[object (DiscountRuleAction) {6}]

optional

Actions taken once conditions of the discount rule are met

conditions_criteria

string

optional

Criteria to meet for the conditions to apply (e.g., "all", "any")

Example:

all

uses_total

integer

optional

Total number of uses allowed for this discount rule.

Example:

100

uses_customer

integer

optional

Total number of uses allowed per customer for this discount rule.

Example:

enabled

boolean

optional

Activation Status of the discount rule, whether it's enabled or not

Example:

true

auto_adding

boolean

optional

Whether the discount rule is automatically added to the cart. If true, the discount rule will be automatically applied to the basket if its conditions are met.

Example:

true

status_code

string

optional

Current status code of the discount rule.

Example:

expired

start_date

string <date>

optional

Start date of the discount rule

Example:

2022-06-01

end_date

string <date>

optional

End date of the discount rule

Example:

2022-06-30