using RestSharp;
var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/configurations/referrals");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api.gameball.co/api/v4.0/integrations/configurations/referrals");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("apikey", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.
This specifies who will receive the referral reward when a successful referral is made. Possible values: CustomerOnly (Only the customer making the referral will receive the reward. The referred friend will not receive any reward), CustomerAndFriend (Both the customer making the referral and the referred friend will receive rewards, encouraging mutual benefit).
This describes the event that will trigger the referral reward. Example: if the eventName is set to place_order, the referral reward will be granted when the referred friend completes an order after using the referral link. Other events can also be configured to trigger the reward, depending on your system's setup.
The reward details given to the customer as part of the referral program.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Gameball Docs","colors":{"primary":"#FB5819","light":"#FFD800","dark":"#F5DB5B"},"logo":{"light":"https://mintcdn.com/gameball/G3Do1BW89krXAJ48/logo/light.svg?fit=max\u0026auto=format\u0026n=G3Do1BW89krXAJ48\u0026q=85\u0026s=aecb464405fc6a468704d3da3cedc5ae","dark":"https://mintcdn.com/gameball/G3Do1BW89krXAJ48/logo/dark.svg?fit=max\u0026auto=format\u0026n=G3Do1BW89krXAJ48\u0026q=85\u0026s=05dec1e7bb58ddf654926789347480f2"},"favicon":"https://mintcdn.com/gameball/DyB0l4Pe2M9HXiFz/favicon.svg?fit=max\u0026auto=format\u0026n=DyB0l4Pe2M9HXiFz\u0026q=85\u0026s=2159e3f87590969ecc17da52bd808257","api":{"playground":{"display":"interactive","proxy":true},"examples":{"languages":["curl","javascript","python","csharp","go","php","java"]}},"navbar":{"links":[{"href":"mailto:support@gameball.co","label":"Support"}],"primary":{"type":"button","label":"Sign in","href":"https://app.gameball.co/"}},"footer":{"socials":{"facebook":"https://www.facebook.com/Gameball.co","linkedin":"https://www.linkedin.com/company/gameball"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"global":{"anchors":[{"anchor":"Gameball Website","icon":"globe","href":"https://gameball.co/"},{"anchor":"Blog","icon":"newspaper","href":"https://www.gameball.co/blog"},{"anchor":"Case Studies","icon":"briefcase","href":"https://www.gameball.co/case-study"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gameball","hasAudioNarration":false,"actualSubdomain":"gameball","customDomains":["docs.gameball.co"],"gitSource":{"type":"github","owner":"gameballers","repo":"gameball-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae331c39ee4546ca4eaa4d9","collectionId":"5ef69a2d-2110-48c4-b332-86130f29a943","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae331c39ee4546ca4eaa4d9"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ae331c39ee4546ca4eaa4d9","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Product Docs","count":233},{"language":"default","tag":"Product Documentation","count":233},{"language":"default","tag":"Installation","count":130},{"language":"default","tag":"API reference","count":97},{"language":"default","tag":"API documentation","count":92},{"language":"default","tag":"Mobile Integration","count":85},{"language":"default","tag":"Technical Tutorials","count":55},{"language":"default","tag":"Rewards Campaigns","count":50},{"language":"default","tag":"Web \u0026 POS Integration","count":43},{"language":"default","tag":"Apps \u0026 Integrations","count":30}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":".nav-logo,.nav-logo img{width:auto!important;height:40px!important;max-height:40px!important}.nav-logo img{object-fit:contain!important}.security-banner{display:flex;align-items:flex-start;gap:.75rem;background:rgba(239,68,68,.25);border:1px solid rgba(239,68,68,.5);border-left:4px solid #ef4444;padding:1rem;border-radius:.5rem;margin:1rem 0}.security-banner-icon{font-size:1.25rem;color:#ef4444;flex-shrink:0;line-height:1.5}.security-banner-content{flex:1;font-size:.9375rem;line-height:1.6;color:inherit}.security-banner-content strong{font-weight:600;color:inherit}.security-banner-content code{background:rgba(239,68,68,.15);color:#dc2626;padding:.125rem .375rem;border-radius:.25rem;font-size:.875em;font-family:monospace}"}],"page":{"pagePath":"api-reference/configurations/program-configurations/referral-settings","slug":"/api-reference/configurations/program-configurations/referral-settings","pageMetadata":{"title":"Referrals Configurations","description":"Retrieve referral program configuration for the loyalty program.","openapi":"GET /api/v4.0/integrations/configurations/referrals","languages":["curl","javascript","python","csharp"],"href":"/api-reference/configurations/program-configurations/referral-settings"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve referral program configuration for the loyalty program.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Referrals Configurations","description":"Retrieve referral program configuration for the loyalty program.","openapi":"GET /api/v4.0/integrations/configurations/referrals","languages":["curl","javascript","python","csharp"],"href":"/api-reference/configurations/program-configurations/referral-settings"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Referrals Configurations","description":"Retrieve referral program configuration for the loyalty program.","operationId":"getReferralsConfigurations","security":["926780a5-0476-4108-9833-5b038407e601"],"parameters":["a770fe7c-0177-4a74-b809-2d0c5910bf01"],"responses":{"200":"4e765dfb-879c-4de1-87f9-d7654d408d65"},"method":"get","type":"path","servers":["eafb7e85-fe84-4218-aa41-ea8fdc35ef44"],"path":"/api/v4.0/integrations/configurations/referrals","baseUrlOptions":["https://api.gameball.co"],"title":"Referrals Configurations","codeSamples":[],"requestExampleLanguages":["bash","javascript","python","csharp","go","php","java"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a770fe7c-0177-4a74-b809-2d0c5910bf01":{"name":"lang","in":"header","description":"If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.","required":false,"schema":{"type":"string","isRequired":false,"description":"If the lang header is provided, the response will be returned in the specified language (e.g., en for English, fr for French). If this header is not included, the system will use the default language.","uniqueKey":"","typeLabel":"string"}}},"responses":{"4e765dfb-879c-4de1-87f9-d7654d408d65":{"description":"Referral settings retrieved successfully","content":{"application/json":{"schema":{"type":"object","properties":{"referralMethod":{"type":"string","description":"This specifies who will receive the referral reward when a successful referral is made. Possible values: CustomerOnly (Only the customer making the referral will receive the reward. The referred friend will not receive any reward), CustomerAndFriend (Both the customer making the referral and the referred friend will receive rewards, encouraging mutual benefit).","uniqueKey":"referralMethod","typeLabel":"string"},"eventName":{"type":"string","description":"This describes the event that will trigger the referral reward. Example: if the eventName is set to place_order, the referral reward will be granted when the referred friend completes an order after using the referral link. Other events can also be configured to trigger the reward, depending on your system's setup.","uniqueKey":"eventName","typeLabel":"string"},"eventMetaData":{"oneOf":[{"type":"object","description":"Contains additional metadata about the event that triggers the referral.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the event metadata.","uniqueKey":"eventMetaData.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the event metadata.","uniqueKey":"eventMetaData.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventMetaData.oneOf.0.name","typeLabel":"string | null"},"operator":{"oneOf":[{"type":"string","description":"The operator used for event metadata (e.g., equals, greater_than).","uniqueKey":"eventMetaData.oneOf.0.operator.oneOf.0","typeLabel":"string"},{"type":"null","description":"The operator used for event metadata (e.g., equals, greater_than).","uniqueKey":"eventMetaData.oneOf.0.operator.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventMetaData.oneOf.0.operator","typeLabel":"string | null"},"value":{"oneOf":[{"type":"string","description":"The value associated with the event metadata.","uniqueKey":"eventMetaData.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"The value associated with the event metadata.","uniqueKey":"eventMetaData.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventMetaData.oneOf.0.value","typeLabel":"string | null"}},"uniqueKey":"eventMetaData.oneOf.0","typeLabel":"object"},{"type":"null","description":"Contains additional metadata about the event that triggers the referral.","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the event metadata."},{"type":"null","description":"The name of the event metadata."}]},"operator":{"oneOf":[{"type":"string","description":"The operator used for event metadata (e.g., equals, greater_than)."},{"type":"null","description":"The operator used for event metadata (e.g., equals, greater_than)."}]},"value":{"oneOf":[{"type":"string","description":"The value associated with the event metadata."},{"type":"null","description":"The value associated with the event metadata."}]}},"uniqueKey":"eventMetaData.oneOf.1","typeLabel":"null"}],"uniqueKey":"eventMetaData","typeLabel":"object | null"},"friendReward":{"oneOf":[{"type":"object","description":"The reward details given to the referred friend as part of the referral program.","properties":{"score":{"oneOf":[{"type":"number","description":"The score awarded to the referred friend.","uniqueKey":"friendReward.oneOf.0.score.oneOf.0","typeLabel":"number"},{"type":"null","description":"The score awarded to the referred friend.","uniqueKey":"friendReward.oneOf.0.score.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.score","typeLabel":"number | null"},"point":{"oneOf":[{"type":"number","description":"The points awarded to the referred friend.","uniqueKey":"friendReward.oneOf.0.point.oneOf.0","typeLabel":"number"},{"type":"null","description":"The points awarded to the referred friend.","uniqueKey":"friendReward.oneOf.0.point.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.point","typeLabel":"number | null"},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded to the referred friend.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.couponType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.couponType.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.couponType","typeLabel":"string | null"},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.discountValue.oneOf.0","typeLabel":"number"},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.discountValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.discountValue","typeLabel":"number | null"},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the product.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productId.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productId","typeLabel":"string | null"},"productName":{"oneOf":[{"type":"string","description":"The name of the product.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the product.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productName.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productName","typeLabel":"string | null"},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the product variant.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantId","typeLabel":"string | null"},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the product variant.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantName.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantName","typeLabel":"string | null"},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productDisplayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productDisplayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productDisplayName","typeLabel":"string | null"}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.product","typeLabel":"object | null"},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the collection.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionId","typeLabel":"string | null"},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name for the collection.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionName.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionName","typeLabel":"string | null"}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.collections","typeLabel":"object[] | null"},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.handle.oneOf.0","typeLabel":"string"},{"type":"null","description":"A unique identifier used to reference the coupon group in the system.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.handle.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.handle","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The title of the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.title","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.url","typeLabel":"string | null"},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.iconPath.oneOf.0","typeLabel":"string"},{"type":"null","description":"The path to the icon of the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.iconPath.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.iconPath","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the coupon group.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.description","typeLabel":"string | null"},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.maxPerCustomer.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.maxPerCustomer.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.maxPerCustomer","typeLabel":"number | null"},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.startDate","typeLabel":"string\u003cdate-time> | null"},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.expiryDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.expiryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.expiryDate","typeLabel":"string\u003cdate-time> | null"},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isAvailable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the coupon group is currently available.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isAvailable.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isAvailable","typeLabel":"boolean | null"},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isActive.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the coupon group is currently active.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isActive.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isActive","typeLabel":"boolean | null"}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.group","typeLabel":"object | null"},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.name","typeLabel":"string | null"},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.expiryAfter.oneOf.0","typeLabel":"number"},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.expiryAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.expiryAfter","typeLabel":"number | null"},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.usageLimit.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.usageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.usageLimit","typeLabel":"number | null"},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.capping.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.capping.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.capping","typeLabel":"number | null"},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.minOrderValue.oneOf.0","typeLabel":"number"},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount.","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.minOrderValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.minOrderValue","typeLabel":"number | null"},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\".","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.codePrefix.oneOf.0","typeLabel":"string"},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\".","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.codePrefix.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.codePrefix","typeLabel":"string | null"},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\"","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.redeemInstructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\"","uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.redeemInstructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.redeemInstructions","typeLabel":"string | null"}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0.options","typeLabel":"object | null"}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.0","typeLabel":"object"},{"type":"null","description":"A coupon object that is awarded to the referred friend.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."}]},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."}]},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}}]},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}}]},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}}]},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}}]}},"uniqueKey":"friendReward.oneOf.0.coupon.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward.oneOf.0.coupon","typeLabel":"object | null"}},"uniqueKey":"friendReward.oneOf.0","typeLabel":"object"},{"type":"null","description":"The reward details given to the referred friend as part of the referral program.","properties":{"score":{"oneOf":[{"type":"number","description":"The score awarded to the referred friend."},{"type":"null","description":"The score awarded to the referred friend."}]},"point":{"oneOf":[{"type":"number","description":"The points awarded to the referred friend."},{"type":"null","description":"The points awarded to the referred friend."}]},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded to the referred friend.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."}]},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."}]},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}}]},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}}]},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}}]},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}}]}}},{"type":"null","description":"A coupon object that is awarded to the referred friend.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."}]},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."}]},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}}]},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}}]},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}}]},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}}]}}}]}},"uniqueKey":"friendReward.oneOf.1","typeLabel":"null"}],"uniqueKey":"friendReward","typeLabel":"object | null"},"customerReward":{"oneOf":[{"type":"object","description":"The reward details given to the customer as part of the referral program.","properties":{"score":{"oneOf":[{"type":"number","description":"The score awarded to the customer.","uniqueKey":"customerReward.oneOf.0.score.oneOf.0","typeLabel":"number"},{"type":"null","description":"The score awarded to the customer.","uniqueKey":"customerReward.oneOf.0.score.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.score","typeLabel":"number | null"},"point":{"oneOf":[{"type":"number","description":"The points awarded to the customer.","uniqueKey":"customerReward.oneOf.0.point.oneOf.0","typeLabel":"number"},{"type":"null","description":"The points awarded to the customer.","uniqueKey":"customerReward.oneOf.0.point.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.point","typeLabel":"number | null"},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded to the customer.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.couponType.oneOf.0","typeLabel":"string"},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.couponType.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.couponType","typeLabel":"string | null"},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.discountValue.oneOf.0","typeLabel":"number"},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.discountValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.discountValue","typeLabel":"number | null"},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the product.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productId","typeLabel":"string | null"},"productName":{"oneOf":[{"type":"string","description":"The name of the product.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the product.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productName","typeLabel":"string | null"},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the product variant.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantId","typeLabel":"string | null"},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the product variant.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.variantName","typeLabel":"string | null"},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productDisplayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productDisplayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0.productDisplayName","typeLabel":"string | null"}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.product","typeLabel":"object | null"},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionId.oneOf.0","typeLabel":"string"},{"type":"null","description":"The unique identifier for the collection.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionId","typeLabel":"string | null"},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name for the collection.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionName.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX].collectionName","typeLabel":"string | null"}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.0","typeLabel":"object[]"},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.collections","typeLabel":"object[] | null"},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.handle.oneOf.0","typeLabel":"string"},{"type":"null","description":"A unique identifier used to reference the coupon group in the system.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.handle.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.handle","typeLabel":"string | null"},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","description":"The title of the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.title","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","description":"The URL for the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.url","typeLabel":"string | null"},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.iconPath.oneOf.0","typeLabel":"string"},{"type":"null","description":"The path to the icon of the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.iconPath.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.iconPath","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"A description of the coupon group.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.description","typeLabel":"string | null"},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.maxPerCustomer.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.maxPerCustomer.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.maxPerCustomer","typeLabel":"number | null"},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.startDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.startDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.startDate","typeLabel":"string\u003cdate-time> | null"},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.expiryDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.expiryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.expiryDate","typeLabel":"string\u003cdate-time> | null"},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isAvailable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the coupon group is currently available.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isAvailable.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isAvailable","typeLabel":"boolean | null"},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isActive.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Indicates whether the coupon group is currently active.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isActive.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0.isActive","typeLabel":"boolean | null"}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.group","typeLabel":"object | null"},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.name","typeLabel":"string | null"},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.expiryAfter.oneOf.0","typeLabel":"number"},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.expiryAfter.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.expiryAfter","typeLabel":"number | null"},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.usageLimit.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.usageLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.usageLimit","typeLabel":"number | null"},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.capping.oneOf.0","typeLabel":"number"},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.capping.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.capping","typeLabel":"number | null"},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.minOrderValue.oneOf.0","typeLabel":"number"},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount.","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.minOrderValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.minOrderValue","typeLabel":"number | null"},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\".","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.codePrefix.oneOf.0","typeLabel":"string"},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\".","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.codePrefix.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.codePrefix","typeLabel":"string | null"},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\"","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.redeemInstructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\"","uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.redeemInstructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0.redeemInstructions","typeLabel":"string | null"}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0.options","typeLabel":"object | null"}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.0","typeLabel":"object"},{"type":"null","description":"A coupon object that is awarded to the customer.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."}]},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."}]},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}}]},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}}]},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}}]},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}}]}},"uniqueKey":"customerReward.oneOf.0.coupon.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.coupon","typeLabel":"object | null"},"extraReward":{"oneOf":[{"type":"object","description":"It contains all the details of the reward (like the friendReward Object) that will be awarded to the customer as a bonus on top of the regular reward for every X friend referred.","properties":{"forEvery":{"oneOf":[{"type":"number","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.forEvery.oneOf.0","typeLabel":"number"},{"type":"null","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.forEvery.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.forEvery","typeLabel":"number | null"},"score":{"oneOf":[{"type":"number","description":"The score awarded as part of the extra reward.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.score.oneOf.0","typeLabel":"number"},{"type":"null","description":"The score awarded as part of the extra reward.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.score.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.score","typeLabel":"number | null"},"point":{"oneOf":[{"type":"number","description":"The points awarded as part of the extra reward.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.point.oneOf.0","typeLabel":"number"},{"type":"null","description":"The points awarded as part of the extra reward.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.point.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.point","typeLabel":"number | null"},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded as part of the extra reward.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.coupon.oneOf.0","typeLabel":"object"},{"type":"null","description":"A coupon object that is awarded as part of the extra reward.","uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.coupon.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0.coupon","typeLabel":"object | null"}},"uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.0","typeLabel":"object"},{"type":"null","description":"It contains all the details of the reward (like the friendReward Object) that will be awarded to the customer as a bonus on top of the regular reward for every X friend referred.","properties":{"forEvery":{"oneOf":[{"type":"number","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals."},{"type":"null","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals."}]},"score":{"oneOf":[{"type":"number","description":"The score awarded as part of the extra reward."},{"type":"null","description":"The score awarded as part of the extra reward."}]},"point":{"oneOf":[{"type":"number","description":"The points awarded as part of the extra reward."},{"type":"null","description":"The points awarded as part of the extra reward."}]},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded as part of the extra reward."},{"type":"null","description":"A coupon object that is awarded as part of the extra reward."}]}},"uniqueKey":"customerReward.oneOf.0.extraReward.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward.oneOf.0.extraReward","typeLabel":"object | null"}},"uniqueKey":"customerReward.oneOf.0","typeLabel":"object"},{"type":"null","description":"The reward details given to the customer as part of the referral program.","properties":{"score":{"oneOf":[{"type":"number","description":"The score awarded to the customer."},{"type":"null","description":"The score awarded to the customer."}]},"point":{"oneOf":[{"type":"number","description":"The points awarded to the customer."},{"type":"null","description":"The points awarded to the customer."}]},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded to the customer.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."}]},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."}]},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}}]},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}}]},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}}]},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}}]}}},{"type":"null","description":"A coupon object that is awarded to the customer.","properties":{"couponType":{"oneOf":[{"type":"string","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."},{"type":"null","description":"The type of coupon applied. Possible values include: free_shipping, percentage_discount, fixed_discount, fixed_rate_discount, free_product, custom."}]},"discountValue":{"oneOf":[{"type":"number","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."},{"type":"null","description":"The value of the discount provided by the coupon in case the coupon type is fixed_discount, percentage_discount or fixed_rate_discount."}]},"product":{"oneOf":[{"type":"object","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}},{"type":"null","properties":{"productId":{"oneOf":[{"type":"string","description":"The unique identifier for the product."},{"type":"null","description":"The unique identifier for the product."}]},"productName":{"oneOf":[{"type":"string","description":"The name of the product."},{"type":"null","description":"The name of the product."}]},"variantId":{"oneOf":[{"type":"string","description":"The unique identifier for the product variant."},{"type":"null","description":"The unique identifier for the product variant."}]},"variantName":{"oneOf":[{"type":"string","description":"The name of the product variant."},{"type":"null","description":"The name of the product variant."}]},"productDisplayName":{"oneOf":[{"type":"string","description":"The display name associated with the product that configured on the dashboard based on required language."},{"type":"null","description":"The display name associated with the product that configured on the dashboard based on required language."}]}}}]},"collections":{"oneOf":[{"type":"array","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}},{"type":"null","description":"A list of collection IDs that the coupon can be applied to.","items":{"type":"object","properties":{"collectionId":{"oneOf":[{"type":"string","description":"The unique identifier for the collection."},{"type":"null","description":"The unique identifier for the collection."}]},"collectionName":{"oneOf":[{"type":"string","description":"The name for the collection."},{"type":"null","description":"The name for the collection."}]}}}}]},"group":{"oneOf":[{"type":"object","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}},{"type":"null","properties":{"handle":{"oneOf":[{"type":"string","description":"A unique identifier used to reference the coupon group in the system."},{"type":"null","description":"A unique identifier used to reference the coupon group in the system."}]},"title":{"oneOf":[{"type":"string","description":"The title of the coupon group."},{"type":"null","description":"The title of the coupon group."}]},"url":{"oneOf":[{"type":"string","description":"The URL for the coupon group."},{"type":"null","description":"The URL for the coupon group."}]},"iconPath":{"oneOf":[{"type":"string","description":"The path to the icon of the coupon group."},{"type":"null","description":"The path to the icon of the coupon group."}]},"description":{"oneOf":[{"type":"string","description":"A description of the coupon group."},{"type":"null","description":"A description of the coupon group."}]},"maxPerCustomer":{"oneOf":[{"type":"number","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."},{"type":"null","description":"The maximum number of times a customer can use the coupon. Example: 5 indicates that each customer can redeem this coupon up to 5 times."}]},"startDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will become active and valid for redemption."}]},"expiryDate":{"oneOf":[{"type":"string","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."},{"type":"null","format":"date-time","description":"The date when the coupons within this coupon group will expire and no longer be valid for redemption."}]},"isAvailable":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently available."},{"type":"null","description":"Indicates whether the coupon group is currently available."}]},"isActive":{"oneOf":[{"type":"boolean","description":"Indicates whether the coupon group is currently active."},{"type":"null","description":"Indicates whether the coupon group is currently active."}]}}}]},"options":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}},{"type":"null","properties":{"name":{"oneOf":[{"type":"string","description":"The name of the reward rule configured on the dashboard based on required language."},{"type":"null","description":"The name of the reward rule configured on the dashboard based on required language."}]},"expiryAfter":{"oneOf":[{"type":"number","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."},{"type":"null","description":"The number of days after creation that the coupon will expire. Example: If a coupon expires after 14 days, the customer must use it within that period to receive the discount."}]},"usageLimit":{"oneOf":[{"type":"number","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."},{"type":"null","description":"The maximum number of times a single coupon can be used. Example: If a coupon has a usage limit of 5, it can be redeemed up to 5 times before it becomes invalid."}]},"capping":{"oneOf":[{"type":"number","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."},{"type":"null","description":"The maximum discount value a coupon can provide, regardless of the order amount. Example: If a coupon offers 20% off with a capping of $50, the discount will not exceed $50, even if 20% of the order total is higher."}]},"minOrderValue":{"oneOf":[{"type":"number","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."},{"type":"null","description":"The minimum order amount required to apply the coupon. Example: If a coupon has a minimum order value of $100, the customer must spend at least $100 to use the discount."}]},"codePrefix":{"oneOf":[{"type":"string","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."},{"type":"null","description":"The prefix that will be added to the beginning of the generated coupon code. Example: If the prefix is \"SUMMER\", the generated coupon codes might look like \"SUMMER12345\" or \"SUMMERDISCOUNT\"."}]},"redeemInstructions":{"oneOf":[{"type":"string","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""},{"type":"null","description":"The instructions on how the customer can redeem the coupon. Example: \"Enter the coupon code at checkout to apply the discount.\""}]}}}]}}}]},"extraReward":{"oneOf":[{"type":"object","description":"It contains all the details of the reward (like the friendReward Object) that will be awarded to the customer as a bonus on top of the regular reward for every X friend referred.","properties":{"forEvery":{"oneOf":[{"type":"number","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals."},{"type":"null","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals."}]},"score":{"oneOf":[{"type":"number","description":"The score awarded as part of the extra reward."},{"type":"null","description":"The score awarded as part of the extra reward."}]},"point":{"oneOf":[{"type":"number","description":"The points awarded as part of the extra reward."},{"type":"null","description":"The points awarded as part of the extra reward."}]},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded as part of the extra reward."},{"type":"null","description":"A coupon object that is awarded as part of the extra reward."}]}}},{"type":"null","description":"It contains all the details of the reward (like the friendReward Object) that will be awarded to the customer as a bonus on top of the regular reward for every X friend referred.","properties":{"forEvery":{"oneOf":[{"type":"number","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals."},{"type":"null","description":"This defines the number of friends a customer needs to refer in order to earn the extraReward. For example, if the value of forEvery is set to 5, the customer will receive the extra reward for every 5 friends they successfully refer. This acts as a bonus on top of the regular reward, incentivizing more referrals."}]},"score":{"oneOf":[{"type":"number","description":"The score awarded as part of the extra reward."},{"type":"null","description":"The score awarded as part of the extra reward."}]},"point":{"oneOf":[{"type":"number","description":"The points awarded as part of the extra reward."},{"type":"null","description":"The points awarded as part of the extra reward."}]},"coupon":{"oneOf":[{"type":"object","description":"A coupon object that is awarded as part of the extra reward."},{"type":"null","description":"A coupon object that is awarded as part of the extra reward."}]}}}]}},"uniqueKey":"customerReward.oneOf.1","typeLabel":"null"}],"uniqueKey":"customerReward","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"referralMethod":"\u003cstring>","eventName":"\u003cstring>","eventMetaData":{"name":"\u003cstring>","operator":"\u003cstring>","value":"\u003cstring>"},"friendReward":{"score":123,"point":123,"coupon":{"couponType":"\u003cstring>","discountValue":123,"product":{"productId":"\u003cstring>","productName":"\u003cstring>","variantId":"\u003cstring>","variantName":"\u003cstring>","productDisplayName":"\u003cstring>"},"collections":[{"collectionId":"\u003cstring>","collectionName":"\u003cstring>"}],"group":{"handle":"\u003cstring>","title":"\u003cstring>","url":"\u003cstring>","iconPath":"\u003cstring>","description":"\u003cstring>","maxPerCustomer":123,"startDate":"2023-11-07T05:31:56Z","expiryDate":"2023-11-07T05:31:56Z","isAvailable":true,"isActive":true},"options":{"name":"\u003cstring>","expiryAfter":123,"usageLimit":123,"capping":123,"minOrderValue":123,"codePrefix":"\u003cstring>","redeemInstructions":"\u003cstring>"}}},"customerReward":{"score":123,"point":123,"coupon":{"couponType":"\u003cstring>","discountValue":123,"product":{"productId":"\u003cstring>","productName":"\u003cstring>","variantId":"\u003cstring>","variantName":"\u003cstring>","productDisplayName":"\u003cstring>"},"collections":[{"collectionId":"\u003cstring>","collectionName":"\u003cstring>"}],"group":{"handle":"\u003cstring>","title":"\u003cstring>","url":"\u003cstring>","iconPath":"\u003cstring>","description":"\u003cstring>","maxPerCustomer":123,"startDate":"2023-11-07T05:31:56Z","expiryDate":"2023-11-07T05:31:56Z","isAvailable":true,"isActive":true},"options":{"name":"\u003cstring>","expiryAfter":123,"usageLimit":123,"capping":123,"minOrderValue":123,"codePrefix":"\u003cstring>","redeemInstructions":"\u003cstring>"}},"extraReward":{"forEvery":123,"score":123,"point":123,"coupon":{}}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"926780a5-0476-4108-9833-5b038407e601":{"apiKey":{"type":"apiKey","in":"header","name":"apikey","scopes":[],"schemeName":"apiKey"}}},"servers":{"eafb7e85-fe84-4218-aa41-ea8fdc35ef44":{"url":"https://api.gameball.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"apikey","scopes":[],"schemeName":"apiKey"},"schema":{"title":"apikey","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"apikey"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"gameball","siteName":"Gameball Docs","title":"Referrals Configurations - Gameball Docs","navMaps":{"firstHrefInVersion":{"v4.0":{"href":"/api-reference/configurations/program-configurations/referral-settings","matchLevel":0},"v4.1":{"href":"/api-reference/introduction-v4.1","matchLevel":2},"SDK v3":{"href":"/installation-guides/v3","matchLevel":4},"SDK v2":{"href":"/installation-guides/v2/index","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-25T11:24:07.624Z","originalFileLocation":"api-reference/configurations/program-configurations/referral-settings.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve referral program configuration for the loyalty program.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gameball Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_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/gameball/Ree8Ef_QV2s4xScJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Referrals Configurations - Gameball Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve referral program configuration for the loyalty program.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gameball Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gameball.mintlify.app/_mintlify/api/og/v2?division=Program+Configurations\u0026amp;title=Referrals+Configurations\u0026amp;description=Retrieve+referral+program+configuration+for+the+loyalty+program.\u0026amp;theme=4e778c65cbfcf077808b5cd6\u0026amp;signature=0e8168094266068663ff194b703cdcd7f8159a18aad6d671fae26c041f7cf592\">\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=\"Referrals Configurations - Gameball Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve referral program configuration for the loyalty program.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gameball.mintlify.app/_mintlify/api/og/v2?division=Program+Configurations\u0026amp;title=Referrals+Configurations\u0026amp;description=Retrieve+referral+program+configuration+for+the+loyalty+program.\u0026amp;theme=4e778c65cbfcf077808b5cd6\u0026amp;signature=0e8168094266068663ff194b703cdcd7f8159a18aad6d671fae26c041f7cf592\">\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/gameball/Ree8Ef_QV2s4xScJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gameball Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FB5819\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/configurations/program-configurations/referral-settings.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gameball.co/#organization\",\"name\":\"Gameball Docs\",\"url\":\"https://docs.gameball.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gameball/G3Do1BW89krXAJ48/logo/light.svg?fit=max\u0026auto=format\u0026n=G3Do1BW89krXAJ48\u0026q=85\u0026s=aecb464405fc6a468704d3da3cedc5ae\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gameball.co#website\",\"name\":\"Gameball Docs\",\"url\":\"https://docs.gameball.co\",\"publisher\":{\"@id\":\"https://docs.gameball.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings#webpage\",\"url\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings\",\"name\":\"Referrals Configurations\",\"description\":\"Retrieve referral program configuration for the loyalty program.\",\"dateModified\":\"2026-01-25T11:24:07.624Z\",\"isPartOf\":{\"@id\":\"https://docs.gameball.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API documentation\",\"item\":\"https://docs.gameball.co/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Configurations\",\"item\":\"https://docs.gameball.co/api-reference/configurations/configurations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Program Configurations\",\"item\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/index\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Referrals Configurations\",\"item\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings#apireference\",\"headline\":\"Referrals Configurations\",\"name\":\"Referrals Configurations\",\"description\":\"Retrieve referral program configuration for the loyalty program.\",\"url\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gameball.co/api-reference/configurations/program-configurations/referral-settings#webpage\"},\"dateModified\":\"2026-01-25T11:24:07.624Z\",\"publisher\":{\"@id\":\"https://docs.gameball.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gameball.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gameball Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gameball Docs","nav":{"global":{"anchors":[{"anchor":"Gameball Website","icon":"globe","href":"https://gameball.co/"},{"anchor":"Blog","icon":"newspaper","href":"https://www.gameball.co/blog"},{"anchor":"Case Studies","icon":"briefcase","href":"https://www.gameball.co/case-study"}]},"tabs":[{"tab":"Product Docs","pages":[{"title":"Product Docs","href":"/product-documentation/getting-started/what-is-gameball"}]},{"tab":"Installation","versions":[{"version":"SDK v3","default":true,"groups":[{"group":"Overview","pages":[{"title":"Installation Guide (SDK v3)","href":"/installation-guides/v3"}]},{"group":"Web \u0026 POS Integration","pages":[{"group":"Web","pages":[{"title":"Web SDK Integration (v3)","sidebarTitle":"Overview","href":"/installation-guides/v3/web/index"},{"title":"How Do I Get Started with the Web SDK (v3)?","sidebarTitle":"Getting Started","href":"/installation-guides/v3/web/getting-started"},{"title":"How Do I Initialize the Customer Widget in the Web SDK (v3)?","sidebarTitle":"Initialize Gameball Customer Widget","href":"/installation-guides/v3/web/initialize-widget"},{"title":"How Do I Manage Customers with the Web SDK (v3)?","sidebarTitle":"Customer Management","href":"/installation-guides/v3/web/customer-management"},{"title":"How Do I Track Customer Events with the Web SDK (v3)?","sidebarTitle":"Track Customer Events","href":"/installation-guides/v3/web/track-events"},{"title":"How Do I Track Orders and Reward Cashback with the Web SDK (v3)?","sidebarTitle":"Track Orders \u0026 Cashback Reward","href":"/installation-guides/v3/web/track-orders"},{"title":"How Do I Integrate Points Redemption with the Web SDK (v3)?","sidebarTitle":"Integrate Redemption","href":"/installation-guides/v3/web/integrate-redemption"},{"title":"How Do I Track Referrals with the Web SDK (v3)?","sidebarTitle":"Track Referrals","href":"/installation-guides/v3/web/track-referrals"},{"title":"How Do I Set Up In-App Messaging in the Web SDK (v3)?","sidebarTitle":"In-App Messaging","href":"/installation-guides/v3/web/in-app-messaging"},{"title":"How Do I Complete the Go-Live Checklist for the Web SDK (v3)?","sidebarTitle":"Go-Live Checklist","href":"/installation-guides/v3/web/go-live-checklist"}]},{"group":"POS","pages":[{"title":"Gameball POS Integration (v3)","sidebarTitle":"Overview","href":"/installation-guides/v3/pos/index"},{"title":"How Do I Get Started and Set Up the API for Gameball POS (v3)?","sidebarTitle":"Getting Started \u0026 API Setup","href":"/installation-guides/v3/pos/getting-started"},{"title":"How Do I Identify the Customer with Gameball POS (v3)?","sidebarTitle":"Identify the Customer","href":"/installation-guides/v3/pos/customer-management"},{"title":"How Do I Show the Customer Balance with Gameball POS (v3)?","sidebarTitle":"Show Customer Balance","href":"/installation-guides/v3/pos/customer-balance"},{"title":"How Do I Track Orders and Earn Points with Gameball POS (v3)?","sidebarTitle":"Track Orders \u0026 Earn Points","href":"/installation-guides/v3/pos/track-orders"},{"title":"How Do I Redeem Points at Checkout with Gameball POS (v3)?","sidebarTitle":"Redeem Points at Checkout","href":"/installation-guides/v3/pos/integrate-redemption"},{"title":"How Do I Refund an Order with Gameball POS (v3)?","sidebarTitle":"Refund Order","href":"/installation-guides/v3/pos/refund-order"},{"title":"How Do I Fetch Order Details with Gameball POS (v3)?","sidebarTitle":"Fetch Order Details","href":"/installation-guides/v3/pos/fetch-order-details"},{"title":"How Do I Track Events with Gameball POS (v3)?","sidebarTitle":"Track Events","href":"/installation-guides/v3/pos/track-events"},{"title":"How Do I Track Referrals with Gameball POS (v3)?","sidebarTitle":"Track Referrals","href":"/installation-guides/v3/pos/track-referrals"},{"title":"How Do I Complete the Go-Live Checklist for Gameball POS (v3)?","sidebarTitle":"Go-Live Checklist","href":"/installation-guides/v3/pos/go-live-checklist"}]}]},{"group":"Mobile Integration","pages":[{"group":"iOS","pages":[{"group":"Overview \u0026 Setup","pages":[{"title":"iOS SDK Integration (v3)","sidebarTitle":"Overview","href":"/installation-guides/v3/ios/index"},{"title":"How Do I Get Started with the iOS SDK (v3)?","sidebarTitle":"Getting Started","href":"/installation-guides/v3/ios/getting-started"},{"title":"How Do I Initialize the iOS SDK (v3)?","sidebarTitle":"SDK Initialization","href":"/installation-guides/v3/ios/initialize-sdk"},{"title":"How Do I Initialize the Customer Profile in the iOS SDK (v3)?","sidebarTitle":"Initialize Customer Profile","href":"/installation-guides/v3/ios/initialize-profile"}]},{"group":"Core SDK Capabilities","pages":[{"title":"How Do I Show the Profile Widget in the iOS SDK (v3)?","sidebarTitle":"Show Profile Widget","href":"/installation-guides/v3/ios/show-profile"},{"title":"How Do I Track Customer Events with the iOS SDK (v3)?","sidebarTitle":"Track Events","href":"/installation-guides/v3/ios/track-events"}]},{"group":"Extended Features","pages":[{"title":"How Do I Set Up Push Notifications in the iOS SDK (v3)?","sidebarTitle":"Push Notifications","href":"/installation-guides/v3/ios/push-notifications"},{"title":"How Do I Track Referrals with the iOS SDK (v3)?","sidebarTitle":"Track Referrals","href":"/installation-guides/v3/ios/track-referrals"},{"title":"How Do I Set Up In-App Messaging in the iOS SDK (v3)?","sidebarTitle":"In-App Messaging","href":"/installation-guides/v3/ios/in-app-messaging"}]},{"group":"Deployment \u0026 Maintenance","pages":[{"title":"How Do I Complete the Go-Live Checklist for the iOS SDK (v3)?","sidebarTitle":"Go-Live Checklist","href":"/installation-guides/v3/ios/go-live-checklist"},{"title":"How Do I Migrate to the iOS SDK v4?","sidebarTitle":"Migration Notes","href":"/installation-guides/v3/ios/migration-notes"}]}]},{"group":"Android","pages":[{"group":"Overview \u0026 Setup","pages":[{"title":"Android SDK Integration (v3)","sidebarTitle":"Overview","href":"/installation-guides/v3/android/index"},{"title":"How Do I Get Started with the Android SDK (v3)?","sidebarTitle":"Getting Started","href":"/installation-guides/v3/android/getting-started"},{"title":"How Do I Initialize the Android SDK (v3)?","sidebarTitle":"Initialize SDK","href":"/installation-guides/v3/android/initialize-sdk"},{"title":"How Do I Initialize the Customer Profile in the Android SDK (v3)?","sidebarTitle":"Initialize Customer Profile","href":"/installation-guides/v3/android/initialize-profile"}]},{"group":"Core SDK Capabilities","pages":[{"title":"How Do I Show the Profile Widget in the Android SDK (v3)?","sidebarTitle":"Show Profile Widget","href":"/installation-guides/v3/android/show-profile"},{"title":"How Do I Track Customer Events with the Android SDK (v3)?","sidebarTitle":"Track Customer Events","href":"/installation-guides/v3/android/track-events"}]},{"group":"Extended Features","pages":[{"title":"How Do I Set Up Push Notifications in the Android SDK (v3)?","sidebarTitle":"Push Notifications","href":"/installation-guides/v3/android/push-notifications"},{"title":"How Do I Track Referrals with the Android SDK (v3)?","sidebarTitle":"Track Referrals","href":"/installation-guides/v3/android/track-referrals"},{"title":"How Do I Set Up In-App Messaging in the Android SDK (v3)?","sidebarTitle":"In-App Messaging","href":"/installation-guides/v3/android/in-app-messaging"}]},{"group":"Deployment \u0026 Maintenance","pages":[{"title":"How Do I Complete the Go-Live Checklist for the Android SDK (v3)?","sidebarTitle":"Go-Live Checklist","href":"/installation-guides/v3/android/go-live-checklist"},{"title":"How Do I Migrate to the Android SDK v4?","sidebarTitle":"Migration Notes","href":"/installation-guides/v3/android/migration-notes"}]}]},{"group":"Flutter","pages":[{"group":"Overview \u0026 Setup","pages":[{"title":"Flutter SDK Integration (v3)","sidebarTitle":"Overview","href":"/installation-guides/v3/flutter/index"},{"title":"How Do I Get Started with the Flutter SDK (v3)?","sidebarTitle":"Getting Started","href":"/installation-guides/v3/flutter/getting-started"},{"title":"How Do I Initialize the Flutter SDK (v3)?","sidebarTitle":"Initialize SDK","href":"/installation-guides/v3/flutter/initialize-sdk"},{"title":"How Do I Initialize the Customer Profile in the Flutter SDK (v3)?","sidebarTitle":"Initialize Customer Profile","href":"/installation-guides/v3/flutter/initialize-profile"}]},{"group":"Core SDK Capabilities","pages":[{"title":"How Do I Show the Profile Widget in the Flutter SDK (v3)?","sidebarTitle":"Show Profile Widget","href":"/installation-guides/v3/flutter/show-profile"},{"title":"How Do I Track Customer Events with the Flutter SDK (v3)?","sidebarTitle":"Track Customer Events","href":"/installation-guides/v3/flutter/track-events"}]},{"group":"Extended Features","pages":[{"title":"How Do I Track Referrals with the Flutter SDK (v3)?","sidebarTitle":"Track Referrals","href":"/installation-guides/v3/flutter/track-referrals"},{"title":"How Do I Set Up Push Notifications in the Flutter SDK (v3)?","sidebarTitle":"Push Notifications","href":"/installation-guides/v3/flutter/push-notifications"},{"title":"How Do I Set Up In-App Messaging in the Flutter SDK (v3)?","sidebarTitle":"In-App Messaging","href":"/installation-guides/v3/flutter/in-app-messaging"}]},{"group":"Deployment \u0026 Maintenance","pages":[{"title":"How Do I Complete the Go-Live Checklist for the Flutter SDK (v3)?","sidebarTitle":"Go-Live Checklist","href":"/installation-guides/v3/flutter/go-live-checklist"},{"title":"How Do I Migrate to the Flutter SDK v4?","sidebarTitle":"Migration Notes","href":"/installation-guides/v3/flutter/migration-notes"}]}]},{"group":"React Native","pages":[{"group":"Overview \u0026 Setup","pages":[{"title":"React Native SDK Integration (v3)","sidebarTitle":"Overview","href":"/installation-guides/v3/react-native/index"},{"title":"How Do I Get Started with the React Native SDK (v3)?","sidebarTitle":"Getting Started","href":"/installation-guides/v3/react-native/getting-started"},{"title":"How Do I Initialize the React Native SDK (v3)?","sidebarTitle":"Initialize SDK","href":"/installation-guides/v3/react-native/initialize-sdk"},{"title":"How Do I Initialize the Customer Profile in the React Native SDK (v3)?","sidebarTitle":"Initialize Customer Profile","href":"/installation-guides/v3/react-native/initialize-profile"}]},{"group":"Core SDK Capabilities","pages":[{"title":"How Do I Show the Profile Widget in the React Native SDK (v3)?","sidebarTitle":"Show Profile Widget","href":"/installation-guides/v3/react-native/show-profile"},{"title":"How Do I Track Customer Events with the React Native SDK (v3)?","sidebarTitle":"Track Customer Events","href":"/installation-guides/v3/react-native/track-events"}]},{"group":"Extended Features","pages":[{"title":"How Do I Track Referrals with the React Native SDK (v3)?","sidebarTitle":"Track Referrals","href":"/installation-guides/v3/react-native/track-referrals"},{"title":"How Do I Set Up Push Notifications in the React Native SDK (v3)?","sidebarTitle":"Push Notifications","href":"/installation-guides/v3/react-native/push-notifications"},{"title":"How Do I Set Up In-App Messaging in the React Native SDK (v3)?","sidebarTitle":"In-App Messaging","href":"/installation-guides/v3/react-native/in-app-messaging"}]},{"group":"Deployment \u0026 Maintenance","pages":[{"title":"How Do I Complete the Go-Live Checklist for the React Native SDK (v3)?","sidebarTitle":"Go-Live Checklist","href":"/installation-guides/v3/react-native/go-live-checklist"},{"title":"How Do I Migrate to the React Native SDK v4?","sidebarTitle":"Migration Notes","href":"/installation-guides/v3/react-native/migration-notes"}]}]}]}]},{"version":"SDK v2","pages":[{"title":"SDK v2","href":"/installation-guides/v2/index"}]}]},{"tab":"Technical Tutorials","pages":[{"title":"Technical Tutorials","href":"/tutorials/general/welcome"}]},{"tab":"API reference","versions":[{"version":"v4.0","groups":[{"group":"API documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"group":"Overview","pages":[{"title":"What's New in V4.0","href":"/api-reference/overview/whats-new"},{"title":"Authentication","href":"/api-reference/overview/authentication"},{"title":"Rate Limiting","href":"/api-reference/overview/rate-limiting"},{"title":"Status and Error Codes","href":"/api-reference/overview/status-error-codes"}]},{"group":"Customers","pages":[{"title":null,"href":"/api-reference/customers/customers"},{"group":"Management","pages":[{"title":"Create/Update Customer","openapi":"POST /api/v4.0/integrations/customers","href":"/api-reference/customers/management/create-customer"},{"title":"Get Customer","openapi":"GET /api/v4.0/integrations/customers/{customerId}","href":"/api-reference/customers/management/get-customer"},{"title":"Get Customer Details","openapi":"GET /api/v4.0/integrations/customers/{customerId}/details","href":"/api-reference/customers/management/get-customer-details"},{"title":"Get Customer Coupons","openapi":"GET /api/v4.0/integrations/customers/{customerId}/coupons","href":"/api-reference/customers/management/get-customer-coupons"},{"title":"Update Customer Activation","openapi":"PUT /api/v4.0/integrations/customers/{customerId}/activate","href":"/api-reference/customers/management/update-customer-activation"},{"title":"Delete Customer","openapi":"DELETE /api/v4.0/integrations/customers/{customerId}","href":"/api-reference/customers/management/delete-customer"},{"title":"Get Customer Hash","openapi":"GET /api/v4.0/integrations/customers/{customerId}/hash","href":"/api-reference/customers/management/get-customer-hash"},{"title":"Validate Referrer Code","openapi":"GET /api/v4.0/integrations/referrals/validate","href":"/api-reference/customers/management/validate-referrer-code"},{"title":"Achieve Social Campaign","openapi":"POST /api/v4.0/integrations/customers/social-challenges","href":"/api-reference/customers/management/achieve-social-campaign"}]},{"group":"Progress","pages":[{"title":"Customer Balance","openapi":"GET /api/v4.0/integrations/customers/{customerId}/balance","href":"/api-reference/customers/progress/get-customer-balance"},{"title":"Customer Tier Progress","openapi":"GET /api/v4.0/integrations/customers/{customerId}/tier-progress","href":"/api-reference/customers/progress/get-customer-progress"},{"title":"Customer Campaigns Progress","openapi":"GET /api/v4.0/integrations/customers/{customerId}/reward-campaigns-progress","href":"/api-reference/customers/progress/get-customer-campaigns-progress"},{"title":"Customer Referrals","openapi":"GET /api/v4.0/integrations/customers/{customerId}/referrals","href":"/api-reference/customers/progress/get-customer-referrals"},{"title":"Customer Referrals Count","openapi":"GET /api/v4.0/integrations/customers/{customerId}/referrals/count","href":"/api-reference/customers/progress/get-customer-referrals-count"},{"title":"Customer Activities","openapi":"GET /api/v4.0/integrations/customers/{customerId}/activities","href":"/api-reference/customers/progress/get-customer-activities"},{"title":"Customer Activities Count","openapi":"GET /api/v4.0/integrations/customers/{customerId}/activities/count","href":"/api-reference/customers/progress/get-customer-activities-count"},{"title":"Customer Automation Campaigns","openapi":"GET /api/v4.0/integrations/customers/{customerId}/automation","href":"/api-reference/customers/progress/get-customer-automation-campaigns"},{"title":"Customer Stamps Progress","openapi":"GET /api/v4.0/integrations/customers/{customerId}/stamps/{challengeId}","href":"/api-reference/customers/progress/get-customer-action-streak-progress"},{"title":"Customer Daily Streak Progress","openapi":"GET /api/v4.0/integrations/customers/{customerId}/streaks/{campaignId}","href":"/api-reference/customers/progress/get-customer-daily-streak-progress"}]},{"group":"Tags","pages":[{"title":"Attach Customer Tags","openapi":"POST /api/v4.0/integrations/customers/{customerId}/tags","href":"/api-reference/customers/tags/attach-customer-tags"},{"title":"Remove Customer Tags","openapi":"DELETE /api/v4.0/integrations/customers/{customerId}/tags","href":"/api-reference/customers/tags/remove-customer-tag"}]},{"group":"Notifications","pages":[{"title":"Customer Notifications","openapi":"GET /api/v4.0/integrations/customers/{customerId}/notifications","href":"/api-reference/customers/notifications/list-customer-notifications"},{"title":"Customer Notifications Count","openapi":"GET /api/v4.0/integrations/customers/{customerId}/notifications/count","href":"/api-reference/customers/notifications/get-customer-notifications-count"},{"title":"Mark Notifications Read","openapi":"PUT /api/v4.0/integrations/customers/{customerId}/notifications/read","href":"/api-reference/customers/notifications/mark-notifications-read"}]}]},{"group":"Events","pages":[{"title":"Send Events","openapi":"POST /api/v4.0/integrations/events","href":"/api-reference/events/send-events"},{"title":"Preview Event Rewards","openapi":"POST /api/v4.0/integrations/events/reward-preview","href":"/api-reference/events/preview-event-rewards"}]},{"group":"Order","pages":[{"title":"Order","href":"/api-reference/order/order"},{"title":"Order Tracking","openapi":"POST /api/v4.0/integrations/orders","href":"/api-reference/order/order-tracking"},{"group":"Order Rewards \u0026 History","pages":[{"title":"Calculate Order Cashback","openapi":"POST /api/v4.0/integrations/orders/cashback","href":"/api-reference/order/calculate-order-cashback"},{"title":"Preview Order Rewards","openapi":"POST /api/v4.0/integrations/orders/reward-preview","href":"/api-reference/order/preview-order-rewards"},{"title":"Order Points Breakdown","openapi":"GET /api/v4.0/integrations/orders/{orderId}/points-breakdown","href":"/api-reference/order/order-points-breakdown"},{"title":"Order Transactions","openapi":"GET /api/v4.0/integrations/orders/{orderId}/transactions","href":"/api-reference/order/order-transactions"}]}]},{"group":"Payment","pages":[{"title":"Payment","href":"/api-reference/payment/payment"},{"title":"Payment Tracking","openapi":"POST /api/v4.0/integrations/payments","href":"/api-reference/payment/payment-tracking"},{"group":"Payment Rewards \u0026 History","pages":[{"title":"Calculate Payment Cashback","openapi":"POST /api/v4.0/integrations/payments/cashback","href":"/api-reference/payment/calculate-payment-cashback"}]}]},{"group":"Transactions","pages":[{"title":"Transactions","href":"/api-reference/transactions/transactions"},{"group":"Cashback \u0026 Redemptions","pages":[{"title":"Cashback \u0026 Redemptions","href":"/api-reference/transactions/cashback-and-redemptions/index"},{"title":"Redeem Points","openapi":"POST /api/v4.0/integrations/transactions/redeem","href":"/api-reference/transactions/cashback-and-redemptions/redeem"},{"title":"Cashback","openapi":"POST /api/v4.0/integrations/transactions/cashback","href":"/api-reference/transactions/cashback-and-redemptions/cashback"},{"title":"Refund","openapi":"POST /api/v4.0/integrations/transactions/refund","href":"/api-reference/transactions/cashback-and-redemptions/refund"}]},{"group":"Hold Management","pages":[{"title":"Hold Management","href":"/api-reference/transactions/hold-management/index"},{"title":"Hold Points","openapi":"POST /api/v4.0/integrations/transactions/hold","href":"/api-reference/transactions/hold-management/hold"},{"title":"Release Hold","openapi":"DELETE /api/v4.0/integrations/transactions/hold/{holdReferenceId}","href":"/api-reference/transactions/hold-management/release"},{"title":"Get Hold Details","openapi":"GET /api/v4.0/integrations/transactions/hold/{holdReferenceId}","href":"/api-reference/transactions/hold-management/get-hold"}]},{"group":"Transaction Management","pages":[{"title":"Transaction Management","href":"/api-reference/transactions/transaction-management/index"},{"title":"List Transactions","openapi":"GET /api/v4.0/integrations/transactions","href":"/api-reference/transactions/transaction-management/list-transactions"},{"title":"Transactions with Customer Data","openapi":"GET /api/v4.0/integrations/transactions/customer-view","href":"/api-reference/transactions/transaction-management/customer-view"},{"title":"Transaction Count","openapi":"GET /api/v4.0/integrations/transactions/count","href":"/api-reference/transactions/transaction-management/count"},{"title":"Add Manual Transaction","openapi":"POST /api/v4.0/integrations/transactions/manual","href":"/api-reference/transactions/transaction-management/manual-transaction"},{"title":"Activate Transaction","openapi":"PUT /api/v4.0/integrations/transactions/{transactionId}/activate","href":"/api-reference/transactions/transaction-management/activate"}]},{"group":"Transaction Validation","pages":[{"title":"Transaction Validation","href":"/api-reference/transactions/transaction-validation/index"},{"title":"Generate OTP","openapi":"POST /api/v4.0/integrations/transactions/otp","href":"/api-reference/transactions/transaction-validation/generate-otp"}]}]},{"group":"Coupons","pages":[{"title":"Coupons API","sidebarTitle":"Coupons","href":"/api-reference/coupons/coupons"},{"title":"Generate Coupon","openapi":"POST /api/v4.0/integrations/coupons/predefined","href":"/api-reference/coupons/generate-coupon"},{"title":"Validate Single Coupon","openapi":"POST /api/v4.0/integrations/coupons/{code}/validate","href":"/api-reference/coupons/validate-single-coupon"},{"title":"Validate Multiple Coupons","openapi":"POST /api/v4.0/integrations/coupons/validate","href":"/api-reference/coupons/validate-multiple-coupons"},{"title":"Burn Coupon","openapi":"POST /api/v4.0/integrations/coupons/burn","href":"/api-reference/coupons/burn-coupon"},{"title":"Release Coupons","openapi":"DELETE /api/v4.0/integrations/coupons/{lockReference}","href":"/api-reference/coupons/release-coupons"},{"title":"Automatic Coupons","openapi":"POST /api/v4.0/integrations/coupons/automatic","href":"/api-reference/coupons/automatic-coupons"}]},{"group":"Configurations","pages":[{"title":"Configurations","href":"/api-reference/configurations/configurations"},{"group":"Reward Configurations","pages":[{"title":"Reward Configurations","href":"/api-reference/configurations/reward-configurations/index"},{"title":"Cashback Configurations","openapi":"GET /api/v4.0/integrations/configurations/cashback","href":"/api-reference/configurations/reward-configurations/cashback-settings"},{"title":"Redemption Configurations","openapi":"GET /api/v4.0/integrations/configurations/redemption","href":"/api-reference/configurations/reward-configurations/redemption-settings"},{"title":"Coupon Configurations","openapi":"GET /api/v4.0/integrations/configurations/coupon","href":"/api-reference/configurations/reward-configurations/coupon-settings"},{"title":"Update Coupon Configurations","openapi":"PUT /api/v4.0/integrations/configurations/coupon","href":"/api-reference/configurations/reward-configurations/update-coupon-settings"}]},{"group":"Program Configurations","pages":[{"title":"Program Configurations","href":"/api-reference/configurations/program-configurations/index"},{"title":"Campaigns Configurations","openapi":"GET /api/v4.0/integrations/configurations/reward-campaigns","href":"/api-reference/configurations/program-configurations/campaigns"},{"title":"Tiers Configurations","description":"Retrieve VIP tier configurations for the loyalty program.","openapi":"GET /api/v4.0/integrations/configurations/tiers","href":"/api-reference/configurations/program-configurations/vip-tiers"},{"title":"Referrals Configurations","openapi":"GET /api/v4.0/integrations/configurations/referrals","href":"/api-reference/configurations/program-configurations/referral-settings"}]},{"title":"Get Widget Configurations","description":"Retrieve styling settings, including colors and other visual elements for the Gameball widget.","openapi":"GET /api/v4.0/integrations/configurations/widget","href":"/api-reference/configurations/widget-configuration/index"}]},{"group":"Leaderboard","pages":[{"title":"Customer Leaderboard","openapi":"GET /api/v4.0/integrations/leaderboard","href":"/api-reference/leaderboard/customer-leaderboard"}]},{"group":"Batches","pages":[{"title":"Batches","href":"/api-reference/batches/batches"},{"group":"Batch Creation","pages":[{"title":"Batch Creation","href":"/api-reference/batches/batch-creation/index"},{"title":"Create Customers Batch Job","openapi":"POST /api/v4.0/integrations/batch/customers","href":"/api-reference/batches/batch-creation/customer-data"},{"title":"Track Orders Batch Job","openapi":"POST /api/v4.0/integrations/batch/orders","href":"/api-reference/batches/batch-creation/orders"},{"title":"Order Transactions Batch Job","openapi":"POST /api/v4.0/integrations/batch/orders/transactions","href":"/api-reference/batches/batch-creation/order-transactions"},{"title":"Balance Inquiry Batch Job","openapi":"POST /api/v4.0/integrations/batch/balance-inquiry","href":"/api-reference/batches/batch-creation/balance-inquiries"},{"title":"Balance Adjustment Batch Job","openapi":"POST /api/v4.0/integrations/batch/balance-adjustment","href":"/api-reference/batches/batch-creation/adjustments"},{"title":"Reward Cashback Batch Job","openapi":"POST /api/v4.0/integrations/batch/cashback","href":"/api-reference/batches/batch-creation/cashback-rewards"},{"title":"Redeem Batch Job","openapi":"POST /api/v4.0/integrations/batch/redeem","href":"/api-reference/batches/batch-creation/redemptions"},{"title":"Send Events Batch Job","openapi":"POST /api/v4.0/integrations/batch/events","href":"/api-reference/batches/batch-creation/events"}]},{"group":"Batch Management","pages":[{"title":"Batch Management","href":"/api-reference/batches/batch-management/index"},{"title":"Check Batch Status","openapi":"GET /api/v4.0/integrations/batches/{batchId}/status","href":"/api-reference/batches/batch-management/check-status"},{"title":"Stop Batch Execution","openapi":"POST /api/v4.0/integrations/batches/{batchId}/stop","href":"/api-reference/batches/batch-management/stop-execution"}]}]}]},{"group":"Webhooks","pages":[{"title":"Overview","href":"/api-reference/webhooks/overview"},{"title":"Subscribing to Webhooks","href":"/api-reference/webhooks/subscribing"},{"group":"Webhook Topics","pages":[{"title":"Webhook Topics","href":"/api-reference/webhooks/webhook-topics"},{"title":"Customer Notifications Webhook","sidebarTitle":"Customer Notifications","href":"/api-reference/webhooks/webhook-topics/notifications"},{"title":"Customer Profile Updates","href":"/api-reference/webhooks/webhook-topics/profile-updates"}]}]}]},{"version":"v4.1","pages":[{"title":"v4.1","href":"/api-reference/introduction-v4.1"}]}]},{"tab":"Updates","pages":[{"title":"Updates","href":"/changelog/updates"}]}]},"basePath":"","title":"Referrals Configurations - Gameball Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}