Validate Promotions

❗️ Deprecated

This endpoint represents the deprecated version of the API responsible for qualification, and we do not recommend using it. The new Qualifications API introduces additional features and improvements while maintaining backward compatibility. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.

❗️ Limitation

Only the first 150 most recent promotion tiers are checked for eligibility. Older promotion tiers are ignored and not returned.

Use this method to get valid promotions for a given customer and order.

Advanced validation filters

You can narrow down a validation to a specific promotion ID or tier metadata.

POST /v1/promotions/validation

cURL

Example

curl --request POST \ --url https://{cluster}.voucherify.io/v1/promotions/validation \ --header 'Content-Type: application/json' \ --header 'X-App-Id: <api-key>' \ --header 'X-App-Token: <api-key>' \ --data ' { "customer": { "source_id": "source-id", "metadata": { "key": "value" } }, "options": { "expand": [ "category" ] }, "order": { "amount": 10000, "items": [ { "product_id": "product-id", "quantity": "1", "price": 10000, "related_object": "product", "product": { "metadata": { "key": "value" } } } ] }, "metadata": { "key": "value" } } '

200

Customer Rules Only

{ "valid": true, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "promotions": [ { "valid": true, "applicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 9351000, "initial_amount": 72100, "items_discount_amount": 9340400, "total_discount_amount": 9340400, "total_amount": 10600, "items_applied_discount_amount": 9340400, "total_applied_discount_amount": 9340400, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "price": 3100, "subtotal_amount": 3100, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 23, "discount_quantity": 22, "initial_quantity": 1, "amount": 39100, "discount_amount": 37400, "initial_amount": 1700, "applied_discount_amount": 37400, "price": 1700, "subtotal_amount": 1700, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 222, "discount_quantity": 222, "initial_quantity": 1, "amount": 333000, "discount_amount": 333000, "initial_amount": 1500, "applied_discount_amount": 333000, "price": 1500, "subtotal_amount": 0, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 111, "discount_quantity": 111, "initial_quantity": 1, "amount": 6660000, "discount_amount": 6660000, "initial_amount": 60000, "applied_discount_amount": 6660000, "price": 60000, "subtotal_amount": 0, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } }, { "object": "order_item", "product_id": "prod_0bae2dc5a090fd0184", "sku_id": "sku_0bae3b28f610fd0da1", "quantity": 11, "discount_quantity": 11, "initial_quantity": 0, "amount": 2310000, "discount_amount": 2310000, "initial_amount": 0, "applied_discount_amount": 2310000, "price": 210000, "subtotal_amount": 0, "product": { "id": "prod_0bae2dc5a090fd0184", "source_id": "first_product", "name": "Samsung Phone 1", "price": 220000 }, "sku": { "id": "sku_0bae3b28f610fd0da1", "source_id": "first_product_sku_1", "sku": "Samsung phone 256GB", "price": 210000 } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_ByIIAHC1Mz9ouJsitzAWsush", "name": "Multiple", "discount": { "type": "UNIT", "effect": "ADD_MANY_ITEMS", "units": [ { "effect": "ADD_MISSING_ITEMS", "unit_off": 11, "unit_type": "sku_0bae3b28f610fd0da1", "sku": { "id": "sku_0bae3b28f610fd0da1", "source_id": "first_product_sku_1", "sku": "Samsung phone 256GB" }, "product": { "id": "prod_0bae2dc5a090fd0184", "source_id": "first_product", "name": "Samsung Phone 1" } }, { "effect": "ADD_NEW_ITEMS", "unit_off": 22, "unit_type": "sku_0b7d7dfb090be5c619", "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1" }, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1" } }, { "effect": "ADD_MISSING_ITEMS", "unit_off": 111, "unit_type": "prod_0b7d7c4e814be5c502", "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12" } }, { "effect": "ADD_MISSING_ITEMS", "unit_off": 222, "unit_type": "prod_0b72b0bd64d198e3ae", "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage" } } ] }, "campaign": { "id": "camp_JtoaZ8Qgpf6FkMAy2wWiOJWH", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 1, "discount_amount": 9340400, "applied_discount_amount": 9340400, "metadata": {}, "object": "promotion_tier" }, { "valid": true, "applicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 9522100, "initial_amount": 72100, "items_discount_amount": 9450000, "total_discount_amount": 9450000, "total_amount": 72100, "items_applied_discount_amount": 9450000, "total_applied_discount_amount": 9450000, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "price": 3100, "subtotal_amount": 3100, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 1, "amount": 1700, "price": 1700, "subtotal_amount": 1700, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 1, "amount": 1500, "price": 1500, "subtotal_amount": 1500, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 1, "amount": 60000, "price": 60000, "subtotal_amount": 60000, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } }, { "object": "order_item", "product_id": "prod_0bae2dc5a090fd0184", "sku_id": "sku_0bae3b28f610fd0da1", "quantity": 45, "discount_quantity": 45, "initial_quantity": 0, "amount": 9450000, "discount_amount": 9450000, "initial_amount": 0, "applied_discount_amount": 9450000, "price": 210000, "subtotal_amount": 0, "product": { "id": "prod_0bae2dc5a090fd0184", "source_id": "first_product", "name": "Samsung Phone 1", "price": 220000 }, "sku": { "id": "sku_0bae3b28f610fd0da1", "source_id": "first_product_sku_1", "sku": "Samsung phone 256GB", "price": 210000 } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_ZWkx6R0I1Ts3N9HL4kfTdxOm", "name": "Add new SKU", "discount": { "type": "UNIT", "effect": "ADD_NEW_ITEMS", "unit_off": 45, "unit_type": "sku_0bae3b28f610fd0da1", "sku": { "id": "sku_0bae3b28f610fd0da1", "source_id": "first_product_sku_1", "sku": "Samsung phone 256GB" }, "product": { "id": "prod_0bae2dc5a090fd0184", "source_id": "first_product", "name": "Samsung Phone 1" } }, "campaign": { "id": "camp_40LC42P5NFbkkD4RWoJ4btks", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 4, "discount_amount": 9450000, "applied_discount_amount": 9450000, "metadata": {}, "object": "promotion_tier" }, { "valid": true, "applicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 109500, "initial_amount": 72100, "items_discount_amount": 39100, "total_discount_amount": 39100, "total_amount": 70400, "items_applied_discount_amount": 39100, "total_applied_discount_amount": 39100, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "price": 3100, "subtotal_amount": 3100, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 23, "discount_quantity": 23, "initial_quantity": 1, "amount": 39100, "discount_amount": 39100, "initial_amount": 1700, "applied_discount_amount": 39100, "price": 1700, "subtotal_amount": 0, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 1, "amount": 1500, "price": 1500, "subtotal_amount": 1500, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 1, "amount": 60000, "price": 60000, "subtotal_amount": 60000, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_NcdD0zLo6FUhKWpNrNuP3Pte", "name": "Add missing SKU", "discount": { "type": "UNIT", "effect": "ADD_MISSING_ITEMS", "unit_off": 23, "unit_type": "sku_0b7d7dfb090be5c619", "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1" }, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1" } }, "campaign": { "id": "camp_40LC42P5NFbkkD4RWoJ4btks", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 3, "discount_amount": 39100, "applied_discount_amount": 39100, "metadata": {}, "object": "promotion_tier" }, { "valid": true, "applicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 76100, "initial_amount": 72100, "items_discount_amount": 4000, "total_discount_amount": 4000, "total_amount": 72100, "items_applied_discount_amount": 4000, "total_applied_discount_amount": 4000, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "price": 3100, "subtotal_amount": 3100, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 1, "amount": 1700, "price": 1700, "subtotal_amount": 1700, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 1, "amount": 1500, "price": 1500, "subtotal_amount": 1500, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 1, "amount": 60000, "price": 60000, "subtotal_amount": 60000, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } }, { "object": "order_item", "product_id": "prod_0b72b00ffed198e344", "quantity": 8, "discount_quantity": 8, "initial_quantity": 0, "amount": 4000, "discount_amount": 4000, "initial_amount": 0, "applied_discount_amount": 4000, "price": 500, "subtotal_amount": 0, "product": { "id": "prod_0b72b00ffed198e344", "source_id": "roses_1", "name": "Bouquet - Romantic Roses", "price": 500 } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_nGr1SWuy9vduABkbbJkl8cHb", "name": "Add new order items", "banner": "Add Romantic Roses", "discount": { "type": "UNIT", "effect": "ADD_NEW_ITEMS", "unit_off": 8, "unit_type": "prod_0b72b00ffed198e344", "product": { "id": "prod_0b72b00ffed198e344", "source_id": "roses_1", "name": "Bouquet - Romantic Roses" } }, "campaign": { "id": "camp_40LC42P5NFbkkD4RWoJ4btks", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 2, "discount_amount": 4000, "applied_discount_amount": 4000, "metadata": {}, "object": "promotion_tier" }, { "valid": true, "applicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 78100, "initial_amount": 72100, "items_discount_amount": 7500, "total_discount_amount": 7500, "total_amount": 70600, "items_applied_discount_amount": 7500, "total_applied_discount_amount": 7500, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "price": 3100, "subtotal_amount": 3100, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 1, "amount": 1700, "price": 1700, "subtotal_amount": 1700, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 5, "discount_quantity": 5, "initial_quantity": 1, "amount": 7500, "discount_amount": 7500, "initial_amount": 1500, "applied_discount_amount": 7500, "price": 1500, "subtotal_amount": 0, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 1, "amount": 60000, "price": 60000, "subtotal_amount": 60000, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_R50x0A66V6jmPhM7YYOcFZfL", "name": "Add missing order items", "banner": "Add Boho Vintage", "discount": { "type": "UNIT", "effect": "ADD_MISSING_ITEMS", "unit_off": 5, "unit_type": "prod_0b72b0bd64d198e3ae", "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage" } }, "campaign": { "id": "camp_40LC42P5NFbkkD4RWoJ4btks", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 1, "discount_amount": 7500, "applied_discount_amount": 7500, "metadata": {}, "object": "promotion_tier" }, { "valid": true, "applicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 72100, "total_amount": 72100, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "price": 3100, "subtotal_amount": 3100, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 1, "amount": 1700, "price": 1700, "subtotal_amount": 1700, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 1, "amount": 1500, "price": 1500, "subtotal_amount": 1500, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 1, "amount": 60000, "price": 60000, "subtotal_amount": 60000, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } }, { "object": "order_item", "product_id": "prod_5h1pp1ng", "quantity": 1, "discount_quantity": 1, "initial_quantity": 0, "product": { "id": "prod_5h1pp1ng", "source_id": "5h1pp1ng", "name": "Shipping" } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_jp2l6wRcTL4cARG5E8XRo42A", "name": "Get", "banner": "Free shipping", "discount": { "type": "UNIT", "effect": "ADD_MISSING_ITEMS", "unit_off": 1, "unit_type": "prod_5h1pp1ng", "product": { "id": "prod_5h1pp1ng", "source_id": "5h1pp1ng", "name": "Shipping" } }, "campaign": { "id": "camp_wCEdu2igBcyv7CNna9ughGKc", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 1, "metadata": { "has_budget": true, "audience_restricted": false }, "object": "promotion_tier" }, { "valid": true, "applicable_to": { "data": [ { "object": "products_collection", "id": "pc_a11pr0dUc75", "price": 800, "effect": "APPLY_TO_EVERY" }, { "object": "product", "id": "prod_0a9f9ab4ab019a42d5", "source_id": "prod_0a9f9ab4ab019a42d5", "price": 800, "effect": "APPLY_TO_EVERY" }, { "object": "product", "id": "prod_0a9f9aeddb019a42db", "source_id": "prod_0a9f9aeddb019a42db", "price": 800, "effect": "APPLY_TO_EVERY" }, { "object": "sku", "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "product_id": "prod_0b7d7dfb05cbe5c616", "product_source_id": "Books", "price": 800, "effect": "APPLY_TO_EVERY" }, { "object": "product", "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "price": 800, "effect": "APPLY_TO_EVERY" }, { "object": "product", "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "price": 800, "effect": "APPLY_TO_EVERY" } ], "total": 6, "data_ref": "data", "object": "list" }, "inapplicable_to": { "data": [], "total": 0, "data_ref": "data", "object": "list" }, "tracking_id": "track_OWyBVb1mg1oMY1lADmgwuXCw/qYHp5h0", "order": { "amount": 72100, "items_discount_amount": 67300, "total_discount_amount": 67300, "total_amount": 4800, "items_applied_discount_amount": 67300, "total_applied_discount_amount": 67300, "items": [ { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "discount_amount": 2100, "applied_discount_amount": 2100, "price": 2900, "subtotal_amount": 800, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0a9f9aeddb019a42db", "quantity": 1, "amount": 3100, "discount_amount": 2300, "applied_discount_amount": 2300, "price": 3100, "subtotal_amount": 800, "product": { "id": "prod_0a9f9aeddb019a42db", "name": "Blue T-Shirt", "price": 3100 } }, { "object": "order_item", "product_id": "prod_0a9f9ab4ab019a42d5", "quantity": 1, "amount": 2900, "discount_amount": 2100, "applied_discount_amount": 2100, "price": 2900, "subtotal_amount": 800, "product": { "id": "prod_0a9f9ab4ab019a42d5", "name": "Red T-Shirt", "price": 2900 } }, { "object": "order_item", "product_id": "prod_0b7d7dfb05cbe5c616", "sku_id": "sku_0b7d7dfb090be5c619", "quantity": 1, "amount": 1700, "discount_amount": 900, "applied_discount_amount": 900, "price": 1700, "subtotal_amount": 800, "product": { "id": "prod_0b7d7dfb05cbe5c616", "source_id": "Books", "name": "Comic Books1", "price": 2100 }, "sku": { "id": "sku_0b7d7dfb090be5c619", "source_id": "ComicBook_1", "sku": "Comics1", "price": 1700 } }, { "object": "order_item", "product_id": "prod_0b72b0bd64d198e3ae", "quantity": 1, "amount": 1500, "discount_amount": 700, "applied_discount_amount": 700, "price": 1500, "subtotal_amount": 800, "product": { "id": "prod_0b72b0bd64d198e3ae", "source_id": "vase_1", "name": "Vase - Boho Vintage", "price": 1500 } }, { "object": "order_item", "product_id": "prod_0b7d7c4e814be5c502", "quantity": 1, "amount": 60000, "discount_amount": 59200, "applied_discount_amount": 59200, "price": 60000, "subtotal_amount": 800, "product": { "id": "prod_0b7d7c4e814be5c502", "source_id": "prod_1", "name": "Apple iPhone 12", "price": 60000 } } ], "metadata": { "payment_mean": [ "credit-card" ] }, "customer_id": null, "referrer_id": null, "object": "order" }, "id": "promo_WEloFBBJ8JJDCxrtR1FPy6t1", "name": "Get Amount Off", "banner": "Every product is worth 8", "discount": { "type": "FIXED", "effect": "APPLY_TO_ITEMS" }, "campaign": { "id": "camp_Ds2u0MSFGuKhDuR3jEa5dHBx", "start_date": null, "expiration_date": null, "active": true, "object": "campaign" }, "hierarchy": 2, "discount_amount": 67300, "applied_discount_amount": 67300, "metadata": { "has_budget": true, "audience_restricted": false }, "object": "promotion_tier" } ] }

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Query Parameters

audienceRulesOnly · string

If you add a query param AudienceRulesOnly=true, the request will be validated against customer-related rules only, the rest of attached limits and rules will be ignored.

filters · Promotion filters · object

Filter conditions. Promotion filter conditions.

Show child attributes

Body

application/json

Provide the customer and order context.

Request schema model for validating a promotion using POST v1/promotions/validation.

customer · Customer ID · object

Customer's information.

Customer ID

Customer Source ID

Customer

Show child attributes

order · Order ID · object

Order information.

Order ID

Order Source ID

Orders Create Request Body

Show child attributes

metadata · object

A set of key/value pairs that you can send in the request body to check against vouchers requiring redemption metadata validation rules to be satisfied. The validation runs against rules that are defined through the Create Validation Rules endpoint or via the Dashboard; in the Advanced Rule Builder → Advanced → Redemption metadata satisfy or Basic Builder → Attributes match → REDEMPTION METADATA. Read more.

options · object

Configure parameters returned in the response.

Show child attributes

Response

200 - application/json

Returns a list of valid promotions for a given context (customer and order). You can then choose which promotion to apply, i.e. the highest discount amount.

Response schema model for validating a promotion using POST v1/promotions/validation.

valid · boolean

Indicates whether the promotion is valid within the context of the parameters provided in the request body and filters in the query parameters.

tracking_id · string

Hashed customer source ID.

promotions · Validate Promotion · object[]

Contains an array of promotion tier objects.

Show child attributes