Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer’s current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Masivo","colors":{"primary":"#9333ea","light":"#c084fc","dark":"#9333ea"},"logo":{"light":"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/logo/light.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=d6c63ec91328f53e2881c4b8c6463002","dark":"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/logo/dark.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=4f3a37e246a4bdd211beae4f51571bea","href":"/"},"favicon":"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/favicon.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=d626565ed6bd780993b9f7d91f7ab1be","navbar":{"links":[{"href":"mailto:soporte@trade.ec?subject=Masivo Support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.masivo.ai"}},"footer":{"socials":{"x":"https://x.com/mintlify","github":"https://github.com/mintlify","linkedin":"https://www.linkedin.com/company/mintsearch"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Roadmap","icon":"map","href":"https://docs.masivo.ai/roadmap"},{"anchor":"Changelog","icon":"rocket","href":"https://docs.masivo.ai/changelog"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/2DgqGUej"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"trd","hasAudioNarration":false,"actualSubdomain":"trd","customDomains":["docs.masivo.ai"],"gitSource":{"type":"github","owner":"trade-ec","repo":"masivo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adf3604f325da4ba4e0af9e","collectionId":"b12cea4e-7fd3-4ec8-8c5c-2877b1cd2082","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adf3604f325da4ba4e0af9e"},"entitlements":{},"buildId":"6adfaf339f4f979a1a0e93c6","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API Reference","count":92},{"language":"default","tag":"Documentation","count":88},{"language":"default","tag":"Endpoints","count":72},{"language":"default","tag":"Guides","count":72},{"language":"default","tag":"Get Started","count":23},{"language":"default","tag":"Concepts","count":20},{"language":"default","tag":"Marketing Automation","count":19},{"language":"default","tag":"Customers","count":17},{"language":"default","tag":"CDP","count":17},{"language":"default","tag":"Integrations","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/events/redeem/preview/put","slug":"/api-reference/events/redeem/preview/put","pageMetadata":{"title":"Preview order","openapi":"PUT /events/redeem/preview","description":"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer's current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.","href":"/api-reference/events/redeem/preview/put"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer’s current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Preview order","openapi":"PUT /events/redeem/preview","description":"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer's current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.","href":"/api-reference/events/redeem/preview/put"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer's current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.","requestBody":"95255428-7aa7-41ca-bb62-d399fd534077","responses":{"200":"5073c5e5-bda4-4fa6-814d-2b74389f473e","422":"5eb9c667-fa00-4b6d-853c-a3cfda86292a"},"method":"put","type":"path","servers":["e171325b-53ae-45cf-854f-c3588a3e764a"],"security":["da9d8232-ebd9-4bac-b7ab-fd0880df2eb5"],"path":"/events/redeem/preview","baseUrlOptions":["https://app.masivo.ai/api/storefront/v1"],"title":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["customer_id","brand_id","order"],"properties":{"customer_id":{"type":"string","description":"The customer unique identifier in your system","isRequired":true,"uniqueKey":"customer_id","typeLabel":"string"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the order","isRequired":true,"uniqueKey":"brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the order","isRequired":true,"uniqueKey":"brand_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"brand_id","typeLabel":"string | null"},"order":{"type":"object","description":"The order to apply the rewards","required":["purchase_id","value","products","payment_method"],"properties":{"purchase_id":{"type":"string","description":"The id of a placed order in your system","isRequired":true,"uniqueKey":"order.purchase_id","typeLabel":"string"},"value":{"type":"number","description":"The order total or subtotal","example":20.95,"isRequired":true,"uniqueKey":"order.value","typeLabel":"number"},"products":{"type":"array","items":{"type":"object","required":["sku","amount","value"],"properties":{"sku":{"type":"string","description":"The product sku. Used to match campaign and reward e-commerce product restrictions.","isRequired":true,"uniqueKey":"order.products.items.[INDEX].sku","typeLabel":"string"},"amount":{"type":"number","description":"The quantity of the product","isRequired":true,"uniqueKey":"order.products.items.[INDEX].amount","typeLabel":"number"},"value":{"type":"number","description":"The total or subtotal of the product","isRequired":true,"uniqueKey":"order.products.items.[INDEX].value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The total or subtotal of the product after discounts","uniqueKey":"order.products.items.[INDEX].discounted_value","typeLabel":"number"},"redeem":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.products.items.[INDEX].redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.products.items.[INDEX].redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"order.products.items.[INDEX].redeem.items.[INDEX]","typeLabel":"object"},"description":"The rewards to redeem in the product","uniqueKey":"order.products.items.[INDEX].redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"order.products.items.[INDEX].tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"order.products.items.[INDEX].metadata","typeLabel":"object"},"redemptions_result":{"type":"object","description":"The result of the redemptions over the product","properties":{"redeemed":{"type":"array","description":"The rewards that have been redeemed","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].amount","typeLabel":"number"},"reward":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the reward, null if is a global reward","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id","typeLabel":"string | null"},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.status","typeLabel":"enum\u003cstring>"},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids","typeLabel":"string[]"},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id","typeLabel":"string\u003cuuid> | null"},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true,"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.content","typeLabel":"object"},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms","typeLabel":"string[]"},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels","typeLabel":"string[]"},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores","typeLabel":"string[] | null"},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels","typeLabel":"string[] | null"},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products","typeLabel":"string[] | null"},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers","typeLabel":"string\u003cuuid>[] | null"},"name":{"type":"string","description":"The name of the reward","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"The description of the reward","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.description","typeLabel":"string"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.type","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].operator","typeLabel":"string"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].primitive","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95,"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"string","description":"The value to compare","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.1","typeLabel":"string"},{"type":"boolean","description":"The value to compare","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value","typeLabel":"number | string | boolean"}},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions","typeLabel":"object[][]"},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1,"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0.conversion_factor","typeLabel":"number"}},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","additionalProperties":true,"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.1","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10,"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_value","typeLabel":"number"},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2","typeLabel":"object"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes","typeLabel":"object"}},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward","typeLabel":"object | null"},"error":{"type":"string","description":"The error message if the reward was not redeemed","uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.products.items.[INDEX].redemptions_result.redeemed","typeLabel":"object[]"},"amount":{"type":"number","description":"The amount of the reward redeemed","format":"int2","uniqueKey":"order.products.items.[INDEX].redemptions_result.amount","typeLabel":"number\u003cint2>"},"discount_value":{"type":"number","description":"The total discount reduced from the original value","uniqueKey":"order.products.items.[INDEX].redemptions_result.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"order.products.items.[INDEX].redemptions_result.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"order.products.items.[INDEX].redemptions_result.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.discount_percent","typeLabel":"number | null"},"value":{"oneOf":[{"type":"number","description":"The updated value of the item after the discount","uniqueKey":"order.products.items.[INDEX].redemptions_result.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The updated value of the item after the discount","uniqueKey":"order.products.items.[INDEX].redemptions_result.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.products.items.[INDEX].redemptions_result.value","typeLabel":"number | null"},"action":{"type":"string","description":"The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item","enum":["UPDATE","READ","CREATE","REMOVE"],"uniqueKey":"order.products.items.[INDEX].redemptions_result.action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.products.items.[INDEX].redemptions_result","typeLabel":"object"}},"uniqueKey":"order.products.items.[INDEX]","typeLabel":"object"},"description":"Products in the order. Product sku values are used to match campaign and reward e-commerce product restrictions.","minimum":1,"isRequired":true,"uniqueKey":"order.products","typeLabel":"object[]"},"payment_method":{"type":"string","description":"The payment method used in the order","enum":["CREDIT","DEBIT","CASH","BANK_TRANSFER","OTHER"],"isRequired":true,"uniqueKey":"order.payment_method","typeLabel":"enum\u003cstring>"},"channel_id":{"type":"string","description":"The channel unique identifier in your system. Used to match campaign and reward e-commerce channel restrictions.","uniqueKey":"order.channel_id","typeLabel":"string"},"store_id":{"type":"string","description":"The store unique identifier in your system. Used to match campaign and reward e-commerce store restrictions.","uniqueKey":"order.store_id","typeLabel":"string"},"discounted_value":{"type":"number","description":"The order total or subtotal after discounts","example":10.95,"uniqueKey":"order.discounted_value","typeLabel":"number"},"shipping":{"type":"object","description":"The shipping information of the order","properties":{"value":{"type":"number","description":"The shipping cost","example":3.25,"uniqueKey":"order.shipping.value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The shipping cost after discounts","example":2.25,"uniqueKey":"order.shipping.discounted_value","typeLabel":"number"},"redeem":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.shipping.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.shipping.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"order.shipping.redeem.items.[INDEX]","typeLabel":"object"},"description":"The rewards to redeem in the shipping","uniqueKey":"order.shipping.redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"order.shipping.tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"order.shipping.metadata","typeLabel":"object"},"redemptions_result":{"type":"object","description":"The result of the redemptions over the shipping","properties":{"redeemed":{"type":"array","description":"The rewards that have been redeemed","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].amount","typeLabel":"number"},"reward":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the reward, null if is a global reward","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id","typeLabel":"string | null"},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.status","typeLabel":"enum\u003cstring>"},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids","typeLabel":"string[]"},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id","typeLabel":"string\u003cuuid> | null"},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true,"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.content","typeLabel":"object"},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms","typeLabel":"string[]"},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels","typeLabel":"string[]"},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores","typeLabel":"string[] | null"},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels","typeLabel":"string[] | null"},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products","typeLabel":"string[] | null"},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers","typeLabel":"string\u003cuuid>[] | null"},"name":{"type":"string","description":"The name of the reward","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"The description of the reward","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.description","typeLabel":"string"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.type","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].operator","typeLabel":"string"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].primitive","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95,"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"string","description":"The value to compare","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.1","typeLabel":"string"},{"type":"boolean","description":"The value to compare","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value","typeLabel":"number | string | boolean"}},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions","typeLabel":"object[][]"},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1,"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0.conversion_factor","typeLabel":"number"}},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","additionalProperties":true,"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.1","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10,"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_value","typeLabel":"number"},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2","typeLabel":"object"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes","typeLabel":"object"}},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].reward","typeLabel":"object | null"},"error":{"type":"string","description":"The error message if the reward was not redeemed","uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"order.shipping.redemptions_result.redeemed.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.shipping.redemptions_result.redeemed","typeLabel":"object[]"},"amount":{"type":"number","description":"The amount of the reward redeemed","format":"int2","uniqueKey":"order.shipping.redemptions_result.amount","typeLabel":"number\u003cint2>"},"discount_value":{"type":"number","description":"The total discount reduced from the original value","uniqueKey":"order.shipping.redemptions_result.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"order.shipping.redemptions_result.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"order.shipping.redemptions_result.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.discount_percent","typeLabel":"number | null"},"value":{"oneOf":[{"type":"number","description":"The updated value of the item after the discount","uniqueKey":"order.shipping.redemptions_result.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The updated value of the item after the discount","uniqueKey":"order.shipping.redemptions_result.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.shipping.redemptions_result.value","typeLabel":"number | null"},"action":{"type":"string","description":"The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item","enum":["UPDATE","READ","CREATE","REMOVE"],"uniqueKey":"order.shipping.redemptions_result.action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.shipping.redemptions_result","typeLabel":"object"}},"uniqueKey":"order.shipping","typeLabel":"object"},"redeem":{"type":"array","description":"The rewards to redeem in the order","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"order.redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.redeem","typeLabel":"object[]"},"metadata":{"type":"object","description":"The metadata of the order","uniqueKey":"order.metadata","typeLabel":"object"},"redemptions_result":{"type":"object","description":"The result of the redemptions over the order","properties":{"redeemed":{"type":"array","description":"The rewards that have been redeemed","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].amount","typeLabel":"number"},"reward":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the reward, null if is a global reward","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id","typeLabel":"string | null"},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.status","typeLabel":"enum\u003cstring>"},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids","typeLabel":"string[]"},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id","typeLabel":"string\u003cuuid> | null"},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true,"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.content","typeLabel":"object"},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms","typeLabel":"string[]"},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels","typeLabel":"string[]"},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores","typeLabel":"string[] | null"},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels","typeLabel":"string[] | null"},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products","typeLabel":"string[] | null"},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers","typeLabel":"string\u003cuuid>[] | null"},"name":{"type":"string","description":"The name of the reward","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"The description of the reward","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.description","typeLabel":"string"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.type","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].operator","typeLabel":"string"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].primitive","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95,"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"string","description":"The value to compare","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.1","typeLabel":"string"},{"type":"boolean","description":"The value to compare","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value","typeLabel":"number | string | boolean"}},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions","typeLabel":"object[][]"},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1,"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0.conversion_factor","typeLabel":"number"}},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","additionalProperties":true,"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.1","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10,"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_value","typeLabel":"number"},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2","typeLabel":"object"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes","typeLabel":"object"}},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].reward","typeLabel":"object | null"},"error":{"type":"string","description":"The error message if the reward was not redeemed","uniqueKey":"order.redemptions_result.redeemed.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"order.redemptions_result.redeemed.items.[INDEX]","typeLabel":"object"},"uniqueKey":"order.redemptions_result.redeemed","typeLabel":"object[]"},"amount":{"type":"number","description":"The amount of the reward redeemed","format":"int2","uniqueKey":"order.redemptions_result.amount","typeLabel":"number\u003cint2>"},"discount_value":{"type":"number","description":"The total discount reduced from the original value","uniqueKey":"order.redemptions_result.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"order.redemptions_result.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"order.redemptions_result.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.discount_percent","typeLabel":"number | null"},"value":{"oneOf":[{"type":"number","description":"The updated value of the item after the discount","uniqueKey":"order.redemptions_result.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The updated value of the item after the discount","uniqueKey":"order.redemptions_result.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.redemptions_result.value","typeLabel":"number | null"},"action":{"type":"string","description":"The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item","enum":["UPDATE","READ","CREATE","REMOVE"],"uniqueKey":"order.redemptions_result.action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"order.redemptions_result","typeLabel":"object"}},"isRequired":true,"uniqueKey":"order","typeLabel":"object"},"platform":{"oneOf":[{"type":"string","description":"Platform name where the event originated","uniqueKey":"platform.oneOf.0","typeLabel":"string"},{"type":"null","description":"Platform name where the event originated","uniqueKey":"platform.oneOf.1","typeLabel":"null"}],"uniqueKey":"platform","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"example":{},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"5073c5e5-bda4-4fa6-814d-2b74389f473e":{"description":"Ok","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"customer_id":{"type":"string","description":"The customer unique identifier in your system","uniqueKey":"data.customer_id","typeLabel":"string"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the order","uniqueKey":"data.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the order","uniqueKey":"data.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.brand_id","typeLabel":"string | null"},"order":{"type":"object","description":"The order with the rewards applied","required":["purchase_id","value","products","payment_method"],"properties":{"purchase_id":{"type":"string","description":"The id of a placed order in your system","isRequired":true,"uniqueKey":"data.order.purchase_id","typeLabel":"string"},"value":{"type":"number","description":"The order total or subtotal","example":20.95,"isRequired":true,"uniqueKey":"data.order.value","typeLabel":"number"},"products":{"type":"array","items":{"type":"object","required":["sku","amount","value"],"properties":{"sku":{"type":"string","description":"The product sku. Used to match campaign and reward e-commerce product restrictions.","isRequired":true,"uniqueKey":"data.order.products.items.[INDEX].sku","typeLabel":"string"},"amount":{"type":"number","description":"The quantity of the product","isRequired":true,"uniqueKey":"data.order.products.items.[INDEX].amount","typeLabel":"number"},"value":{"type":"number","description":"The total or subtotal of the product","isRequired":true,"uniqueKey":"data.order.products.items.[INDEX].value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The total or subtotal of the product after discounts","uniqueKey":"data.order.products.items.[INDEX].discounted_value","typeLabel":"number"},"redeem":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"data.order.products.items.[INDEX].redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"data.order.products.items.[INDEX].redeem.items.[INDEX]","typeLabel":"object"},"description":"The rewards to redeem in the product","uniqueKey":"data.order.products.items.[INDEX].redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"data.order.products.items.[INDEX].tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"data.order.products.items.[INDEX].metadata","typeLabel":"object"},"redemptions_result":{"type":"object","description":"The result of the redemptions over the product","properties":{"redeemed":{"type":"array","description":"The rewards that have been redeemed","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].amount","typeLabel":"number"},"reward":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the reward, null if is a global reward","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id","typeLabel":"string | null"},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.status","typeLabel":"enum\u003cstring>"},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids","typeLabel":"string[]"},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id","typeLabel":"string\u003cuuid> | null"},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.content","typeLabel":"object"},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms","typeLabel":"string[]"},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels","typeLabel":"string[]"},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores","typeLabel":"string[] | null"},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels","typeLabel":"string[] | null"},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products","typeLabel":"string[] | null"},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers","typeLabel":"string\u003cuuid>[] | null"},"name":{"type":"string","description":"The name of the reward","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"The description of the reward","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.description","typeLabel":"string"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.type","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].operator","typeLabel":"string"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].primitive","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"string","description":"The value to compare","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.1","typeLabel":"string"},{"type":"boolean","description":"The value to compare","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value","typeLabel":"number | string | boolean"}},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions","typeLabel":"object[][]"},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0.conversion_factor","typeLabel":"number"}},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","additionalProperties":true,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.1","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_value","typeLabel":"number"},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2","typeLabel":"object"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes","typeLabel":"object"}},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].reward","typeLabel":"object | null"},"error":{"type":"string","description":"The error message if the reward was not redeemed","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.redeemed","typeLabel":"object[]"},"amount":{"type":"number","description":"The amount of the reward redeemed","format":"int2","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.amount","typeLabel":"number\u003cint2>"},"discount_value":{"type":"number","description":"The total discount reduced from the original value","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.discount_percent","typeLabel":"number | null"},"value":{"oneOf":[{"type":"number","description":"The updated value of the item after the discount","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The updated value of the item after the discount","uniqueKey":"data.order.products.items.[INDEX].redemptions_result.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.value","typeLabel":"number | null"},"action":{"type":"string","description":"The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item","enum":["UPDATE","READ","CREATE","REMOVE"],"uniqueKey":"data.order.products.items.[INDEX].redemptions_result.action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.order.products.items.[INDEX].redemptions_result","typeLabel":"object"}},"uniqueKey":"data.order.products.items.[INDEX]","typeLabel":"object"},"description":"Products in the order. Product sku values are used to match campaign and reward e-commerce product restrictions.","minimum":1,"isRequired":true,"uniqueKey":"data.order.products","typeLabel":"object[]"},"payment_method":{"type":"string","description":"The payment method used in the order","enum":["CREDIT","DEBIT","CASH","BANK_TRANSFER","OTHER"],"isRequired":true,"uniqueKey":"data.order.payment_method","typeLabel":"enum\u003cstring>"},"channel_id":{"type":"string","description":"The channel unique identifier in your system. Used to match campaign and reward e-commerce channel restrictions.","uniqueKey":"data.order.channel_id","typeLabel":"string"},"store_id":{"type":"string","description":"The store unique identifier in your system. Used to match campaign and reward e-commerce store restrictions.","uniqueKey":"data.order.store_id","typeLabel":"string"},"discounted_value":{"type":"number","description":"The order total or subtotal after discounts","example":10.95,"uniqueKey":"data.order.discounted_value","typeLabel":"number"},"shipping":{"type":"object","description":"The shipping information of the order","properties":{"value":{"type":"number","description":"The shipping cost","example":3.25,"uniqueKey":"data.order.shipping.value","typeLabel":"number"},"discounted_value":{"type":"number","description":"The shipping cost after discounts","example":2.25,"uniqueKey":"data.order.shipping.discounted_value","typeLabel":"number"},"redeem":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"data.order.shipping.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"data.order.shipping.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"data.order.shipping.redeem.items.[INDEX]","typeLabel":"object"},"description":"The rewards to redeem in the shipping","uniqueKey":"data.order.shipping.redeem","typeLabel":"object[]"},"tags":{"type":"object","description":"Include your conditions event tags here","uniqueKey":"data.order.shipping.tags","typeLabel":"object"},"metadata":{"type":"object","description":"Include any additional info here","uniqueKey":"data.order.shipping.metadata","typeLabel":"object"},"redemptions_result":{"type":"object","description":"The result of the redemptions over the shipping","properties":{"redeemed":{"type":"array","description":"The rewards that have been redeemed","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].amount","typeLabel":"number"},"reward":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the reward, null if is a global reward","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id","typeLabel":"string | null"},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.status","typeLabel":"enum\u003cstring>"},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids","typeLabel":"string[]"},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id","typeLabel":"string\u003cuuid> | null"},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true,"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.content","typeLabel":"object"},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms","typeLabel":"string[]"},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels","typeLabel":"string[]"},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores","typeLabel":"string[] | null"},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels","typeLabel":"string[] | null"},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products","typeLabel":"string[] | null"},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers","typeLabel":"string\u003cuuid>[] | null"},"name":{"type":"string","description":"The name of the reward","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"The description of the reward","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.description","typeLabel":"string"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.type","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].operator","typeLabel":"string"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].primitive","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95,"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"string","description":"The value to compare","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.1","typeLabel":"string"},{"type":"boolean","description":"The value to compare","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value","typeLabel":"number | string | boolean"}},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions","typeLabel":"object[][]"},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1,"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0.conversion_factor","typeLabel":"number"}},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","additionalProperties":true,"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.1","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10,"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_value","typeLabel":"number"},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2","typeLabel":"object"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes","typeLabel":"object"}},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].reward","typeLabel":"object | null"},"error":{"type":"string","description":"The error message if the reward was not redeemed","uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"data.order.shipping.redemptions_result.redeemed.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.shipping.redemptions_result.redeemed","typeLabel":"object[]"},"amount":{"type":"number","description":"The amount of the reward redeemed","format":"int2","uniqueKey":"data.order.shipping.redemptions_result.amount","typeLabel":"number\u003cint2>"},"discount_value":{"type":"number","description":"The total discount reduced from the original value","uniqueKey":"data.order.shipping.redemptions_result.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"data.order.shipping.redemptions_result.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"data.order.shipping.redemptions_result.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.discount_percent","typeLabel":"number | null"},"value":{"oneOf":[{"type":"number","description":"The updated value of the item after the discount","uniqueKey":"data.order.shipping.redemptions_result.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The updated value of the item after the discount","uniqueKey":"data.order.shipping.redemptions_result.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.shipping.redemptions_result.value","typeLabel":"number | null"},"action":{"type":"string","description":"The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item","enum":["UPDATE","READ","CREATE","REMOVE"],"uniqueKey":"data.order.shipping.redemptions_result.action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.order.shipping.redemptions_result","typeLabel":"object"}},"uniqueKey":"data.order.shipping","typeLabel":"object"},"redeem":{"type":"array","description":"The rewards to redeem in the order","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"data.order.redeem.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"data.order.redeem.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"data.order.redeem.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.redeem","typeLabel":"object[]"},"metadata":{"type":"object","description":"The metadata of the order","uniqueKey":"data.order.metadata","typeLabel":"object"},"redemptions_result":{"type":"object","description":"The result of the redemptions over the order","properties":{"redeemed":{"type":"array","description":"The rewards that have been redeemed","items":{"type":"object","properties":{"id":{"type":"string","description":"The reward id to redeem","format":"uuid","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"amount":{"type":"number","description":"The amount of the reward to redeem. (Per product if applicable)","example":1,"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].amount","typeLabel":"number"},"reward":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The reward internal unique identifier","format":"uuid","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.id","typeLabel":"string\u003cuuid>"},"brand_id":{"oneOf":[{"type":"string","description":"The brand id of the reward, null if is a global reward","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brand id of the reward, null if is a global reward","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.brand_id","typeLabel":"string | null"},"account_id":{"type":"string","description":"The account id that owns this reward.","format":"uuid","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.account_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"The status of the reward.","enum":["ACTIVE","INACTIVE"],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.status","typeLabel":"enum\u003cstring>"},"team_ids":{"type":"array","description":"Team ids associated with this reward.","items":{"type":"string","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.team_ids","typeLabel":"string[]"},"template_id":{"oneOf":[{"type":"string","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"CMS template id used to structure the reward content, or null when no template is selected.","format":"uuid","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.template_id","typeLabel":"string\u003cuuid> | null"},"content":{"type":"object","description":"CMS content values for the reward.","additionalProperties":true,"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.content","typeLabel":"object"},"platforms":{"type":"array","description":"Platforms where this reward applies.","items":{"type":"string","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.platforms","typeLabel":"string[]"},"labels":{"type":"array","description":"Labels used to categorize this reward.","items":{"type":"string","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.labels","typeLabel":"string[]"},"stores":{"oneOf":[{"type":"array","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Store ids this reward is restricted to. When creating or updating, null means no store restriction and a non-empty array restricts the reward to those stores.","items":{"type":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.stores","typeLabel":"string[] | null"},"channels":{"oneOf":[{"type":"array","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Channel ids this reward is restricted to. When creating or updating, null means no channel restriction and a non-empty array restricts the reward to those channels.","items":{"type":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.channels","typeLabel":"string[] | null"},"products":{"oneOf":[{"type":"array","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"Product ids this reward is restricted to. When creating or updating, null means no product restriction and a non-empty array restricts the reward to those products.","items":{"type":"string"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.products","typeLabel":"string[] | null"},"tiers":{"oneOf":[{"type":"array","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","description":"Tier ids allowed to redeem this reward. When creating or updating, null or [] means no tier restriction; a non-empty array requires the customer's current tier to be included.","items":{"type":"string","format":"uuid"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.tiers","typeLabel":"string\u003cuuid>[] | null"},"name":{"type":"string","description":"The name of the reward","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"The description of the reward","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.description","typeLabel":"string"},"type":{"type":"string","description":"The type of the reward","enum":["POINTS","DISCOUNT","GIFT_CARD","PRODUCT","CUSTOM","COUNTER"],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.type","typeLabel":"enum\u003cstring>"},"conditions":{"type":"array","description":"OR conditions","items":{"type":"array","description":"AND conditions","items":{"type":"object","properties":{"type":{"type":"string","description":"The type of the condition","example":"Order Value","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].type","typeLabel":"string"},"operator":{"type":"string","description":"The operator to compare the attribute","example":"grater than","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].operator","typeLabel":"string"},"primitive":{"type":"string","description":"The primitive of the value to compare","enum":["string","number","currency","boolean","absolute date","relative date","recurring date"],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].primitive","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"number","description":"The value to compare","example":9.95,"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.0","typeLabel":"number"},{"type":"string","description":"The value to compare","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.1","typeLabel":"string"},{"type":"boolean","description":"The value to compare","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX].value","typeLabel":"number | string | boolean"}},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX].items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions.items.[INDEX]","typeLabel":"object[]"},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.conditions","typeLabel":"object[][]"},"attributes":{"oneOf":[{"type":"object","description":"The attributes of the reward","properties":{"conversion_factor":{"type":"number","description":"How much 1 point is worth in your currency","example":0.1,"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0.conversion_factor","typeLabel":"number"}},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.0","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","additionalProperties":true,"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.1","typeLabel":"object"},{"type":"object","description":"The attributes of the reward","properties":{"discount_value":{"type":"number","description":"The discount value","example":10,"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_value","typeLabel":"number"},"discount_type":{"type":"string","description":"The type of discount","enum":["fixed","percentage"],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"type":{"type":"string","description":"The discount will be applied to","enum":["shipping","order","product"],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes.oneOf.2","typeLabel":"object"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0.attributes","typeLabel":"object"}},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].reward","typeLabel":"object | null"},"error":{"type":"string","description":"The error message if the reward was not redeemed","uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"data.order.redemptions_result.redeemed.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.order.redemptions_result.redeemed","typeLabel":"object[]"},"amount":{"type":"number","description":"The amount of the reward redeemed","format":"int2","uniqueKey":"data.order.redemptions_result.amount","typeLabel":"number\u003cint2>"},"discount_value":{"type":"number","description":"The total discount reduced from the original value","uniqueKey":"data.order.redemptions_result.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"data.order.redemptions_result.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","description":"The percentage of the total discount reduced from the original value","minimum":0,"maximum":1,"uniqueKey":"data.order.redemptions_result.discount_percent.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.discount_percent","typeLabel":"number | null"},"value":{"oneOf":[{"type":"number","description":"The updated value of the item after the discount","uniqueKey":"data.order.redemptions_result.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"The updated value of the item after the discount","uniqueKey":"data.order.redemptions_result.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order.redemptions_result.value","typeLabel":"number | null"},"action":{"type":"string","description":"The action to perform over this item in your order. UPDATE to update the item. READ to keep the item. CREATE to create a new item. REMOVE to remove the item","enum":["UPDATE","READ","CREATE","REMOVE"],"uniqueKey":"data.order.redemptions_result.action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.order.redemptions_result","typeLabel":"object"}},"uniqueKey":"data.order","typeLabel":"object"},"redemption_steps":{"type":"array","description":"Chronological changes produced by each redemption. Existing order fields keep their final values unchanged.","items":{"type":"object","description":"One reward application and the financial transition it produced","required":["reward_id","reward_amount","target","target_id","action","discount_value","before","after"],"properties":{"reward_id":{"type":"string","format":"uuid","description":"The redeemed reward id","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].reward_id","typeLabel":"string\u003cuuid>"},"reward_amount":{"type":"number","description":"The redeemed reward amount","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].reward_amount","typeLabel":"number"},"target":{"type":"string","enum":["order","shipping","product"],"description":"Where the reward was requested; use this to map order/product and delivery discount codes","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target","typeLabel":"enum\u003cstring>"},"target_id":{"oneOf":[{"type":"string","description":"Product SKU when target is product; otherwise null","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Product SKU when target is product; otherwise null","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_id","typeLabel":"string | null"},"action":{"type":"string","enum":["UPDATE","READ","CREATE","REMOVE"],"description":"The action produced by this redemption","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].action","typeLabel":"enum\u003cstring>"},"discount_value":{"type":"number","description":"This redemption's contribution to the order discount; zero when it failed or was fully capped","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].discount_value","typeLabel":"number"},"before":{"type":"object","description":"Order-level financial state before this redemption","required":["value","amount","discount_value","discount_percent"],"properties":{"value":{"oneOf":[{"type":"number","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.value","typeLabel":"number | null"},"amount":{"type":"number","description":"Current item amount","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.amount","typeLabel":"number"},"discount_value":{"type":"number","description":"Discount accumulated up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before.discount_percent","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].before","typeLabel":"object"},"after":{"type":"object","description":"Order-level financial state after this redemption","required":["value","amount","discount_value","discount_percent"],"properties":{"value":{"oneOf":[{"type":"number","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.value","typeLabel":"number | null"},"amount":{"type":"number","description":"Current item amount","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.amount","typeLabel":"number"},"discount_value":{"type":"number","description":"Discount accumulated up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after.discount_percent","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].after","typeLabel":"object"},"target_before":{"type":"object","description":"Product or shipping state before this redemption; omitted when target is order","required":["value","amount","discount_value","discount_percent"],"properties":{"value":{"oneOf":[{"type":"number","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.value","typeLabel":"number | null"},"amount":{"type":"number","description":"Current item amount","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.amount","typeLabel":"number"},"discount_value":{"type":"number","description":"Discount accumulated up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_before.discount_percent","typeLabel":"number | null"}},"uniqueKey":"data.redemption_steps.items.[INDEX].target_before","typeLabel":"object"},"target_after":{"type":"object","description":"Product or shipping state after this redemption; omitted when target is order","required":["value","amount","discount_value","discount_percent"],"properties":{"value":{"oneOf":[{"type":"number","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.value.oneOf.0","typeLabel":"number"},{"type":"null","description":"Current value after discounts applied up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.value.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.value","typeLabel":"number | null"},"amount":{"type":"number","description":"Current item amount","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.amount","typeLabel":"number"},"discount_value":{"type":"number","description":"Discount accumulated up to this point","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.discount_value","typeLabel":"number"},"discount_percent":{"oneOf":[{"type":"number","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.discount_percent.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":1,"description":"Cumulative discount percentage for this state; order states include the estimated value of product rewards","isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.discount_percent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.redemption_steps.items.[INDEX].target_after.discount_percent","typeLabel":"number | null"}},"uniqueKey":"data.redemption_steps.items.[INDEX].target_after","typeLabel":"object"},"error":{"type":"string","description":"The error when this redemption was not applied","uniqueKey":"data.redemption_steps.items.[INDEX].error","typeLabel":"string"}},"uniqueKey":"data.redemption_steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.redemption_steps","typeLabel":"object[]"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"customer_id":"\u003cstring>","brand_id":"\u003cstring>","order":{"purchase_id":"\u003cstring>","value":20.95,"products":[{"sku":"\u003cstring>","amount":123,"value":123,"discounted_value":123,"redeem":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":1}],"tags":{},"metadata":{},"redemptions_result":{"redeemed":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":1,"reward":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"\u003cstring>","account_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"ACTIVE","team_ids":["\u003cstring>"],"template_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","content":{},"platforms":["\u003cstring>"],"labels":["\u003cstring>"],"stores":["\u003cstring>"],"channels":["\u003cstring>"],"products":["\u003cstring>"],"tiers":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"name":"\u003cstring>","description":"\u003cstring>","type":"POINTS","conditions":[[{"type":"Order Value","operator":"grater than","primitive":"string","value":9.95}]],"attributes":{"conversion_factor":0.1}},"error":"\u003cstring>"}],"amount":123,"discount_value":123,"discount_percent":0.5,"value":123,"action":"UPDATE"}}],"payment_method":"CREDIT","channel_id":"\u003cstring>","store_id":"\u003cstring>","discounted_value":10.95,"shipping":{"value":3.25,"discounted_value":2.25,"redeem":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":1}],"tags":{},"metadata":{},"redemptions_result":{"redeemed":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":1,"reward":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"\u003cstring>","account_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"ACTIVE","team_ids":["\u003cstring>"],"template_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","content":{},"platforms":["\u003cstring>"],"labels":["\u003cstring>"],"stores":["\u003cstring>"],"channels":["\u003cstring>"],"products":["\u003cstring>"],"tiers":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"name":"\u003cstring>","description":"\u003cstring>","type":"POINTS","conditions":[[{"type":"Order Value","operator":"grater than","primitive":"string","value":9.95}]],"attributes":{"conversion_factor":0.1}},"error":"\u003cstring>"}],"amount":123,"discount_value":123,"discount_percent":0.5,"value":123,"action":"UPDATE"}},"redeem":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":1}],"metadata":{},"redemptions_result":{"redeemed":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","amount":1,"reward":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","brand_id":"\u003cstring>","account_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"ACTIVE","team_ids":["\u003cstring>"],"template_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","content":{},"platforms":["\u003cstring>"],"labels":["\u003cstring>"],"stores":["\u003cstring>"],"channels":["\u003cstring>"],"products":["\u003cstring>"],"tiers":["3c90c3cc-0d44-4b50-8888-8dd25736052a"],"name":"\u003cstring>","description":"\u003cstring>","type":"POINTS","conditions":[[{"type":"Order Value","operator":"grater than","primitive":"string","value":9.95}]],"attributes":{"conversion_factor":0.1}},"error":"\u003cstring>"}],"amount":123,"discount_value":123,"discount_percent":0.5,"value":123,"action":"UPDATE"}},"redemption_steps":[{"reward_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","reward_amount":123,"target":"order","target_id":"\u003cstring>","action":"UPDATE","discount_value":123,"before":{"value":123,"amount":123,"discount_value":123,"discount_percent":0.5},"after":{"value":123,"amount":123,"discount_value":123,"discount_percent":0.5},"target_before":{"value":123,"amount":123,"discount_value":123,"discount_percent":0.5},"target_after":{"value":123,"amount":123,"discount_value":123,"discount_percent":0.5},"error":"\u003cstring>"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"5eb9c667-fa00-4b6d-853c-a3cfda86292a":{"description":"Insufficient funds or reward eligibility failed. A tier mismatch returns: This reward is not available for this tier.","content":{"application/json":{"schema":{"required":["error","details"],"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","isRequired":true,"uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","details":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"da9d8232-ebd9-4bac-b7ab-fd0880df2eb5":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"e171325b-53ae-45cf-854f-c3588a3e764a":{"url":"https://app.masivo.ai/api/storefront/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"trd","siteName":"Masivo","title":"Preview order - Masivo","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/events/redeem/preview/put","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-08-18T17:21:49.986Z","originalFileLocation":"api-reference/events/redeem/preview/put.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer\u0026#x27;s current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Masivo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Preview order - Masivo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer\u0026#x27;s current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Masivo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.masivo.ai/api-reference/events/redeem/preview/put\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://trd.mintlify.app/_mintlify/api/og/v2?division=Behavior\u0026amp;title=Preview+order\u0026amp;description=Preview+the+order+as+if+the+given+rewards+were+redeemed.+Store%2C+channel%2C+and+product+restrictions+are+evaluated+against+the+order.+Tier+restrictions+are+evaluat\u0026amp;theme=8f8d98b752dbc21b97c2a726\u0026amp;signature=20933905dcc98f2aa540fec178f83fd03c5bf6b46a40175cb8c603ad40a3917e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Preview order - Masivo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer\u0026#x27;s current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://trd.mintlify.app/_mintlify/api/og/v2?division=Behavior\u0026amp;title=Preview+order\u0026amp;description=Preview+the+order+as+if+the+given+rewards+were+redeemed.+Store%2C+channel%2C+and+product+restrictions+are+evaluated+against+the+order.+Tier+restrictions+are+evaluat\u0026amp;theme=8f8d98b752dbc21b97c2a726\u0026amp;signature=20933905dcc98f2aa540fec178f83fd03c5bf6b46a40175cb8c603ad40a3917e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/trd/IG0U6h8DpJ60Xnom/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Masivo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9333ea\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.masivo.ai/api-reference/events/redeem/preview/put\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/events/redeem/preview/put.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.masivo.ai/#organization\",\"name\":\"Masivo\",\"url\":\"https://docs.masivo.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/trd/7W_vRQTxJHIpxqe2/logo/light.svg?fit=max\u0026auto=format\u0026n=7W_vRQTxJHIpxqe2\u0026q=85\u0026s=d6c63ec91328f53e2881c4b8c6463002\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.masivo.ai#website\",\"name\":\"Masivo\",\"url\":\"https://docs.masivo.ai\",\"publisher\":{\"@id\":\"https://docs.masivo.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put#webpage\",\"url\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put\",\"name\":\"Preview order\",\"description\":\"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer's current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.\",\"dateModified\":\"2026-08-18T17:21:49.986Z\",\"isPartOf\":{\"@id\":\"https://docs.masivo.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.masivo.ai/api-reference/auth/authorize/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://docs.masivo.ai/api-reference/behavior/events/post\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Behavior\",\"item\":\"https://docs.masivo.ai/api-reference/behavior/events/post\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Preview order\",\"item\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put#apireference\",\"headline\":\"Preview order\",\"name\":\"Preview order\",\"description\":\"Preview the order as if the given rewards were redeemed. Store, channel, and product restrictions are evaluated against the order. Tier restrictions are evaluated against the customer's current tier; clients cannot override it in the request. null or an empty tiers array means no tier restriction. A reward snapshot already stored in the wallet keeps its saved scope until the wallet update flow replaces it. A tier mismatch returns: This reward is not available for this tier.\",\"url\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put\",\"mainEntityOfPage\":{\"@id\":\"https://docs.masivo.ai/api-reference/events/redeem/preview/put#webpage\"},\"dateModified\":\"2026-08-18T17:21:49.986Z\",\"publisher\":{\"@id\":\"https://docs.masivo.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.masivo.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Masivo\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Masivo","nav":{"global":{"anchors":[{"anchor":"Roadmap","icon":"map","href":"https://docs.masivo.ai/roadmap"},{"anchor":"Changelog","icon":"rocket","href":"https://docs.masivo.ai/changelog"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/2DgqGUej"}]},"versions":[{"version":"v1","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Auth","pages":[{"title":"Authorize","openapi":"GET /auth/authorize","href":"/api-reference/auth/authorize/get"},{"title":"Request TOTP","openapi":"POST /auth/totp","href":"/api-reference/auth/totp/post"},{"title":"Verify TOTP","openapi":"GET /auth/totp/verify","href":"/api-reference/auth/totp/verify/get"}]},{"group":"Brands","pages":[{"title":"Get brands","openapi":"GET /brands","href":"/api-reference/brands/get"}]},{"group":"Platforms","pages":[{"title":"Get platforms","openapi":"GET /platforms","href":"/api-reference/platforms/get"}]},{"group":"Tiers","pages":[{"title":"Get tiers","openapi":"GET /tiers","href":"/api-reference/tiers/get"}]},{"group":"Rewards","pages":[{"title":"Get rewards","openapi":"GET /rewards","href":"/api-reference/rewards/get"},{"title":"Get reward","openapi":"GET /rewards/{id}","href":"/api-reference/rewards/[id]/get"},{"group":"Gift cards","pages":[{"title":"Get customer gift cards","openapi":"GET /customers/{id}/rewards/gift-cards","href":"/api-reference/rewards/gift-cards/get"},{"title":"Redeem gift card","openapi":"Delete /rewards/gift-cards/redeem","href":"/api-reference/rewards/gift-cards/redeem/delete"}]}]},{"group":"Customers","pages":[{"title":"Register customer","openapi":"POST /customers","href":"/api-reference/customers/post"},{"title":"Get customer by document or phone","openapi":"GET /customers","href":"/api-reference/customers/get"},{"title":"Get customer","openapi":"GET /customers/{id}","href":"/api-reference/customers/[id]/get"},{"title":"Update customer","openapi":"PATCH /customers/{id}","href":"/api-reference/customers/[id]/patch"},{"title":"Unregister customer","openapi":"DELETE /customers/{id}","href":"/api-reference/customers/[id]/delete"},{"title":"Update customers in bulk","openapi":"PATCH /customers/bulk","href":"/api-reference/customers/bulk/patch"},{"title":"Get customer consent","openapi":"GET /customers/{id}/consent","href":"/api-reference/customers/[id]/consent/get"},{"title":"Update customer consent","openapi":"PATCH /customers/{id}/consent","href":"/api-reference/customers/[id]/consent/patch"},{"title":"Update customer tags","openapi":"PATCH /customers/{id}/tags","href":"/api-reference/customers/[id]/tags/patch"},{"title":"Delete customer tags","openapi":"DELETE /customers/{id}/tags","href":"/api-reference/customers/[id]/tags/delete"},{"title":"Get customer punch-cards","openapi":"GET /customers/{id}/punch-cards","href":"/api-reference/customers/[id]/punch-cards/get"},{"title":"Get customer score streaks","openapi":"GET /customers/{id}/score-streaks","href":"/api-reference/customers/[id]/score-streaks/get"},{"title":"List in-app messages","openapi":"GET /customers/{id}/inapp-messages","href":"/api-reference/customers/[id]/inapp-messages/get"},{"title":"Log in-app message event","openapi":"POST /customers/{id}/inapp-messages/{messageId}/events","href":"/api-reference/customers/[id]/inapp-messages/[messageId]/events/post"},{"title":"Get customer news feed cards","openapi":"GET /customers/{id}/news-feed","href":"/api-reference/customers/[id]/news-feed/get"},{"title":"Log a news feed card event","openapi":"POST /customers/{id}/news-feed/{templateId}/events","href":"/api-reference/customers/[id]/news-feed/[templateId]/events/post"},{"title":"Identify anonymous customers","openapi":"PATCH /customers/{id}/identify/anonymous","href":"/api-reference/customers/[id]/identify/anonymous/patch"}]},{"group":"Contacts","pages":[{"title":"Search contacts","openapi":"GET /contacts","href":"/api-reference/contacts/get"},{"title":"Create contact","openapi":"POST /contacts","href":"/api-reference/contacts/post"},{"title":"Update contact by ID","openapi":"PUT /contacts/{id}","href":"/api-reference/contacts/[id]/put"},{"title":"Delete contact by ID","openapi":"DELETE /contacts/{id}","href":"/api-reference/contacts/[id]/delete"},{"title":"Migrate contacts","openapi":"POST /contacts/migrate","href":"/api-reference/contacts/migrate/post"}]},{"group":"Campaigns","pages":[{"group":"Behavior","pages":[{"title":"Emit event","openapi":"POST /behavior/events","href":"/api-reference/behavior/events/post"},{"title":"Fulfill event","openapi":"PATCH /behavior/events/{eventId}/fulfill","href":"/api-reference/behavior/events/[eventId]/fulfill/patch"},{"title":"Reverse event","openapi":"POST /behavior/events/{eventId}/reverse","description":"Reverse the given event. This will also undo the redemptions and accumulations made on the event.","href":"/api-reference/behavior/events/[eventId]/reverse/delete"},{"title":"Preview order","openapi":"PUT /events/redeem/preview","href":"/api-reference/events/redeem/preview/put"},{"title":"Identify customer","openapi":"PATCH /events/identify","description":"Link a customer with a tracking ID to establish analytics relationships. If the customer has `link_tracking` consent set to `false`, the request still returns success but the link is not recorded, so the click stays anonymous. Returns 404 if the customer does not exist in the account.","href":"/api-reference/events/identify/patch"}]},{"group":"Coupons","pages":[{"title":"Redeem coupon","openapi":"POST /coupons/redeem","href":"/api-reference/coupons/redeem/post"},{"title":"Reverse coupon","openapi":"POST /coupons/reverse","href":"/api-reference/coupons/reverse/post"}]},{"group":"Referrals","pages":[{"title":"Request referral code","openapi":"POST /customers/{id}/referrals/request-code","href":"/api-reference/customers/[id]/referrals/request-code/post"}]},{"title":"Get campaign","openapi":"GET /campaigns/{id}","href":"/api-reference/campaigns/[id]/get"},{"title":"Update campaign","openapi":"PUT /campaigns/{id}","href":"/api-reference/campaigns/[id]/put"},{"title":"Get campaigns","openapi":"GET /campaigns","href":"/api-reference/campaigns/get"},{"title":"Create a new campaign","openapi":"POST /campaigns","href":"/api-reference/campaigns/post"}]},{"group":"Review forms","pages":[{"title":"Get form","openapi":"GET /review-forms/{id}","href":"/api-reference/review-forms/[id]/get"},{"title":"Create review","openapi":"POST /review-forms/{id}/reviews","href":"/api-reference/review-forms/[id]/reviews/post"},{"title":"List reviews","openapi":"GET /reviews","href":"/api-reference/reviews/get"}]},{"group":"Tickets","pages":[{"title":"List ticket pipelines","openapi":"GET /ticket-pipelines","href":"/api-reference/ticket-pipelines/get"},{"title":"Create ticket","openapi":"POST /tickets","href":"/api-reference/tickets/post"},{"title":"Get ticket","openapi":"GET /tickets/{id}","href":"/api-reference/tickets/[id]/get"},{"title":"Update ticket","openapi":"PATCH /tickets/{id}","href":"/api-reference/tickets/[id]/patch"},{"title":"List ticket assignees","openapi":"GET /tickets/{id}/assignees","href":"/api-reference/tickets/[id]/assignees/get"},{"title":"Add ticket assignee","openapi":"POST /tickets/{id}/assignees","href":"/api-reference/tickets/[id]/assignees/post"},{"title":"Remove ticket assignee","openapi":"DELETE /tickets/{id}/assignees","href":"/api-reference/tickets/[id]/assignees/delete"},{"title":"List communication threads","openapi":"GET /communication/threads","href":"/api-reference/communication/threads/get"},{"title":"Create communication thread","openapi":"POST /communication/threads","href":"/api-reference/communication/threads/post"},{"title":"Get communication thread","openapi":"GET /communication/threads/{id}","href":"/api-reference/communication/threads/[id]/get"},{"title":"List communication messages","openapi":"GET /communication/threads/{id}/messages","href":"/api-reference/communication/threads/[id]/messages/get"},{"title":"Create communication message","openapi":"POST /communication/threads/{id}/messages","href":"/api-reference/communication/threads/[id]/messages/post"}]},{"group":"Transactions","pages":[{"title":"Customer transactions","openapi":"GET /customers/{id}/transactions","href":"/api-reference/customers/[id]/transactions/get"},{"title":"Account transactions","openapi":"GET /transactions","href":"/api-reference/transactions/get"}]},{"group":"Push","pages":[{"title":"Customer device token","openapi":"PATCH /customers/{id}/devices","href":"/api-reference/customers/[id]/devices/patch"},{"title":"Customer device token","openapi":"DELETE /customers/{id}/devices","href":"/api-reference/customers/[id]/devices/delete"},{"title":"Send customer push","openapi":"POST /push/customers/{id}/send","href":"/api-reference/push/customers/[id]/send/post"},{"title":"Schedule audience push","openapi":"POST /push/audiences/{id}/schedule","href":"/api-reference/push/audiences/[id]/schedule/post"}]},{"group":"In-app","pages":[{"title":"Get in-app capabilities","openapi":"GET /inapp/capabilities","href":"/api-reference/inapp/capabilities/get"}]},{"group":"Migrate","pages":[{"title":"Migrate customers","openapi":"POST /customers/migrate","href":"/api-reference/customers/migrate/post"},{"title":"Migrate devices tokens","openapi":"POST /customers/migrate/devices","href":"/api-reference/customers/migrate/devices/post"},{"title":"Migrate events","openapi":"POST /customers/migrate/events","href":"/api-reference/customers/migrate/events/post"},{"title":"Migrate transactions","openapi":"POST /customers/migrate/transactions","href":"/api-reference/customers/migrate/transactions/post"},{"title":"Revert migration","openapi":"DELETE /customers/migrate/revert","href":"/api-reference/customers/migrate/revert/delete"}]},{"group":"Maintenance","pages":[{"title":"Fulfill expired events","openapi":"POST /customers/fulfill_expired_events","href":"/api-reference/customers/fulfill_expired_events/post"}]}]},{"group":"Guides","pages":[{"title":"Integrate with Masivo","href":"/api-reference/guides/integrate-with-masivo"},{"title":"Register a customer","href":"/api-reference/guides/register-a-customer"},{"title":"Show customer data","href":"/api-reference/guides/show-customer-data"},{"title":"Validate rewards redemption","href":"/api-reference/guides/validate-rewards-redemption"},{"title":"Send an event","href":"/api-reference/guides/send-an-event"},{"title":"Submit reviews","href":"/api-reference/guides/submit-reviews"},{"title":"Redeem a coupon","href":"/api-reference/guides/redeem-a-coupon"},{"title":"Reverse a coupon","href":"/api-reference/guides/reverse-a-coupon"},{"title":"Modify customer balance arbitrarily","href":"/api-reference/guides/modify-customer-balance-arbitrarily"},{"title":"Migrate customers","href":"/api-reference/guides/migrate-customers"},{"title":"Setup webhooks","href":"/api-reference/guides/setup-webhooks"},{"title":"Integrate push notifications","href":"/api-reference/guides/integrate-push-notification"},{"title":"Integrate in-app messages","href":"/api-reference/guides/integrate-in-app-messages"},{"title":"Integrate deferred deep linking","href":"/api-reference/guides/integrate-deferred-deep-linking"},{"group":"Marketing automation","pages":[{"title":"FCM Token Management","href":"/api-reference/guides/fcm-token-management"},{"title":"Attribution Tracking","href":"/api-reference/guides/attribution-tracking"},{"title":"Customer Audience Enrollment","href":"/api-reference/guides/customer-audience-enrollment"},{"title":"Journey Triggers","href":"/api-reference/guides/journey-triggers"}]}]},{"group":"Resources","pages":[{"title":"Resource limits","href":"/api-reference/resources/resource-limits"}]}]}]}]},"title":"Preview order - Masivo","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}