--- updatedAt: 2025-09-03T06:03:02.000Z agentTools: projectIndex: https://docs.deducto.io/llms.txt --- # Verify expected promotions # OpenAPI definition ```json { "openapi": "3.0.0", "info": { "title": "Deducto API", "version": "1.0.0", "description": "Deducto backend management API and storefront integration endpoints" }, "servers": [ { "url": "https://api.use.deducto.io", "description": "US East server" }, { "url": "https://api.usw.deducto.io", "description": "US West server" }, { "url": "https://api.euc.deducto.io", "description": "EU server" }, { "url": "https://api.au.deducto.io", "description": "Asia Pacific server" } ], "security": [ { "BearerAuth": [] } ], "components": { "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "JWT token or API key for authentication. Include as 'Bearer ' in the Authorization header." } } }, "paths": { "/v1/checkout/{projectId}/verify-expected": { "post": { "tags": [ "Checkout" ], "summary": "Verify expected promotions", "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The project ID" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "couponCodes": { "type": "array", "items": { "type": "string", "minLength": 1, "description": "A coupon code" } }, "declinedPromotionIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "default": [] }, "expectedPromotions": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" } }, "required": [ "promotionId", "versionId" ] } }, "allowAnonymousSales": { "type": "boolean", "description": "Defaults to `false`" }, "cart": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "channel": { "type": "string", "nullable": true }, "shipping": { "type": "object", "properties": { "methods": { "type": "array", "items": { "type": "object", "properties": { "methodCode": { "type": "string", "minLength": 1 }, "originalPrice": { "type": "string", "description": "String formatted monetary amount using '.' as the separator, with decimals matching the currency's minor unit (e.g. '25.00' for USD, '2500' for JPY)." }, "handle": { "type": "string", "nullable": true } }, "required": [ "methodCode", "originalPrice" ] } } }, "default": { "methods": [] }, "required": [ "methods" ] }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "nullable": true } ], "description": "Attribute values may be strings, numbers, booleans, arrays of strings, or null when a value is unset." }, "description": "Flexible key-value attributes for storefront products and carts.", "example": { "color": "navy", "stockQuantity": 42, "tags": [ "featured", "clearance" ], "notes": null } }, "cartItems": { "type": "array", "items": { "type": "object", "properties": { "productData": { "type": "object", "properties": { "productId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 }, "originalPrice": { "type": "string", "description": "String formatted monetary amount using '.' as the separator, with decimals matching the currency's minor unit (e.g. '25.00' for USD, '2500' for JPY)." }, "salePrice": { "type": "string", "nullable": true, "description": "String formatted monetary amount using '.' as the separator, with decimals matching the currency's minor unit (e.g. '25.00' for USD, '2500' for JPY)." }, "isOnSale": { "type": "boolean" }, "variantId": { "type": "string", "nullable": true }, "attributes": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } }, { "nullable": true } ], "description": "Attribute values may be strings, numbers, booleans, arrays of strings, or null when a value is unset." }, "description": "Flexible key-value attributes for storefront products and carts.", "example": { "color": "navy", "stockQuantity": 42, "tags": [ "featured", "clearance" ], "notes": null } } }, "required": [ "productId", "name", "originalPrice", "attributes" ] }, "qty": { "type": "integer", "minimum": 0, "exclusiveMinimum": true } }, "required": [ "productData", "qty" ] } }, "customer": { "type": "object", "properties": { "email": { "type": "string", "nullable": true, "format": "email" }, "countryId": { "type": "string", "nullable": true, "minLength": 2, "maxLength": 2 } }, "description": "Customer details are required when `allowAnonymousSales` is not explicitly set to `true`" } }, "required": [ "currency", "attributes", "cartItems" ] } }, "required": [ "couponCodes", "expectedPromotions", "cart" ], "description": "Request schema for verifying expected promotions", "title": "Verify Expected Request" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "promotions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "promotionId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "exclusive": { "type": "boolean" }, "triggeringCouponCodes": { "type": "array", "items": { "type": "string" } } }, "required": [ "promotionId", "versionId", "name", "exclusive", "triggeringCouponCodes" ] } }, "appliedPromotions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "promotionId": { "type": "string" }, "versionId": { "type": "string" } }, "required": [ "promotionId", "versionId" ] } }, "rejectedPromotions": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "promotionId": { "type": "string" }, "versionId": { "type": "string" }, "rejectionReason": { "type": "string", "enum": [ "UnsupportedCurrency", "TriggerConditionsNotMet", "Exclusivity", "Stopped", "NoApplicableCartItems", "NoSuccessfullyMatchedCoupons", "NoAllowedCoupons", "Declined" ] } }, "required": [ "promotionId", "versionId", "rejectionReason" ] }, { "type": "object", "properties": { "promotionId": { "type": "string" }, "versionId": { "type": "string" }, "rejectionReason": { "type": "string", "enum": [ "PromotionUsageExceeded", "PromotionPerCustomerUsageExceeded" ] }, "usageCountLimit": { "type": "number" } }, "required": [ "promotionId", "versionId", "rejectionReason" ] }, { "type": "object", "properties": { "promotionId": { "type": "string" }, "versionId": { "type": "string" }, "rejectionReason": { "type": "string", "enum": [ "AppliedPromotionsLimitReached" ] }, "appliedPromotionsLimit": { "type": "number" } }, "required": [ "promotionId", "versionId", "rejectionReason" ] } ] } }, "cartItemPromotions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "promotionId": { "type": "string" }, "versionId": { "type": "string" }, "discountAmount": { "type": "string" }, "discountAmountUnrounded": { "type": "string" }, "discountAmountRoundingDelta": { "type": "string" } }, "required": [ "promotionId", "versionId", "discountAmount", "discountAmountUnrounded", "discountAmountRoundingDelta" ] }, "description": "Total discount amounts for a promotion applied to cart items. Shipping promotions are excluded." }, "couponMatchResults": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "couponCode": { "type": "string" }, "triggeredPromotions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "promotionId": { "type": "string", "format": "uuid" }, "usageExceeded": { "type": "boolean" } }, "required": [ "promotionId", "usageExceeded" ] } }, "valid": { "type": "boolean", "enum": [ true ] }, "applied": { "type": "boolean" } }, "required": [ "couponCode", "triggeredPromotions", "valid", "applied" ] }, { "type": "object", "properties": { "couponCode": { "type": "string" }, "triggeredPromotions": { "type": "object", "additionalProperties": { "type": "object", "properties": { "promotionId": { "type": "string", "format": "uuid" }, "usageExceeded": { "type": "boolean" } }, "required": [ "promotionId", "usageExceeded" ] } }, "valid": { "type": "boolean", "enum": [ false ] }, "invalidReason": { "type": "string", "enum": [ "UsageExceeded", "NotFound" ] } }, "required": [ "couponCode", "triggeredPromotions", "valid", "invalidReason" ] } ] } }, "resolvedCart": { "type": "object", "properties": { "currency": { "type": "string", "enum": [ "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UYW", "UZS", "VED", "VES", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" ] }, "originalSubtotal": { "type": "string", "minLength": 1 }, "discountedSubtotal": { "type": "string", "minLength": 1 }, "cartItems": { "type": "array", "items": { "type": "object", "properties": { "productId": { "type": "string", "minLength": 1 }, "variantId": { "type": "string", "minLength": 1 }, "originalSubtotal": { "type": "string", "minLength": 1 }, "discountedSubtotal": { "type": "string", "minLength": 1 }, "discountSteps": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" }, "subtotalBefore": { "type": "string", "minLength": 1 }, "discountAmount": { "type": "string", "minLength": 1 }, "subtotalAfter": { "type": "string", "minLength": 1 }, "subtotalAfterUnrounded": { "type": "string", "minLength": 1 }, "subtotalAfterRoundingDelta": { "type": "string", "minLength": 1 }, "extraParameters": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "promotionId", "versionId", "subtotalBefore", "discountAmount", "subtotalAfter", "subtotalAfterUnrounded", "subtotalAfterRoundingDelta", "extraParameters" ], "additionalProperties": false } } }, "required": [ "productId", "originalSubtotal", "discountedSubtotal", "discountSteps" ], "additionalProperties": false } }, "promotionalCartItems": { "type": "array", "items": { "type": "object", "properties": { "promotionId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" }, "productId": { "type": "string", "minLength": 1 }, "qty": { "type": "number" } }, "required": [ "promotionId", "versionId", "productId", "qty" ], "additionalProperties": false } }, "shipping": { "type": "object", "properties": { "methods": { "type": "array", "items": { "type": "object", "properties": { "methodCode": { "type": "string", "minLength": 1, "description": "A unique code representing a shipping method." }, "originalPrice": { "type": "string", "minLength": 1 }, "discountedPrice": { "type": "string", "minLength": 1 }, "bestDiscount": { "type": "object", "nullable": true, "properties": { "promotionId": { "type": "string", "format": "uuid" }, "versionId": { "type": "string", "format": "uuid" }, "subtotalBefore": { "type": "string", "minLength": 1 }, "discountAmount": { "type": "string", "minLength": 1 }, "subtotalAfter": { "type": "string", "minLength": 1 }, "subtotalAfterUnrounded": { "type": "string", "minLength": 1 }, "subtotalAfterRoundingDelta": { "type": "string", "minLength": 1 }, "extraParameters": { "type": "object", "additionalProperties": { "nullable": true } } }, "required": [ "promotionId", "versionId", "subtotalBefore", "discountAmount", "subtotalAfter", "subtotalAfterUnrounded", "subtotalAfterRoundingDelta", "extraParameters" ], "additionalProperties": false }, "handle": { "type": "string" } }, "required": [ "methodCode", "originalPrice", "discountedPrice", "bestDiscount" ], "additionalProperties": false } } }, "required": [ "methods" ], "additionalProperties": false }, "customer": { "type": "object", "properties": { "email": { "type": "string", "nullable": true, "format": "email" }, "countryId": { "type": "string", "nullable": true, "minLength": 2, "maxLength": 2 } } } }, "required": [ "currency", "originalSubtotal", "discountedSubtotal", "cartItems", "promotionalCartItems", "shipping", "customer" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "expectationsWereMet": { "type": "boolean" } }, "required": [ "promotions", "appliedPromotions", "rejectedPromotions", "cartItemPromotions", "couponMatchResults", "resolvedCart", "warnings", "expectationsWereMet" ], "description": "Response schema for verifying expected promotions", "title": "Verify Expected Response" } } } } } } } } } ```