An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header
Indicates if the redeemable resource associated with this reward was also deleted from the remote system. This will only be true if LoyaltyLion manages the resource. For example, when refunding a voucher-based reward with a Shopify store LoyaltyLion will also delete the voucher in Shopify
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"LoyaltyLion","colors":{"primary":"#7533f2","light":"#BEAAFF","dark":"#5C18D6"},"logo":{"light":"https://mintcdn.com/loyaltylion/qoWgzO-fbs5_an5D/logo/loyaltylion-logo-black.svg?fit=max\u0026auto=format\u0026n=qoWgzO-fbs5_an5D\u0026q=85\u0026s=a8042001d5f93ef344ce190752bfba7d","dark":"https://mintcdn.com/loyaltylion/qoWgzO-fbs5_an5D/logo/loyaltylion-logo-white.svg?fit=max\u0026auto=format\u0026n=qoWgzO-fbs5_an5D\u0026q=85\u0026s=37ab9b9089a7e1a44d13df2ae9398de1"},"favicon":"https://mintcdn.com/loyaltylion/qoWgzO-fbs5_an5D/images/favicon.svg?fit=max\u0026auto=format\u0026n=qoWgzO-fbs5_an5D\u0026q=85\u0026s=2d71e6cbb2847c7a83d1d3a4abb6d05e","api":{"playground":{"display":"simple"}},"background":{"color":{}},"navbar":{"links":[{"href":"https://status.loyaltylion.com","label":"Status"},{"href":"https://help.loyaltylion.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.loyaltylion.com"}},"footer":{"socials":{"x":"https://x.com/loyaltylionhq","github":"https://github.com/loyaltylion","linkedin":"https://linkedin.com/company/loyaltylion"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"loyaltylion","hasAudioNarration":false,"actualSubdomain":"loyaltylion","customDomains":["developers.loyaltylion.com"],"gitSource":{"type":"github","owner":"loyaltylion","repo":"dev-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2e52e926281184454cffc","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Admin API","count":67},{"language":"default","tag":"Resources","count":56},{"language":"default","tag":"SDK","count":37},{"language":"default","tag":"Headless API","count":34},{"language":"default","tag":"Webhooks","count":25},{"language":"default","tag":"Webhook events","count":21},{"language":"default","tag":"Embeddable components","count":15},{"language":"default","tag":"Customers","count":13},{"language":"default","tag":"LoyaltyLion SDK","count":13},{"language":"default","tag":"Standalone components","count":12}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".not-prose.mb-6{display:flex;flex-wrap:wrap;gap:0 1.5rem}.not-prose.mb-6>li{margin-left:0!important}"}],"page":{"pagePath":"api-reference/v2/resources/customers/rewards/refund-reward","slug":"/api-reference/v2/resources/customers/rewards/refund-reward","pageMetadata":{"title":"Refund Reward","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/{merchant_id}/claimed_rewards/{claimed_reward_id}/refund","description":null,"href":"/api-reference/v2/resources/customers/rewards/refund-reward"},"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":"Refund Reward","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/{merchant_id}/claimed_rewards/{claimed_reward_id}/refund","description":null,"href":"/api-reference/v2/resources/customers/rewards/refund-reward"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["customers"],"security":["f211d93f-7f78-4f92-9f15-a725163fba16","c0887a6a-cd8f-4b9a-bf64-d1ba20b733f3"],"parameters":["c52ef0e7-8b31-499b-97e7-b784af35c92b","fe1c4deb-55b3-4ffb-9a29-6830f4bcb212"],"operationId":"customers.refundRewardForCustomer","responses":{"200":"c06e12a1-5a2e-4462-a3dc-d39dc3498bc4","400":"cfd8dca5-6d2d-4ae5-80d2-cf37a7ad0fcd","401":"b4f733cd-a60f-436f-ba7d-12962f60c397","403":"6dddddf4-5d37-4c74-819e-78cc67feeb0e","404":"89c53d4a-0b9e-40c9-aef8-2ebb193d63bc"},"method":"post","type":"path","servers":["a8460179-01e1-40c9-803d-13bf195187d2"],"path":"/v2/customers/{merchant_id}/claimed_rewards/{claimed_reward_id}/refund","baseUrlOptions":["https://api.loyaltylion.com"],"title":"","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c52ef0e7-8b31-499b-97e7-b784af35c92b":{"name":"merchant_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The ID of the customer in your platform or ecommerce store","uniqueKey":"","typeLabel":"string"},"description":"The ID of the customer in your platform or ecommerce store"},"fe1c4deb-55b3-4ffb-9a29-6830f4bcb212":{"name":"claimed_reward_id","in":"path","required":true,"schema":{"type":"number","isRequired":true,"description":"The ID of the claimed reward to refund","uniqueKey":"","typeLabel":"number"},"description":"The ID of the claimed reward to refund"}},"responses":{"c06e12a1-5a2e-4462-a3dc-d39dc3498bc4":{"description":"200","content":{"application/json":{"schema":{"type":"object","properties":{"claimed_reward":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.id","typeLabel":"number"},"claimed_at":{"type":"string","description":"`ISO 8601` timestamp indicating when this reward was claimed","isRequired":true,"uniqueKey":"claimed_reward.claimed_at","typeLabel":"string"},"point_cost":{"type":"number","description":"The number of points it cost to claim this reward","isRequired":true,"uniqueKey":"claimed_reward.point_cost","typeLabel":"number"},"redeemable":{"oneOf":[{"type":"object","title":"Fulfilment","required":["redeemable_type","fulfilled","fulfilled_at","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"fulfilment","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0.redeemable_type","typeLabel":"string"},"fulfilled":{"type":"boolean","description":"Indicates if this reward has been fulfilled","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0.fulfilled","typeLabel":"boolean"},"fulfilled_at":{"oneOf":[{"description":"An ISO8601 timestamp representing when the reward was fulfilled, or `null` if it is not yet fulfilled","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0.fulfilled_at.oneOf.0","typeLabel":"string"},{"description":"An ISO8601 timestamp representing when the reward was fulfilled, or `null` if it is not yet fulfilled","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0.fulfilled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0.fulfilled_at","typeLabel":"string | null"},"expires_on":{"type":"null","description":"This field is always null for fulfilment rewards because they do not expire","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0.expires_on","typeLabel":"null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.0","typeLabel":"Fulfilment · object"},{"type":"object","title":"POS Action","required":["redeemable_type","discount_amount","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"pos_action","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.1.redeemable_type","typeLabel":"string"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.1.discount_amount","typeLabel":"number"},"expires_on":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.1.expires_on","typeLabel":"null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.1","typeLabel":"POS Action · object"},{"type":"object","title":"Product","required":["redeemable_type","product","used_at","grant","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"product","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.redeemable_type","typeLabel":"string"},"product":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.product.inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.product.inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.product.inventory_count","typeLabel":"number | null"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.redeemable.oneOf.2.product.id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.image_url","typeLabel":"string"},"sort_key":{"type":"number","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.sort_key","typeLabel":"number"},"title":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.product.handle","typeLabel":"string"}},"required":["inventory_count"],"additionalProperties":false,"description":"Information about the product that was redeemed","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.product","typeLabel":"object"},"used_at":{"oneOf":[{"description":"An ISO 8601 timestamp representing when the product was used","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.used_at.oneOf.0","typeLabel":"string"},{"description":"An ISO 8601 timestamp representing when the product was used","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.used_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.used_at","typeLabel":"string | null"},"grant":{"oneOf":[{"type":"object","description":"Present when the customer was granted this product and has since added it to their cart. `null` for a product the customer redeemed with points or claimed directly","required":["expires_on"],"properties":{"expires_on":{"oneOf":[{"description":"ISO 8601 timestamp of the deadline the grant had for adding the product to the cart, or `null` if the grant had no deadline","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.grant.oneOf.0.expires_on.oneOf.0","typeLabel":"string"},{"description":"ISO 8601 timestamp of the deadline the grant had for adding the product to the cart, or `null` if the grant had no deadline","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.grant.oneOf.0.expires_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.grant.oneOf.0.expires_on","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.grant.oneOf.0","typeLabel":"object"},{"type":"null","description":"Present when the customer was granted this product and has since added it to their cart. `null` for a product the customer redeemed with points or claimed directly","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.grant.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.grant","typeLabel":"object | null"},"expires_on":{"type":"null","description":"This field is always null for product rewards because they do not expire","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2.expires_on","typeLabel":"null"},"shopify_cart_line_item_context":{"description":"If this product was redeemed via a Shopify Script, this will contain the context string that will be added to line item in the cart as a `__lion_context` property","type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.2.shopify_cart_line_item_context","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.2","typeLabel":"Product · object"},{"type":"object","title":"Product grant","required":["redeemable_type","products","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"product_grant","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.redeemable_type","typeLabel":"string"},"products":{"description":"The variants the shopper can add the free product to their cart as, in the reward's own order","type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].inventory_count","typeLabel":"number | null"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].image_url","typeLabel":"string"},"sort_key":{"type":"number","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].sort_key","typeLabel":"number"},"title":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count"],"additionalProperties":false,"uniqueKey":"claimed_reward.redeemable.oneOf.3.products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.products","typeLabel":"object[]"},"expires_on":{"oneOf":[{"description":"ISO 8601 timestamp by which the shopper must add the product to their cart, or `null` if the grant does not expire. Also `null` while the claim is `pending`, as the deadline is set when the trigger approves","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.expires_on.oneOf.0","typeLabel":"string"},{"description":"ISO 8601 timestamp by which the shopper must add the product to their cart, or `null` if the grant does not expire. Also `null` while the claim is `pending`, as the deadline is set when the trigger approves","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.expires_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3.expires_on","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.3","typeLabel":"Product grant · object"},{"type":"object","title":"Gift Card","required":["redeemable_type","code","last_characters","currency","balance","initial_value","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"gift_card","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.redeemable_type","typeLabel":"string"},"code":{"oneOf":[{"description":"The full gift card code. Depending on the context of the API call, this may be `null`","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.code.oneOf.0","typeLabel":"string"},{"description":"The full gift card code. Depending on the context of the API call, this may be `null`","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.code","typeLabel":"string | null"},"last_characters":{"type":"string","description":"The last few characters of the gift card code","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.last_characters","typeLabel":"string"},"currency":{"type":"string","description":"ISO 4217 currency code representing the gift card currency, e.g. `usd`","example":"usd","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.currency","typeLabel":"string"},"balance":{"type":"number","description":"The current balance on the gift card","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.balance","typeLabel":"number"},"initial_value":{"type":"number","description":"The initial balance of the gift card","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.initial_value","typeLabel":"number"},"expires_on":{"oneOf":[{"description":"ISO 8601 timestamp representing when the gift card will expire, or `null` if it does not expire","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.expires_on.oneOf.0","typeLabel":"string"},{"description":"ISO 8601 timestamp representing when the gift card will expire, or `null` if it does not expire","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.expires_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4.expires_on","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.4","typeLabel":"Gift Card · object"},{"type":"object","title":"Voucher","required":["redeemable_type","code","discount_amount","usage_count","usage_limit","used_at","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.redeemable_type","typeLabel":"string"},"code":{"type":"string","description":"The voucher/coupon code that can be applied to a cart","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.code","typeLabel":"string"},"discount_amount":{"type":"number","description":"The discount amount that will be applied to the cart. For flat-rate vouchers, this will be an integer value representing the discount in the primary currency, e.g. $5 will be 5. For percentage vouchers, it will be the percentage discount from 1-100","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.discount_amount","typeLabel":"number"},"usage_count":{"type":"number","description":"The number of times this voucher has been applied. Some voucher types, such as subscription vouchers, may be used multiple times.","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.usage_count","typeLabel":"number"},"usage_limit":{"type":"number","description":"The maximum number of times this voucher may be applied","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.usage_limit","typeLabel":"number"},"used_at":{"oneOf":[{"description":"An ISO 8601 timestamp representing when the voucher was used. If the voucher has been used more than once, this will be the most recent usage","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.used_at.oneOf.0","typeLabel":"string"},{"description":"An ISO 8601 timestamp representing when the voucher was used. If the voucher has been used more than once, this will be the most recent usage","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.used_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.used_at","typeLabel":"string | null"},"expires_on":{"oneOf":[{"description":"ISO 8601 timestamp representing when the voucher will expire, or `null` if it does not expire","type":"string","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.expires_on.oneOf.0","typeLabel":"string"},{"description":"ISO 8601 timestamp representing when the voucher will expire, or `null` if it does not expire","type":"null","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.expires_on.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5.expires_on","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.5","typeLabel":"Voucher · object"},{"type":"object","title":"TikTok Shop coupon","required":["redeemable_type","expires_on"],"properties":{"redeemable_type":{"type":"string","const":"tiktok_coupon","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.6.redeemable_type","typeLabel":"string"},"expires_on":{"type":"null","description":"Always null: the coupon is issued and expires at TikTok Shop, not here","isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.6.expires_on","typeLabel":"null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.redeemable.oneOf.6","typeLabel":"TikTok Shop coupon · object"}],"isRequired":true,"uniqueKey":"claimed_reward.redeemable","typeLabel":"Fulfilment · object | POS Action · object | Product · object | Product grant · object | Gift Card · object | Voucher · object | TikTok Shop coupon · object"},"reward":{"oneOf":[{"type":"object","title":"Active Subscription Discount Voucher","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind","recurring_cycle_limit"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.0.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.point_cost","typeLabel":"number"},"method":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.method","typeLabel":"string"},"discount_type":{"type":"string","enum":["flat","percentage"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.discount_type","typeLabel":"enum\u003cstring>"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"subscription","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.0.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.0.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.0.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.0.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.redeemable_expiry_options","typeLabel":"null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.0.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.0.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"active_subscription_discount_voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.kind","typeLabel":"string"},"recurring_cycle_limit":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.recurring_cycle_limit.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.recurring_cycle_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0.recurring_cycle_limit","typeLabel":"number | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.0","typeLabel":"Active Subscription Discount Voucher · object"},{"type":"object","title":"Product (cart)","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.sort_key","typeLabel":"number"},"content":{"type":"object","properties":{"featured_image_url":{"oneOf":[{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.content.featured_image_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"claimed_reward.reward.oneOf.1.content.featured_image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_reward.reward.oneOf.1.content.featured_image_url","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.point_cost","typeLabel":"number"},"method":{"type":"string","enum":["buy_with_points","function"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.method","typeLabel":"enum\u003cstring>"},"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.discount_type","typeLabel":"string"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"product","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.1.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.1.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.1.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.1.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.target_products","typeLabel":"object[]"},"session_options":{"type":"object","properties":{"kind":{"type":"string","const":"cart","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.session_options.kind","typeLabel":"string"},"session_limit":{"oneOf":[{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.session_options.session_limit.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.session_options.session_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.session_options.session_limit","typeLabel":"number | null"}},"required":["kind","session_limit"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.session_options","typeLabel":"object"},"auto_refund_seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.auto_refund_seconds","typeLabel":"number"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"duration","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.expiry_options.seconds","typeLabel":"number"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.redeemable_expiry_options","typeLabel":"null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.1.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.1.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"product_cart","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.kind","typeLabel":"string"},"minimum_requirements":{"oneOf":[{"type":"object","title":"Cost","required":["type","cost"],"properties":{"type":{"type":"string","const":"cost","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.0.type","typeLabel":"string"},"cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.0.cost","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.0","typeLabel":"Cost · object"},{"type":"object","title":"Quantity","required":["type","quantity"],"properties":{"type":{"type":"string","const":"quantity","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.1.type","typeLabel":"string"},"quantity":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.1.quantity","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.1","typeLabel":"Quantity · object"},{"type":"null","uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements.oneOf.2","typeLabel":"null"}],"uniqueKey":"claimed_reward.reward.oneOf.1.minimum_requirements","typeLabel":"Cost · object | Quantity · object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.1","typeLabel":"Product (cart) · object"},{"type":"object","title":"Cart Discount Voucher","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind","recurring_cycle_limit"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.2.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.point_cost","typeLabel":"number"},"method":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.method","typeLabel":"string"},"discount_type":{"type":"string","enum":["flat","percentage"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.discount_type","typeLabel":"enum\u003cstring>"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_site","typeLabel":"object"},"order_type":{"type":"string","enum":["all","one_time","subscription"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.order_type","typeLabel":"enum\u003cstring>"},"target_type":{"type":"string","enum":["all","collection"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_type","typeLabel":"enum\u003cstring>"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.2.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.2.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.2.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.2.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"oneOf":[{"type":"object","required":["after_duration"],"properties":{"after_duration":{"type":"object","properties":{"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.redeemable_expiry_options.oneOf.0.after_duration.seconds","typeLabel":"number"}},"required":["seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.redeemable_expiry_options.oneOf.0.after_duration","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.redeemable_expiry_options.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.redeemable_expiry_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.redeemable_expiry_options","typeLabel":"object | null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.2.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.2.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"cart_discount_voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.kind","typeLabel":"string"},"recurring_cycle_limit":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.recurring_cycle_limit.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.recurring_cycle_limit.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2.recurring_cycle_limit","typeLabel":"number | null"},"supports_active_subscriptions":{"type":"boolean","uniqueKey":"claimed_reward.reward.oneOf.2.supports_active_subscriptions","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.2","typeLabel":"Cart Discount Voucher · object"},{"type":"object","title":"Checkout Redemption Reward","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind","redemption_amount_step","fixed_redemption_amounts","fixed_redemption_amount_min_spends","min_spend_after_discount","min_spend_before_discount"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.3.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.point_cost","typeLabel":"number"},"method":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.method","typeLabel":"string"},"discount_type":{"type":"string","const":"flat","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.discount_type","typeLabel":"string"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.discount_amount","typeLabel":"number"},"minimum_spend":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.minimum_spend","typeLabel":"null"},"usage_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_site","typeLabel":"object"},"order_type":{"type":"string","enum":["all","one_time"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.order_type","typeLabel":"enum\u003cstring>"},"target_type":{"type":"string","enum":["all","collection"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_type","typeLabel":"enum\u003cstring>"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.3.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.3.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.3.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.3.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.target_products","typeLabel":"object[]"},"session_options":{"type":"object","properties":{"kind":{"type":"string","const":"checkout","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.session_options.kind","typeLabel":"string"},"session_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.session_options.session_limit","typeLabel":"number"}},"required":["kind","session_limit"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.session_options","typeLabel":"object"},"auto_refund_seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.auto_refund_seconds","typeLabel":"number"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"duration","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.expiry_options.seconds","typeLabel":"number"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.redeemable_expiry_options","typeLabel":"null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.3.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.3.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"checkout_redemption","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.kind","typeLabel":"string"},"redemption_amount_step":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.redemption_amount_step.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.redemption_amount_step.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.redemption_amount_step","typeLabel":"number | null"},"fixed_redemption_amounts":{"oneOf":[{"type":"array","items":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amounts.oneOf.0.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amounts.oneOf.0","typeLabel":"number[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amounts.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amounts","typeLabel":"number[] | null"},"fixed_redemption_amount_min_spends":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.0.items.[INDEX].amount","typeLabel":"number"},"min_spend_before_discount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.0.items.[INDEX].min_spend_before_discount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.0.items.[INDEX].min_spend_before_discount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.0.items.[INDEX].min_spend_before_discount","typeLabel":"number | null"}},"required":["amount","min_spend_before_discount"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.0","typeLabel":"object[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.fixed_redemption_amount_min_spends","typeLabel":"object[] | null"},"min_spend_after_discount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_spend_after_discount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_spend_after_discount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_spend_after_discount","typeLabel":"number | null"},"min_spend_before_discount":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_spend_before_discount.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_spend_before_discount.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3.min_spend_before_discount","typeLabel":"number | null"},"hide_unavailable_discounts":{"type":"boolean","uniqueKey":"claimed_reward.reward.oneOf.3.hide_unavailable_discounts","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.3","typeLabel":"Checkout Redemption Reward · object"},{"type":"object","title":"Collection Voucher","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.4.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.point_cost","typeLabel":"number"},"method":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.method","typeLabel":"string"},"discount_type":{"type":"string","enum":["flat","percentage"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.discount_type","typeLabel":"enum\u003cstring>"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"collection","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.4.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.4.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.4.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.4.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"oneOf":[{"type":"object","required":["after_duration"],"properties":{"after_duration":{"type":"object","properties":{"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.redeemable_expiry_options.oneOf.0.after_duration.seconds","typeLabel":"number"}},"required":["seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.redeemable_expiry_options.oneOf.0.after_duration","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.redeemable_expiry_options.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.redeemable_expiry_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.redeemable_expiry_options","typeLabel":"object | null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.4.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.4.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"collection_discount_voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.4","typeLabel":"Collection Voucher · object"},{"type":"object","title":"Custom Reward","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.sort_key","typeLabel":"number"},"content":{"type":"object","properties":{"fulfilment_instructions":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.content.fulfilment_instructions.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.content.fulfilment_instructions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.content.fulfilment_instructions","typeLabel":"string | null"},"featured_image_url":{"oneOf":[{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.content.featured_image_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"claimed_reward.reward.oneOf.5.content.featured_image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_reward.reward.oneOf.5.content.featured_image_url","typeLabel":"string | null"}},"required":["fulfilment_instructions"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.point_cost","typeLabel":"number"},"method":{"type":"string","enum":["store_fulfilment","voucher"],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.method","typeLabel":"enum\u003cstring>"},"discount_type":{"type":"string","const":"custom","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.discount_type","typeLabel":"string"},"discount_amount":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.discount_amount","typeLabel":"null"},"minimum_spend":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.minimum_spend","typeLabel":"null"},"usage_limit":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"custom","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.5.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.5.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.5.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.5.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.redeemable_expiry_options","typeLabel":"null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.5.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.5.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"custom","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.5","typeLabel":"Custom Reward · object"},{"type":"object","title":"Free Shipping Voucher","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.6.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.point_cost","typeLabel":"number"},"method":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.method","typeLabel":"string"},"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.discount_type","typeLabel":"string"},"discount_amount":{"type":"number","const":100,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.max_free_shipping.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.max_free_shipping.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.max_free_shipping","typeLabel":"number | null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"shipping","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.6.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.6.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.6.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.6.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"oneOf":[{"type":"object","required":["after_duration"],"properties":{"after_duration":{"type":"object","properties":{"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.redeemable_expiry_options.oneOf.0.after_duration.seconds","typeLabel":"number"}},"required":["seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.redeemable_expiry_options.oneOf.0.after_duration","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.redeemable_expiry_options.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.redeemable_expiry_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.redeemable_expiry_options","typeLabel":"object | null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.6.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.6.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"free_shipping_voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.6","typeLabel":"Free Shipping Voucher · object"},{"type":"object","title":"Gift Card","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.7.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.point_cost","typeLabel":"number"},"method":{"type":"string","const":"gift_card","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.method","typeLabel":"string"},"discount_type":{"type":"string","const":"flat","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.discount_type","typeLabel":"string"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.discount_amount","typeLabel":"number"},"minimum_spend":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.minimum_spend","typeLabel":"null"},"usage_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.7.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.7.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.7.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.7.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"oneOf":[{"type":"object","required":["after_duration"],"properties":{"after_duration":{"type":"object","properties":{"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.redeemable_expiry_options.oneOf.0.after_duration.seconds","typeLabel":"number"}},"required":["seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.redeemable_expiry_options.oneOf.0.after_duration","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.redeemable_expiry_options.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.redeemable_expiry_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.redeemable_expiry_options","typeLabel":"object | null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.7.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.7.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"gift_card","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.7","typeLabel":"Gift Card · object"},{"type":"object","title":"Product (voucher)","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.sort_key","typeLabel":"number"},"content":{"type":"object","properties":{"featured_image_url":{"oneOf":[{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.content.featured_image_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"claimed_reward.reward.oneOf.8.content.featured_image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"claimed_reward.reward.oneOf.8.content.featured_image_url","typeLabel":"string | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.point_cost","typeLabel":"number"},"method":{"type":"string","const":"voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.method","typeLabel":"string"},"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.discount_type","typeLabel":"string"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"all","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"product","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.8.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.8.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.8.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.8.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.auto_refund_seconds","typeLabel":"null"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"does_not_expire","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.expiry_options.seconds","typeLabel":"null"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"oneOf":[{"type":"object","required":["after_duration"],"properties":{"after_duration":{"type":"object","properties":{"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.redeemable_expiry_options.oneOf.0.after_duration.seconds","typeLabel":"number"}},"required":["seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.redeemable_expiry_options.oneOf.0.after_duration","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.redeemable_expiry_options.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.redeemable_expiry_options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.redeemable_expiry_options","typeLabel":"object | null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.8.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.8.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"product_discount_voucher","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.8","typeLabel":"Product (voucher) · object"},{"type":"object","title":"Product (subscription)","required":["id","title","title_template","description","sort_key","content","point_cost","method","discount_type","discount_amount","minimum_spend","usage_limit","min_redemption_amount","max_redemption_amount","max_free_shipping","site_id","target_site","order_type","target_type","target_collections","target_products","session_options","auto_refund_seconds","expiry_options","redeemable_expiry_options","supported_channels","available_countries","kind"],"properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.id","typeLabel":"number"},"title":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.title","typeLabel":"string"},"title_template":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.title_template.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.title_template.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.title_template","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.description.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.description","typeLabel":"string | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.sort_key","typeLabel":"number"},"content":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"claimed_reward.reward.oneOf.9.content.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.content","typeLabel":"object"},"point_cost":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.point_cost","typeLabel":"number"},"method":{"type":"string","const":"subscription_buy_with_points","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.method","typeLabel":"string"},"discount_type":{"type":"string","const":"percentage","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.discount_type","typeLabel":"string"},"discount_amount":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.discount_amount","typeLabel":"number"},"minimum_spend":{"oneOf":[{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.minimum_spend.oneOf.0","typeLabel":"number"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.minimum_spend.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.minimum_spend","typeLabel":"number | null"},"usage_limit":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.usage_limit","typeLabel":"number"},"min_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.min_redemption_amount","typeLabel":"number"},"max_redemption_amount":{"type":"number","const":1,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.max_redemption_amount","typeLabel":"number"},"max_free_shipping":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.max_free_shipping","typeLabel":"null"},"site_id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.site_id","typeLabel":"number"},"target_site":{"type":"object","properties":{"id":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_site.id","typeLabel":"number"},"name":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_site.name","typeLabel":"string"},"url":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_site.url","typeLabel":"string"}},"required":["id","name","url"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_site","typeLabel":"object"},"order_type":{"type":"string","const":"subscription","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.order_type","typeLabel":"string"},"target_type":{"type":"string","const":"product","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_type","typeLabel":"string"},"target_collections":{"type":"array","items":{"type":"object","properties":{"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.9.target_collections.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_collections.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.9.target_collections.items.[INDEX].id","typeLabel":"number | string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_collections.items.[INDEX].url","typeLabel":"string"},"restriction_text":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_collections.items.[INDEX].restriction_text","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.9.target_collections.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_collections","typeLabel":"object[]"},"target_products":{"type":"array","items":{"type":"object","properties":{"inventory_count":{"oneOf":[{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].inventory_count.oneOf.0","typeLabel":"number"},{"description":"The current inventory count of this product variant, or `null` if inventory is not tracked. If the count is zero, you should ensure it is not selectable by customers when redeeming the reward","type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].inventory_count.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].inventory_count","typeLabel":"number | null"},"sort_key":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].sort_key","typeLabel":"number"},"id":{"oneOf":[{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].id.oneOf.0","typeLabel":"number"},{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].id.oneOf.1","typeLabel":"string"}],"uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].id","typeLabel":"number | string"},"variant_id":{"type":"number","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].variant_id","typeLabel":"number"},"sku":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].sku","typeLabel":"string"},"url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].url","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].image_url","typeLabel":"string"},"title":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].title","typeLabel":"string"},"handle":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX].handle","typeLabel":"string"}},"required":["inventory_count","sort_key"],"additionalProperties":false,"uniqueKey":"claimed_reward.reward.oneOf.9.target_products.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.target_products","typeLabel":"object[]"},"session_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.session_options","typeLabel":"null"},"auto_refund_seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.auto_refund_seconds","typeLabel":"number"},"expiry_options":{"type":"object","properties":{"kind":{"type":"string","const":"duration","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.expiry_options.kind","typeLabel":"string"},"seconds":{"type":"number","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.expiry_options.seconds","typeLabel":"number"}},"required":["kind","seconds"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.expiry_options","typeLabel":"object"},"redeemable_expiry_options":{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.redeemable_expiry_options","typeLabel":"null"},"supported_channels":{"type":"array","items":{"type":"string","enum":["web","pos","mobile"],"uniqueKey":"claimed_reward.reward.oneOf.9.supported_channels.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.supported_channels","typeLabel":"enum\u003cstring>[]"},"available_countries":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"claimed_reward.reward.oneOf.9.available_countries.oneOf.0.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.available_countries.oneOf.0","typeLabel":"string[]"},{"type":"null","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.available_countries.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.available_countries","typeLabel":"string[] | null"},"kind":{"type":"string","const":"subscription_buy_with_points","isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9.kind","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.reward.oneOf.9","typeLabel":"Product (subscription) · object"}],"isRequired":true,"uniqueKey":"claimed_reward.reward","typeLabel":"Active Subscription Discount Voucher · object | Product (cart) · object | Cart Discount Voucher · object | Checkout Redemption Reward · object | Collection Voucher · object | Custom Reward · object | Free Shipping Voucher · object | Gift Card · object | Product (voucher) · object | Product (subscription) · object"},"state":{"type":"string","enum":["approved","declined","expired","pending","void"],"isRequired":true,"uniqueKey":"claimed_reward.state","typeLabel":"enum\u003cstring>"},"session":{"oneOf":[{"type":"object","description":"For session-based rewards, this includes information about the session in which the reward was claimed","required":["kind","token"],"properties":{"kind":{"type":"string","enum":["cart","checkout","custom","draft_order"],"isRequired":true,"uniqueKey":"claimed_reward.session.oneOf.0.kind","typeLabel":"enum\u003cstring>"},"token":{"type":"string","isRequired":true,"uniqueKey":"claimed_reward.session.oneOf.0.token","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward.session.oneOf.0","typeLabel":"object"},{"type":"null","description":"For session-based rewards, this includes information about the session in which the reward was claimed","isRequired":true,"uniqueKey":"claimed_reward.session.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.session","typeLabel":"object | null"},"auto_refund_at":{"oneOf":[{"description":"`ISO 8601` timestamp indicating when this reward will automatically be voided and refunded if it has not yet been used, or `null` if not applicable","type":"string","isRequired":true,"uniqueKey":"claimed_reward.auto_refund_at.oneOf.0","typeLabel":"string"},{"description":"`ISO 8601` timestamp indicating when this reward will automatically be voided and refunded if it has not yet been used, or `null` if not applicable","type":"null","isRequired":true,"uniqueKey":"claimed_reward.auto_refund_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.auto_refund_at","typeLabel":"string | null"},"expires_at":{"oneOf":[{"deprecated":true,"description":"Deprecated in favour of `auto_refund_at`","type":"string","isRequired":true,"uniqueKey":"claimed_reward.expires_at.oneOf.0","typeLabel":"string"},{"deprecated":true,"description":"Deprecated in favour of `auto_refund_at`","type":"null","isRequired":true,"uniqueKey":"claimed_reward.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"claimed_reward.expires_at","typeLabel":"string | null"}},"required":["id","claimed_at","point_cost","redeemable","reward","state","session","auto_refund_at","expires_at"],"additionalProperties":false,"isRequired":true,"uniqueKey":"claimed_reward","typeLabel":"object"},"remote_resource_deleted":{"type":"boolean","description":"Indicates if the redeemable resource associated with this reward was also deleted from the remote system. This will only be `true` if LoyaltyLion manages the resource. For example, when refunding a voucher-based reward with a Shopify store LoyaltyLion will also delete the voucher in Shopify","isRequired":true,"uniqueKey":"remote_resource_deleted","typeLabel":"boolean"}},"required":["claimed_reward","remote_resource_deleted"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"claimed_reward":{"id":123,"claimed_at":"\u003cstring>","point_cost":123,"redeemable":{"redeemable_type":"fulfilment","fulfilled":true,"fulfilled_at":"\u003cstring>","expires_on":null},"reward":{"id":123,"title":"\u003cstring>","title_template":"\u003cstring>","description":"\u003cstring>","sort_key":123,"content":{},"point_cost":123,"method":"voucher","discount_type":"flat","discount_amount":123,"minimum_spend":123,"usage_limit":123,"min_redemption_amount":1,"max_redemption_amount":1,"max_free_shipping":null,"site_id":123,"target_site":{"id":123,"name":"\u003cstring>","url":"\u003cstring>"},"order_type":"subscription","target_type":"all","target_collections":[{"id":123,"url":"\u003cstring>","restriction_text":"\u003cstring>"}],"target_products":[{"inventory_count":123,"sort_key":123,"id":123,"variant_id":123,"sku":"\u003cstring>","url":"\u003cstring>","image_url":"\u003cstring>","title":"\u003cstring>","handle":"\u003cstring>"}],"session_options":null,"auto_refund_seconds":null,"expiry_options":{"kind":"does_not_expire","seconds":null},"redeemable_expiry_options":null,"supported_channels":["web"],"available_countries":["\u003cstring>"],"kind":"active_subscription_discount_voucher","recurring_cycle_limit":123},"state":"approved","session":{"kind":"cart","token":"\u003cstring>"},"auto_refund_at":"\u003cstring>","expires_at":"\u003cstring>"},"remote_resource_deleted":true}}},"exampleType":"generated"}},"exampleType":"generated"},"cfd8dca5-6d2d-4ae5-80d2-cf37a7ad0fcd":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"b4f733cd-a60f-436f-ba7d-12962f60c397":{"description":"401","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"6dddddf4-5d37-4c74-819e-78cc67feeb0e":{"description":"403","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"details":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":"\u003cstring>","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"89c53d4a-0b9e-40c9-aef8-2ebb193d63bc":{"description":"404","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"}},"required":["error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f211d93f-7f78-4f92-9f15-a725163fba16":{"ProgramApiKey":{"type":"http","scheme":"bearer","description":"An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a `Bearer` token in the `Authorization` header","scopes":["write_customers"],"schemeName":"ProgramApiKey"}},"c0887a6a-cd8f-4b9a-bf64-d1ba20b733f3":{"SiteTokenSecret":{"type":"http","scheme":"basic","description":"[DEPRECATED] Authenticate using a LoyaltyLion site's `token` as username, and its `secret` as the password. This authentication method is deprecated and will be removed in future. Use the `ProgramApiKey` authentication method instead","scopes":[],"schemeName":"SiteTokenSecret"}}},"servers":{"a8460179-01e1-40c9-803d-13bf195187d2":{"url":"https://api.loyaltylion.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a `Bearer` token in the `Authorization` header","scopes":["write_customers"],"schemeName":"ProgramApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a `Bearer` token in the `Authorization` header","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ProgramApiKey","name":"Authorization"}],"title":"ProgramApiKey"},{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"[DEPRECATED] Authenticate using a LoyaltyLion site's `token` as username, and its `secret` as the password. This authentication method is deprecated and will be removed in future. Use the `ProgramApiKey` authentication method instead","scopes":[],"schemeName":"SiteTokenSecret"},"schema":{"title":"Basic Auth","type":"object","description":"[DEPRECATED] Authenticate using a LoyaltyLion site's `token` as username, and its `secret` as the password. This authentication method is deprecated and will be removed in future. Use the `ProgramApiKey` authentication method instead","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"SiteTokenSecret","name":"Authorization"}],"title":"SiteTokenSecret"}]},"originalFileLocation":"api-reference/v2/openapi.json"},"subdomain":"loyaltylion","siteName":"LoyaltyLion","title":"Refund Reward - LoyaltyLion","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/v2/resources/customers/rewards/refund-reward","matchLevel":0},"2025-06":{"href":"/headless-api/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-10-31T16:10:27.591Z","originalFileLocation":"api-reference/v2/resources/customers/rewards/refund-reward.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=\"application-name\" content=\"LoyaltyLion\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_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/loyaltylion/-HHkKRQ0-0oU9Wqj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Refund Reward - LoyaltyLion\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"LoyaltyLion\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://loyaltylion.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Refund+Reward\u0026amp;theme=876105ba0b4007d402979f34\u0026amp;signature=ad36067bcb9ce1de98f7710dc2de9684d8952699b17c3f4f28acb1c379277ff3\">\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=\"Refund Reward - LoyaltyLion\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://loyaltylion.mintlify.site/_mintlify/api/og/v2?division=Customers\u0026amp;title=Refund+Reward\u0026amp;theme=876105ba0b4007d402979f34\u0026amp;signature=ad36067bcb9ce1de98f7710dc2de9684d8952699b17c3f4f28acb1c379277ff3\">\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/loyaltylion/-HHkKRQ0-0oU9Wqj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"LoyaltyLion\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7533f2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/resources/customers/rewards/refund-reward.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.loyaltylion.com/#organization\",\"name\":\"LoyaltyLion\",\"url\":\"https://developers.loyaltylion.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/loyaltylion/qoWgzO-fbs5_an5D/logo/loyaltylion-logo-black.svg?fit=max\u0026auto=format\u0026n=qoWgzO-fbs5_an5D\u0026q=85\u0026s=a8042001d5f93ef344ce190752bfba7d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.loyaltylion.com#website\",\"name\":\"LoyaltyLion\",\"url\":\"https://developers.loyaltylion.com\",\"publisher\":{\"@id\":\"https://developers.loyaltylion.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward#webpage\",\"url\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward\",\"name\":\"Refund Reward\",\"dateModified\":\"2026-10-31T16:10:27.591Z\",\"isPartOf\":{\"@id\":\"https://developers.loyaltylion.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Resources\",\"item\":\"https://developers.loyaltylion.com/api-reference/v2/resources/whoami\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/list-customers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Refund Reward\",\"item\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward#apireference\",\"headline\":\"Refund Reward\",\"name\":\"Refund Reward\",\"url\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward\",\"mainEntityOfPage\":{\"@id\":\"https://developers.loyaltylion.com/api-reference/v2/resources/customers/rewards/refund-reward#webpage\"},\"dateModified\":\"2026-10-31T16:10:27.591Z\",\"publisher\":{\"@id\":\"https://developers.loyaltylion.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.loyaltylion.com#website\"}}]}\u003c/script>","agentPointerHref":"/api-reference/v2/resources/customers/rewards/refund-reward.md","siteName":"LoyaltyLion","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/introduction"}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/overview"}]},{"tab":"Admin API","versions":[{"version":"v2","default":true,"groups":[{"group":"Admin API","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Authentication","pages":[{"title":"Overview","href":"/api-reference/authentication/overview"},{"title":"API keys","href":"/api-reference/authentication/api-keys"},{"title":"OAuth","href":"/api-reference/authentication/oauth"},{"title":"Token \u0026 secret (deprecated)","href":"/api-reference/authentication/token-secret"}]},{"title":"Pagination","href":"/api-reference/pagination"}]},{"group":"Resources","pages":[{"group":"Identity","pages":[{"title":"Who Am I","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/identity/whoami","href":"/api-reference/v2/resources/whoami"}]},{"group":"Customers","pages":[{"title":"List Customers","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/customers","href":"/api-reference/v2/resources/customers/list-customers"},{"title":"Update Customer","version":"v2","openapi":"api-reference/v2/openapi.json PATCH /v2/customers/{merchant_id}","href":"/api-reference/v2/resources/customers/update-customer"},{"title":"Add Points","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/{merchant_id}/points","href":"/api-reference/v2/resources/customers/add-points"},{"title":"Remove Points","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/{merchant_id}/remove_points","href":"/api-reference/v2/resources/customers/remove-points"},{"title":"List Available Rewards","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/customers/{merchant_id}/available_rewards","href":"/api-reference/v2/resources/customers/rewards/list-available-rewards"},{"title":"Redeem Reward","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/{merchant_id}/claimed_rewards","description":null,"href":"/api-reference/v2/resources/customers/rewards/redeem-reward"},{"title":"Refund Reward","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/{merchant_id}/claimed_rewards/{claimed_reward_id}/refund","href":"/api-reference/v2/resources/customers/rewards/refund-reward"},{"title":"List Transactions","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/customers/{merchant_id}/transactions","description":null,"href":"/api-reference/v2/resources/customers/list-transactions"}]},{"group":"Activities","pages":[{"title":"List Activities","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/activities","href":"/api-reference/v2/resources/activities/list-activities"},{"title":"Create Activity","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/activities","href":"/api-reference/v2/resources/activities/create-activity"},{"title":"Update Activity","version":"v2","openapi":"api-reference/v2/openapi.json PUT /v2/activities/{name}/{merchant_id}","href":"/api-reference/v2/resources/activities/update-activity"}]},{"group":"Transactions","pages":[{"title":"List Transactions","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/transactions","href":"/api-reference/v2/resources/transactions/list-transactions"}]},{"group":"Orders","pages":[{"title":"List Orders","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/orders","href":"/api-reference/v2/resources/orders/list-orders"},{"title":"Get Order","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/orders/{merchant_id}","href":"/api-reference/v2/resources/orders/get-order"},{"title":"Create Order","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/orders","href":"/api-reference/v2/resources/orders/create-order"},{"title":"Update Order","version":"v2","openapi":"api-reference/v2/openapi.json PUT /v2/orders/{merchant_id}","href":"/api-reference/v2/resources/orders/update-order"}]},{"group":"Sites","pages":[{"title":"List Sites","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/sites","href":"/api-reference/v2/resources/sites/list-sites"},{"title":"Create WebView Session","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/sites/{site_id}/webviews/sessions","href":"/api-reference/v2/resources/sites/create-webview-session"}]},{"group":"Reviews","pages":[{"title":"Create Review","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/reviews/{platform}","href":"/api-reference/v2/resources/reviews/create-review"},{"title":"Update Review","version":"v2","openapi":"api-reference/v2/openapi.json PUT /v2/reviews/{platform}/{merchant_id}","href":"/api-reference/v2/resources/reviews/update-review"},{"title":"Delete Review","version":"v2","openapi":"api-reference/v2/openapi.json DELETE /v2/reviews/{platform}/{merchant_id}","href":"/api-reference/v2/resources/reviews/delete-review"}]},{"group":"Rewards","pages":[{"title":"Enable Reward","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/rewards/{reward_id}/enable","href":"/api-reference/v2/resources/rewards/enable-reward"},{"title":"Disable Reward","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/rewards/{reward_id}/disable","href":"/api-reference/v2/resources/rewards/disable-reward"}]},{"group":"Emails","pages":[{"title":"List Unsubscribes","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/loyalty_emails/unsubscribes","href":"/api-reference/v2/resources/emails/list-unsubscribes"},{"title":"Create Unsubscribe","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/loyalty_emails/unsubscribes","href":"/api-reference/v2/resources/emails/create-unsubscribe"}]},{"group":"Exports","pages":[{"title":"Customer exports","version":"v2","href":"/api-reference/v2/resources/customers/exports/overview"},{"title":"Create Export","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/customers/exports","href":"/api-reference/v2/resources/customers/exports/create-export"},{"title":"Get Export","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/customers/exports/{id}","href":"/api-reference/v2/resources/customers/exports/get-export"},{"title":"List Exports","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/customers/exports","href":"/api-reference/v2/resources/customers/exports/list-exports"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","version":"v2","openapi":"api-reference/v2/openapi.json GET /v2/webhooks","href":"/api-reference/v2/resources/webhooks/list-webhooks"},{"title":"Create Webhook","version":"v2","openapi":"api-reference/v2/openapi.json POST /v2/webhooks","href":"/api-reference/v2/resources/webhooks/create-webhook"},{"title":"Delete Webhook","version":"v2","openapi":"api-reference/v2/openapi.json DELETE /v2/webhooks/{webhook_id}","href":"/api-reference/v2/resources/webhooks/delete-webhook"}]}]},{"group":"Webhooks","pages":[{"title":"Introduction","href":"/api-reference/v2/webhooks/overview"},{"group":"Webhook events","pages":[{"title":"customers/update","href":"/api-reference/v2/webhooks/events/customers-update"},{"title":"loyalty_emails/unsubscribe","href":"/api-reference/v2/webhooks/events/loyalty-emails-unsubscribe"},{"title":"rewards/store_fulfilment","href":"/api-reference/v2/webhooks/events/rewards-store-fulfilment"},{"title":"receipts/manual_approval_required","href":"/api-reference/v2/webhooks/events/receipts-manual-approval-required"},{"title":"program_events/customer.enrolled","href":"/api-reference/v2/webhooks/events/program-events/customer-enrolled"},{"title":"program_events/customer.tier_upgraded","href":"/api-reference/v2/webhooks/events/program-events/customer-tier-upgraded"},{"title":"program_events/customer.tier_downgraded","href":"/api-reference/v2/webhooks/events/program-events/customer-tier-downgraded"},{"title":"program_events/customer.reward_available_notification","href":"/api-reference/v2/webhooks/events/program-events/customer-reward-available-notification"},{"title":"program_events/customer.recurring_reward_available_reminder","href":"/api-reference/v2/webhooks/events/program-events/customer-recurring-reward-available-reminder"},{"title":"program_events/customer.claimed_reward","href":"/api-reference/v2/webhooks/events/program-events/customer-claimed-reward"},{"title":"program_events/customer.points_earned","href":"/api-reference/v2/webhooks/events/program-events/customer-points-earned"},{"title":"program_events/customer.referral_complete","href":"/api-reference/v2/webhooks/events/program-events/customer-referral-complete"},{"title":"program_events/customer.rule_completed","href":"/api-reference/v2/webhooks/events/program-events/customer-rule-completed"},{"title":"program_events/customer.approaching_tier_upgrade","href":"/api-reference/v2/webhooks/events/program-events/customers-approaching-tier-upgrade"},{"title":"program_events/customer.moved_to_defected_segment","href":"/api-reference/v2/webhooks/events/program-events/customer-moved-to-defected-segment"},{"title":"program_events/customer.moved_to_loyal_segment","href":"/api-reference/v2/webhooks/events/program-events/customer-moved-to-loyal-segment"},{"title":"program_events/customer.moved_to_at_risk_segment","href":"/api-reference/v2/webhooks/events/program-events/customer-moved-to-at-risk-segment"},{"title":"program_events/customer.approaching_points_expiration","href":"/api-reference/v2/webhooks/events/program-events/customer-approaching-points-expiration"},{"title":"program_events/customer.approaching_reward_expiration","href":"/api-reference/v2/webhooks/events/program-events/customer-approaching-reward-expiration"},{"title":"program_events/customer.receipt_approved","href":"/api-reference/v2/webhooks/events/program-events/customer-receipt-approved"},{"title":"program_events/customer.receipt_declined","href":"/api-reference/v2/webhooks/events/program-events/customer-receipt-declined"}]}]}]}]},{"tab":"Headless API","versions":[{"version":"2025-06","default":true,"groups":[{"group":"Headless API","pages":[{"title":"Introduction","href":"/headless-api/introduction"},{"title":"Customer session tokens","href":"/headless-api/session-tokens"},{"title":"Errors","href":"/headless-api/errors"},{"title":"Changelog","href":"/headless-api/changelog"}]},{"group":"Guides","pages":[{"title":"Referrals","href":"/headless-api/guides/referrals"},{"group":"Shopify Hydrogen","pages":[{"title":"Integrate with Hydrogen","href":"/headless-api/guides/hydrogen/integrate"},{"title":"Free product rewards","href":"/headless-api/guides/hydrogen/free-product-rewards"}]}]},{"group":"Resources","pages":[{"group":"Configuration","pages":[{"title":"Get Configuration","version":"v2","openapi":"headless-api/2025-06/openapi.json GET /headless/2025-06/{site_id}/configuration","href":"/headless-api/2025-06/configuration/get-configuration"}]},{"group":"Customers","pages":[{"title":"Get Customer","version":"v2","openapi":"headless-api/2025-06/openapi.json GET /headless/2025-06/{site_id}/customers/{merchant_id}","href":"/headless-api/2025-06/customers/get-customer"},{"title":"Initialize Session","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/customers/{merchant_id}/sessions","href":"/headless-api/2025-06/customers/initialize-session"},{"title":"Enroll Customer","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/customers/{merchant_id}/enroll","href":"/headless-api/2025-06/customers/enroll-customer"},{"title":"Set Birthday","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/customers/{merchant_id}/birthday","href":"/headless-api/2025-06/customers/set-birthday"},{"title":"Subscribe to Email Marketing","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/customers/{merchant_id}/email_marketing/subscribe","href":"/headless-api/2025-06/customers/subscribe-email-marketing"}]},{"group":"Referrals","pages":[{"title":"Claim Referee Incentive","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/referrals/referee_incentive","href":"/headless-api/2025-06/referrals/claim-referee-incentive"},{"title":"Track Share","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/referrals/shares","href":"/headless-api/2025-06/referrals/track-share"},{"title":"Register Guest Referrer","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/referrals/guest_registrations","href":"/headless-api/2025-06/referrals/register-guest-referrer"}]},{"group":"Reward redemption","pages":[{"title":"Cart Discount Voucher","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/cart_discount_voucher/redeem","href":"/headless-api/2025-06/reward-redemption/cart-discount-voucher"},{"title":"Free Shipping Voucher","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/free_shipping_voucher/redeem","href":"/headless-api/2025-06/reward-redemption/free-shipping-voucher"},{"title":"Collection Discount Voucher","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/collection_discount_voucher/redeem","href":"/headless-api/2025-06/reward-redemption/collection-discount-voucher"},{"title":"Product Discount Voucher","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/product_discount_voucher/redeem","href":"/headless-api/2025-06/reward-redemption/product-discount-voucher"},{"title":"Gift Card","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/gift_card/redeem","href":"/headless-api/2025-06/reward-redemption/gift-card"},{"title":"Active Subscription Discount Voucher","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/active_subscription_discount_voucher/redeem","href":"/headless-api/2025-06/reward-redemption/active-subscription-discount-voucher"},{"title":"Active Subscription Product","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/active_subscription_product/redeem","href":"/headless-api/2025-06/reward-redemption/active-subscription-product"},{"title":"Free Product","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/product_cart/redeem","href":"/headless-api/2025-06/reward-redemption/free-product"}]},{"group":"Reward refunds","pages":[{"title":"Free Product","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rewards/product_cart/refund","href":"/headless-api/2025-06/reward-refund/free-product"}]},{"group":"Complete rules","pages":[{"title":"Clickthrough","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rules/clickthrough/complete","href":"/headless-api/2025-06/complete-rules/clickthrough"},{"title":"Facebook Like","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rules/facebook_like/complete","href":"/headless-api/2025-06/complete-rules/facebook-like"},{"title":"Instagram Follow","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rules/instagram_follow/complete","href":"/headless-api/2025-06/complete-rules/instagram-follow"},{"title":"TikTok Follow","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rules/tiktok_follow/complete","href":"/headless-api/2025-06/complete-rules/tiktok-follow"},{"title":"Twitter/X Follow","version":"v2","openapi":"headless-api/2025-06/openapi.json POST /headless/2025-06/{site_id}/rules/twitter_follow/complete","href":"/headless-api/2025-06/complete-rules/twitter-follow"}]}]}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/docs/mcp/overview"}]}]},"basePath":"","title":"Refund Reward - LoyaltyLion","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}