Returns the membership for one customer in the program: the member, the program, and the member’s loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted.
identification_type chooses how customerId is read. It defaults to customer_id.
Identifies the loyalty program. Format lprg_[a-f0-9]+.
Pattern: ^lprg_[a-f0-9]+$
customerId
string
required
Identifies the customer or member. identification_type selects the value: a Voucherify customer ID (cust_...), a customer source_id, or a loyalty member ID (lmbr_...).
Query Parameters
identification_type
enum<string>
default:customer_id
Selects how customerId is read. customer_id is the Voucherify customer ID and the default. customer_source_id is the customer's source_id. member_id is the loyalty member ID.
Available options:
customer_id,
customer_source_id,
member_id
Response
The membership in the program.
Response body schema for GET/v2/loyalties/programs/{programId}/memberships/{customerId}.
member
object
required
The loyalty program member.
Show child attributes
program
object
required
The loyalty program the member belongs to.
Show child attributes
object
string
required
Object type marker, always membership.
Allowed value: "membership"
cards
object[]
required
Member's loyalty cards, one per card definition assigned to the program. tier_progress is present when that card definition has a tier structure and the member has a tier on the card. Otherwise it is omitted. card.code can be null right after member creation, while code generation is still running.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Voucherify","colors":{"primary":"#163ED4","light":"#96c2ff","dark":"#163ED4"},"logo":{"light":"https://mintcdn.com/voucherify/1CLLMV_7y-xjMglv/images/voucherify_logo_black.png?fit=max\u0026auto=format\u0026n=1CLLMV_7y-xjMglv\u0026q=85\u0026s=44f1ac052a12ff4f06419b90c4227570","dark":"https://mintcdn.com/voucherify/1CLLMV_7y-xjMglv/images/voucherify_logo_white.png?fit=max\u0026auto=format\u0026n=1CLLMV_7y-xjMglv\u0026q=85\u0026s=89afd6e2a2be4d0f902c1847443142b2"},"favicon":"https://mintcdn.com/voucherify/zVE7vhEYBGzEA2LI/images/favicon.png?fit=max\u0026auto=format\u0026n=zVE7vhEYBGzEA2LI\u0026q=85\u0026s=f7b52bcf02ec65303b099f621c628330","api":{"examples":{"languages":["curl"],"prefill":true}},"navbar":{"links":[{"href":"https://www.voucherify.io/contact-support","label":"Contact support"},{"href":"https://www.voucherify.io/contact-sales","label":"Contact sales"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/voucherifyio","slack":"https://www.voucherify.io/community"},"links":[{"header":"Support","items":[{"label":"Contact support","href":"https://www.voucherify.io/contact-support"},{"label":"API status","href":"https://status.voucherify.io"},{"label":"Product roadmap","href":"https://roadmap.voucherify.io/"}]}]},"seo":{"metatags":{"canonical":"https://docs.voucherify.io"}},"styling":{"eyebrows":"breadcrumbs","latex":true},"banner":{"content":"Welcome Worfklows: Configure webhooks for loyalty v2 events! [Learn more about Workflows](/integrations/workflows)!","dismissible":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"voucherify","hasAudioNarration":false,"actualSubdomain":"voucherify","customDomains":["docs.voucherify.io"],"gitSource":{"type":"github","owner":"voucherifyio","repo":"voucherify-openapi","deployBranch":"master","contentDirectory":"documentation","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afef7046d84f03323a2d8c9","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API reference","count":561},{"language":"default","tag":"Endpoints","count":392},{"language":"default","tag":"Events","count":166},{"language":"default","tag":"Loyalty v2","count":104},{"language":"default","tag":"User guides","count":70},{"language":"default","tag":"Loyalty activity","count":65},{"language":"default","tag":"Developer guides","count":62},{"language":"default","tag":"Legacy loyalties","count":57},{"language":"default","tag":"Integrate","count":40},{"language":"default","tag":"Management","count":38}]},"assistantConfig":{"enableAskAiButton":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"type":"link","email":"support@voucherify.io","url":"https://voucherify.atlassian.net/servicedesk/customer/portal/35","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false,"authValue":{"userAuth":{"type":"jwt","signingKeys":[{"id":"ZzG4ncA54yN0NvpkbK7D+funtRuaJHFf+8mOZ7Goqao=","publicKey":"-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE4Sy4C6kRxdmv4o9iKR9MS+GbLKBn\nMC9GplJvmf9bKpCa2v4t2TSfx3Z2hh/8v7G1rCVJfEdSwNMAfg4ofsrgjQ==\n-----END PUBLIC KEY-----\n","createdAt":1760344838832}],"loginUrl":"https://app.voucherify.io/#/redirect-to-docs"}}},"customCss":[{"filePath":"style.css","content":".custom-html{table {\n border-width: 0;\n\n th,\n td {\n border-width: 1px;\n padding: 4px;\n }\n }\n\n margin-bottom: 10px;}"}],"page":{"pagePath":"api-reference/programs/get-program-membership","slug":"/api-reference/programs/get-program-membership","pageMetadata":{"title":"Get program membership","description":"Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes `tier_progress` when its card definition has a tier structure and the member has a tier on that card. Otherwise `tier_progress` is omitted.\n\n`identification_type` chooses how `customerId` is read. It defaults to `customer_id`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/memberships/{customerId}","href":"/api-reference/programs/get-program-membership","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Returns the membership for one customer in the program: the member, the program, and the member’s loyalty cards. A card includes \", _jsx(_components.code, {\n children: \"tier_progress\"\n }), \" when its card definition has a tier structure and the member has a tier on that card. Otherwise \", _jsx(_components.code, {\n children: \"tier_progress\"\n }), \" is omitted.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.code, {\n children: \"identification_type\"\n }), \" chooses how \", _jsx(_components.code, {\n children: \"customerId\"\n }), \" is read. It defaults to \", _jsx(_components.code, {\n children: \"customer_id\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"A successful call records no activity.\"\n })]\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":"Get program membership","description":"Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes `tier_progress` when its card definition has a tier structure and the member has a tier on that card. Otherwise `tier_progress` is omitted.\n\n`identification_type` chooses how `customerId` is read. It defaults to `customer_id`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/memberships/{customerId}","href":"/api-reference/programs/get-program-membership","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getProgramMembership","tags":["Programs"],"summary":"Get program membership","description":"Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes `tier_progress` when its card definition has a tier structure and the member has a tier on that card. Otherwise `tier_progress` is omitted.\n\n`identification_type` chooses how `customerId` is read. It defaults to `customer_id`.\n\nA successful call records no activity.","parameters":["37ddaa72-0c73-43f8-b1f0-0c69e7619c7b"],"responses":{"200":"994c6170-5053-4b0a-a779-e15acaeaa8e5","400":"0bd5ab29-6532-4b32-8d43-b640a9209a29","404":"7aefb977-353c-40fd-a2c2-4f2aa7712bb0","500":"384e34e6-5980-4067-9004-81ea8ae8e2ed"},"security":["4e9b27d0-316f-440f-8bb4-356b2570f543","5d5f14ce-31e6-41db-bb3d-15059faa78ed"],"method":"get","type":"path","servers":["7ff9fc50-9bbf-4909-95b5-ba922ad3102e"],"path":"/v2/loyalties/programs/{programId}/memberships/{customerId}","baseUrlOptions":["https://{cluster}.voucherify.io"],"title":"Get program membership","codeSamples":[],"requestExampleLanguages":["bash"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"37ddaa72-0c73-43f8-b1f0-0c69e7619c7b":{"name":"identification_type","in":"query","required":false,"description":"Selects how `customerId` is read. `customer_id` is the Voucherify customer ID and the default. `customer_source_id` is the customer's `source_id`. `member_id` is the loyalty member ID.","schema":{"type":"string","enum":["customer_id","customer_source_id","member_id"],"default":"customer_id","isRequired":false,"description":"Selects how `customerId` is read. `customer_id` is the Voucherify customer ID and the default. `customer_source_id` is the customer's `source_id`. `member_id` is the loyalty member ID.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"a30a14bd-6825-480d-b2f0-ca16930cf839":{"name":"programId","in":"path","required":true,"description":"Identifies the loyalty program. Format `lprg_[a-f0-9]+`.","schema":{"type":"string","pattern":"^lprg_[a-f0-9]+$","isRequired":true,"description":"Identifies the loyalty program. Format `lprg_[a-f0-9]+`.","uniqueKey":"","typeLabel":"string"}},"a3cc9cbf-9956-4971-a664-c25256d9a870":{"name":"customerId","in":"path","required":true,"description":"Identifies the customer or member. `identification_type` selects the value: a Voucherify customer ID (`cust_...`), a customer `source_id`, or a loyalty member ID (`lmbr_...`).","schema":{"type":"string","isRequired":true,"description":"Identifies the customer or member. `identification_type` selects the value: a Voucherify customer ID (`cust_...`), a customer `source_id`, or a loyalty member ID (`lmbr_...`).","uniqueKey":"","typeLabel":"string"}}},"responses":{"994c6170-5053-4b0a-a779-e15acaeaa8e5":{"description":"The membership in the program.","content":{"application/json":{"schema":{"type":"object","title":"V2 Loyalties Programs Memberships Get Response Body","description":"Response body schema for **GET** `/v2/loyalties/programs/{programId}/memberships/{customerId}`.","required":["cards","member","program","object"],"properties":{"member":{"type":"object","description":"The loyalty program member.","properties":{"id":{"type":"string","pattern":"^lmbr_[a-f0-9]+$","description":"Identifies the member.","isRequired":true,"uniqueKey":"member.id","typeLabel":"string"},"customer_id":{"type":"string","pattern":"^cust_[a-zA-Z0-9]+","description":"Identifies the enrolled customer.","isRequired":true,"uniqueKey":"member.customer_id","typeLabel":"string"},"program_id":{"type":"string","pattern":"^lprg_[a-f0-9]+$","description":"Identifies the loyalty program.","isRequired":true,"uniqueKey":"member.program_id","typeLabel":"string"},"status":{"type":"string","enum":["ACTIVE","INACTIVE","DELETED"],"description":"Current member status. Allowed values: `ACTIVE`, `INACTIVE`, `DELETED`. `INACTIVE` members cannot earn points or redeem rewards.","isRequired":true,"uniqueKey":"member.status","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"Stores custom member metadata. Empty object when none is set.","isRequired":true,"uniqueKey":"member.metadata","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","description":"Records when the member was created (ISO 8601).","isRequired":true,"uniqueKey":"member.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Records the last update (ISO 8601). `null` if the member has never been updated.","isRequired":true,"uniqueKey":"member.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Records the last update (ISO 8601). `null` if the member has never been updated.","isRequired":true,"uniqueKey":"member.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"member.updated_at","typeLabel":"string\u003cdate-time> | null"},"object":{"type":"string","const":"member","description":"Object type. Always `member`.","isRequired":true,"uniqueKey":"member.object","typeLabel":"string"}},"required":["id","customer_id","program_id","status","metadata","created_at","updated_at","object"],"isRequired":true,"uniqueKey":"member","typeLabel":"object"},"program":{"type":"object","description":"The loyalty program the member belongs to.","properties":{"id":{"type":"string","description":"Unique program identifier.","pattern":"^lprg_[a-f0-9]+$","isRequired":true,"uniqueKey":"program.id","typeLabel":"string"},"name":{"type":"string","description":"Program name.","isRequired":true,"uniqueKey":"program.name","typeLabel":"string"},"status":{"type":"string","description":"Program status.","enum":["DRAFT","ACTIVE","INACTIVE","DELETED"],"isRequired":true,"uniqueKey":"program.status","typeLabel":"enum\u003cstring>"},"metadata":{"type":"object","description":"User-defined key-value metadata. Defaults to `{}`.","isRequired":true,"uniqueKey":"program.metadata","typeLabel":"object"},"object":{"type":"string","const":"program","description":"Object type marker. Always `program`.","isRequired":true,"uniqueKey":"program.object","typeLabel":"string"}},"required":["id","name","status","metadata","object"],"isRequired":true,"uniqueKey":"program","typeLabel":"object"},"object":{"type":"string","const":"membership","description":"Object type marker, always `membership`.","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"cards":{"type":"array","description":"Member's loyalty cards, one per card definition assigned to the program. `tier_progress` is present when that card definition has a tier structure and the member has a tier on the card. Otherwise it is omitted. `card.code` can be `null` right after member creation, while code generation is still running.","items":{"type":"object","description":"A membership's loyalty card - the member's assignment to the card (`member_role`, `created_at`) combined with the card details in the `card` object and the member's tier progress on this card.","required":["member_role","created_at","card","object"],"properties":{"member_role":{"type":"string","enum":["OWNER","MEMBER"],"description":"Role of the member on this card. Currently, loyalty program members can have only the `OWNER` role.","isRequired":true,"uniqueKey":"cards.items.[INDEX].member_role","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the card was assigned to the member (ISO 8601).","isRequired":true,"uniqueKey":"cards.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"card":{"oneOf":[{"type":"object","description":"The loyalty card details, or `null` when the card is not available.","required":["next_expiration","next_activation","id","card_definition_id","card_type","code","lifetime_bucket","balance","object"],"properties":{"id":{"type":"string","pattern":"^lcrd_[a-f0-9]+$","description":"Identifies the card.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.id","typeLabel":"string"},"card_definition_id":{"type":"string","pattern":"^lcdef_[a-f0-9]+$","description":"Identifies the card definition.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.card_definition_id","typeLabel":"string"},"card_type":{"type":"string","enum":["INDIVIDUAL"],"description":"Card type. Currently only `INDIVIDUAL` is supported.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.card_type","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"string","description":"Human-readable card code. Card code generation is asynchronous - this field is `null` right after member creation and is populated shortly after, once the background code generation completes.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable card code. Card code generation is asynchronous - this field is `null` right after member creation and is populated shortly after, once the background code generation completes.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.code","typeLabel":"string | null"},"lifetime_bucket":{"type":"object","description":"Lifetime point counters of the card.","properties":{"points":{"type":"object","description":"Lifetime counters of regular (active) points.","properties":{"total":{"type":"number","description":"Total accumulated points, including points added manually, earned by fulfilling earning rules and activated from pending points (excluding returned points).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.total","typeLabel":"number"},"earned":{"type":"number","description":"Total points earned by fulfilling earning rules (does not include activated pending points or points added manually).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.earned","typeLabel":"number"},"added":{"type":"number","description":"Total manually added points.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.added","typeLabel":"number"},"purchased":{"type":"number","description":"Total points purchased via a `LOYALTY_CARD_POINTS` reward (credited to the target card).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.purchased","typeLabel":"number"},"purchased_reversed":{"type":"number","description":"Total purchased points reversed via reward refund.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.purchased_reversed","typeLabel":"number"},"subtracted":{"type":"number","description":"Total manually subtracted points.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.subtracted","typeLabel":"number"},"expired":{"type":"number","description":"Total expired points.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.expired","typeLabel":"number"},"spent":{"type":"number","description":"Total points spent on rewards.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.spent","typeLabel":"number"},"refunded":{"type":"number","description":"Total refunded points (points that were earned by products which were later returned).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.refunded","typeLabel":"number"},"returned":{"type":"number","description":"Total returned points (by returning a purchased reward).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.returned","typeLabel":"number"},"locked":{"type":"number","description":"Total locked points (by locking a purchased reward).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.locked","typeLabel":"number"},"unlocked":{"type":"number","description":"Total unlocked points (by unlocking a purchased reward).","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.unlocked","typeLabel":"number"},"referrer_earned":{"type":"number","description":"Total points credited as a referrer from a `LOYALTY_POINTS` referral reward. Already included in `total`, not in `earned`.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.referrer_earned","typeLabel":"number"},"referee_earned":{"type":"number","description":"Total points credited as a referee from a `LOYALTY_POINTS` referral reward. Already included in `total`, not in `earned`.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points.referee_earned","typeLabel":"number"}},"required":["total","earned","added","purchased","purchased_reversed","subtracted","expired","spent","refunded","returned","locked","unlocked","referrer_earned","referee_earned"],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.points","typeLabel":"object"},"pending_points":{"type":"object","description":"Lifetime counters of pending points.","properties":{"total":{"type":"number","description":"Total pending points ever added.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.pending_points.total","typeLabel":"number"},"activated":{"type":"number","description":"Total pending points activated into regular points.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.pending_points.activated","typeLabel":"number"},"canceled":{"type":"number","description":"Total pending points canceled.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.pending_points.canceled","typeLabel":"number"}},"required":["total","activated","canceled"],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket.pending_points","typeLabel":"object"}},"required":["points","pending_points"],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.lifetime_bucket","typeLabel":"object"},"balance":{"type":"object","description":"Current available balance calculated from the lifetime bucket.","properties":{"points":{"type":"number","description":"Currently available regular points.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.balance.points","typeLabel":"number"},"pending_points":{"type":"number","description":"Currently pending (not yet activated) points.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.balance.pending_points","typeLabel":"number"}},"required":["points","pending_points"],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.balance","typeLabel":"object"},"object":{"type":"string","const":"card","description":"Object type. Always `card`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.object","typeLabel":"string"},"next_expiration":{"oneOf":[{"type":"object","description":"The nearest upcoming point expiration, or `null` when none is scheduled.","required":["points","date"],"properties":{"points":{"type":"number","description":"Number of points that will expire.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_expiration.oneOf.0.points","typeLabel":"number"},"date":{"type":"string","format":"date","description":"Date when the points expire (`YYYY-MM-DD`).","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_expiration.oneOf.0.date","typeLabel":"string\u003cdate>"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_expiration.oneOf.0","typeLabel":"object"},{"type":"null","description":"The nearest upcoming point expiration, or `null` when none is scheduled.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_expiration.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_expiration","typeLabel":"object | null"},"next_activation":{"oneOf":[{"type":"object","description":"The nearest upcoming pending point activation, or `null` when none is scheduled.","required":["points","type"],"properties":{"points":{"type":"number","description":"Number of pending points to be activated.","default":0,"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation.oneOf.0.points","typeLabel":"number"},"type":{"type":"string","enum":["IMMEDIATE","PERIOD_BASED","FIXED_DATES","EVENT_BASED"],"description":"Pending points activation type from the card definition.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation.oneOf.0.type","typeLabel":"enum\u003cstring>"},"date":{"type":"string","format":"date","description":"Activation date (`YYYY-MM-DD`). Present for all types except `EVENT_BASED`.","uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation.oneOf.0.date","typeLabel":"string\u003cdate>"},"cancel_date":{"type":"string","format":"date","description":"Date when the pending points are canceled if the activating event does not occur (`YYYY-MM-DD`). Present only for the `EVENT_BASED` type.","uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation.oneOf.0.cancel_date","typeLabel":"string\u003cdate>"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation.oneOf.0","typeLabel":"object"},{"type":"null","description":"The nearest upcoming pending point activation, or `null` when none is scheduled.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0.next_activation","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.0","typeLabel":"object"},{"type":"null","description":"The loyalty card details, or `null` when the card is not available.","isRequired":true,"uniqueKey":"cards.items.[INDEX].card.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].card","typeLabel":"object | null"},"object":{"type":"string","const":"member_card","description":"Object type marker, always `member_card`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].object","typeLabel":"string"},"tier_progress":{"type":"object","description":"The member's tier progress on this card. Omitted when the card definition has no tier structure, or the member has no tier on this card.","properties":{"current":{"oneOf":[{"type":"object","description":"The member's current tier, or `null`.","required":["tier","start_at","expires_at","points"],"properties":{"tier":{"oneOf":[{"type":"object","description":"Current tier reference, or `null` when the member has no current tier.","required":["id","name"],"properties":{"id":{"oneOf":[{"type":"string","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0.name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.0","typeLabel":"object"},{"type":"null","description":"Current tier reference, or `null` when the member has no current tier.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.tier","typeLabel":"object | null"},"start_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the current tier started for the member (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the current tier started for the member (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.start_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.start_at","typeLabel":"string\u003cdate-time> | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the member's tier expires (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the member's tier expires (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.expires_at","typeLabel":"string\u003cdate-time> | null"},"points":{"oneOf":[{"type":"object","description":"Member's points position within the tier's points range, or `null`.","required":["current","min"],"properties":{"current":{"type":"number","description":"Member's current points counted towards the tier.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.points.oneOf.0.current","typeLabel":"number"},"min":{"type":"number","description":"Minimum points of the tier's range.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.points.oneOf.0.min","typeLabel":"number"},"max":{"type":"number","description":"Maximum points of the tier's range. Absent if this is the highest tier in the tier structure.","uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.points.oneOf.0.max","typeLabel":"number"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.points.oneOf.0","typeLabel":"object"},{"type":"null","description":"Member's points position within the tier's points range, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.points.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0.points","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.0","typeLabel":"object"},{"type":"null","description":"The member's current tier, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.current","typeLabel":"object | null"},"tier_structure":{"oneOf":[{"type":"object","description":"Reference to the tier structure the progress relates to, or `null`.","required":["id","object"],"properties":{"id":{"type":"string","pattern":"^lts_[a-f0-9]+$","description":"Tier structure ID.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.tier_structure.oneOf.0.id","typeLabel":"string"},"object":{"type":"string","const":"tier_structure","description":"Object type marker, always `tier_structure`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.tier_structure.oneOf.0.object","typeLabel":"string"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.tier_structure.oneOf.0","typeLabel":"object"},{"type":"null","description":"Reference to the tier structure the progress relates to, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.tier_structure.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.tier_structure","typeLabel":"object | null"},"deferred":{"type":"array","description":"Upcoming tier assignments scheduled to start later, when the tier structure defers tier changes. The member will be assigned to the deferred tier at the start date.","items":{"type":"object","description":"A tier assignment deferred to a future date.","properties":{"tier":{"oneOf":[{"type":"object","description":"Deferred tier reference, or `null`.","required":["id","name"],"properties":{"id":{"oneOf":[{"type":"string","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0.name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.0","typeLabel":"object"},{"type":"null","description":"Deferred tier reference, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].tier","typeLabel":"object | null"},"start_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the deferred tier starts (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].start_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the deferred tier starts (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].start_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].start_at","typeLabel":"string\u003cdate-time> | null"},"expires_at":{"oneOf":[{"type":"string","format":"date-time","description":"Timestamp when the deferred tier expires (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Timestamp when the deferred tier expires (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time> | null"}},"required":["tier","start_at","expires_at"],"uniqueKey":"cards.items.[INDEX].tier_progress.deferred.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.deferred","typeLabel":"object[]"},"risks":{"type":"array","description":"Upcoming risks of losing or downgrading the current tier.","items":{"type":"object","description":"A risk of losing or downgrading the current tier.","properties":{"type":{"type":"string","enum":["TIER_DOWNGRADE","TIER_LEFT"],"description":"Risk type - `TIER_DOWNGRADE` when the member would fall to a lower tier, `TIER_LEFT` when the member would leave the tier structure entirely.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"date":{"oneOf":[{"type":"string","format":"date-time","description":"Date when the risk materializes (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Date when the risk materializes (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].date.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].date","typeLabel":"string\u003cdate-time> | null"},"tier":{"oneOf":[{"type":"object","description":"Tier the member would be downgraded to, or `null` for `TIER_LEFT`.","required":["id","name"],"properties":{"id":{"oneOf":[{"type":"string","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0.name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.0","typeLabel":"object"},{"type":"null","description":"Tier the member would be downgraded to, or `null` for `TIER_LEFT`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX].tier","typeLabel":"object | null"}},"required":["type","date","tier"],"uniqueKey":"cards.items.[INDEX].tier_progress.risks.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.risks","typeLabel":"object[]"},"opportunities":{"type":"array","description":"Opportunities to reach higher tiers. Deferred tiers are not included in this list.","items":{"type":"object","description":"An opportunity to reach a higher tier.","properties":{"valid_until":{"oneOf":[{"type":"string","format":"date-time","description":"Deadline for taking advantage of the opportunity (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].valid_until.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Deadline for taking advantage of the opportunity (ISO 8601), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].valid_until.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].valid_until","typeLabel":"string\u003cdate-time> | null"},"tier":{"oneOf":[{"type":"object","description":"Tier that can be reached, or `null`.","required":["id","name"],"properties":{"id":{"oneOf":[{"type":"string","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^lt_[a-f0-9]+$","description":"Unique Voucherify ID of the tier (`lt_...`), or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0.id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0.id","typeLabel":"string | null"},"name":{"oneOf":[{"type":"string","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tier name, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0.name","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.0","typeLabel":"object"},{"type":"null","description":"Tier that can be reached, or `null`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].tier","typeLabel":"object | null"},"points":{"type":"number","description":"Points needed to reach the tier.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX].points","typeLabel":"number"}},"required":["valid_until","tier","points"],"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.opportunities","typeLabel":"object[]"},"object":{"type":"string","const":"member_tier_progress","description":"Object type marker, always `member_tier_progress`.","isRequired":true,"uniqueKey":"cards.items.[INDEX].tier_progress.object","typeLabel":"string"}},"required":["current","tier_structure","deferred","risks","opportunities","object"],"uniqueKey":"cards.items.[INDEX].tier_progress","typeLabel":"object"}},"uniqueKey":"cards.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"cards","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"V2 Loyalties Programs Memberships Get Response Body · object"},"examples":{"Get membership":{"title":"Get membership","value":{"member":{"id":"lmbr_128f962dbc8c4ba5dc","customer_id":"cust_6onRrs4kCnvSVrTs5YtDPFBG","program_id":"lprg_128f58429f4c4bf7b2","status":"ACTIVE","metadata":{},"created_at":"2026-06-11T15:59:41.298Z","updated_at":null,"object":"member"},"program":{"id":"lprg_128f58429f4c4bf7b2","name":"Summer Rewards","status":"ACTIVE","metadata":{},"object":"program"},"cards":[{"member_role":"OWNER","created_at":"2026-06-11T15:59:41.303Z","tier_progress":{"current":{"tier":{"id":"lt_128f4a88414c4bed6a","name":"Gold"},"start_at":"2026-06-15T00:00:00.000Z","expires_at":"2027-06-15T00:00:00.000Z","points":{"current":740,"min":500,"max":1500}},"tier_structure":{"id":"lts_128f4a88414c4bed69","object":"tier_structure"},"deferred":[],"risks":[{"type":"TIER_DOWNGRADE","date":"2026-09-01T00:00:00.000Z","tier":{"id":"lt_128f4b46558c4bedff","name":"Silver"}}],"opportunities":[],"object":"member_tier_progress"},"card":{"id":"lcrd_128f962dbd8c4ba5df","card_definition_id":"lcdef_128f495f720c4bec8c","card_type":"INDIVIDUAL","code":"SummerTime-7z8dWawICd","lifetime_bucket":{"points":{"total":740,"earned":40,"added":700,"purchased":0,"purchased_reversed":0,"subtracted":30,"expired":300,"spent":250,"refunded":0,"returned":0,"locked":250,"unlocked":250,"referrer_earned":0,"referee_earned":0},"pending_points":{"total":160,"activated":40,"canceled":0}},"balance":{"points":160,"pending_points":120},"next_expiration":{"points":160,"date":"2026-08-08"},"next_activation":{"points":10,"type":"PERIOD_BASED","date":"2026-07-20"},"object":"card"},"object":"member_card"},{"member_role":"OWNER","created_at":"2026-06-11T15:59:41.303Z","card":{"id":"lcrd_128f962dbd8c4ba5e0","card_definition_id":"lcdef_128f49963c0c4becb7","card_type":"INDIVIDUAL","code":"AutumnTime-R02hVARx33","lifetime_bucket":{"points":{"total":50,"earned":0,"added":50,"purchased":0,"purchased_reversed":0,"subtracted":0,"expired":0,"spent":0,"refunded":0,"returned":0,"locked":0,"unlocked":0,"referrer_earned":0,"referee_earned":0},"pending_points":{"total":160,"activated":0,"canceled":0}},"balance":{"points":50,"pending_points":160},"next_expiration":{"points":50,"date":"2026-12-23"},"next_activation":{"points":160,"type":"FIXED_DATES","date":"2026-12-23"},"object":"card"},"object":"member_card"}],"object":"membership"}}},"exampleType":"examples"}},"exampleType":"examples"},"0bd5ab29-6532-4b32-8d43-b640a9209a29":{"description":"The query failed validation (`invalid_query_params`). `identification_type` must be `customer_id`, `customer_source_id`, or `member_id`.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response returned by all Loyalty v2 endpoints.","properties":{"code":{"type":"integer","description":"HTTP status code of the error.","uniqueKey":"code","typeLabel":"integer"},"key":{"type":"string","description":"Machine-readable error key.","uniqueKey":"key","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error.","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier of the request that produced the error.","uniqueKey":"request_id","typeLabel":"string"},"resource_id":{"type":"string","description":"Unique identifier of the resource that produced the error.","uniqueKey":"resource_id","typeLabel":"string"},"resource_type":{"type":"string","description":"Type of the resource that produced the error.","uniqueKey":"resource_type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Unsupported identification type":{"title":"Unsupported identification type","value":{"code":400,"key":"invalid_query_params","message":"Invalid query params","details":"Property .identification_type must be equal to one of the allowed values [ customer_id, customer_source_id, member_id ]","request_id":"v-12bdef050f2cb1ef70"}}},"exampleType":"examples"}},"exampleType":"examples"},"7aefb977-353c-40fd-a2c2-4f2aa7712bb0":{"description":"The program doesn't exist (`resource_type` `program`), the source ID doesn't match a customer (`resource_type` `customer`), or there is no membership in the program (`resource_type` `member`). A lookup by customer ID with no membership returns that customer ID as `resource_id`.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response returned by all Loyalty v2 endpoints.","properties":{"code":{"type":"integer","description":"HTTP status code of the error.","uniqueKey":"code","typeLabel":"integer"},"key":{"type":"string","description":"Machine-readable error key.","uniqueKey":"key","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error.","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier of the request that produced the error.","uniqueKey":"request_id","typeLabel":"string"},"resource_id":{"type":"string","description":"Unique identifier of the resource that produced the error.","uniqueKey":"resource_id","typeLabel":"string"},"resource_type":{"type":"string","description":"Type of the resource that produced the error.","uniqueKey":"resource_type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Program not found":{"title":"Program not found","value":{"code":404,"key":"not_found","message":"Resource not found","details":"Cannot find program with id lprg_128f58429f4c4bf7b2","request_id":"v-12bdef050f2cb1ef6f","resource_id":"lprg_128f58429f4c4bf7b2","resource_type":"program"}},"Customer not found":{"title":"Customer not found","value":{"code":404,"key":"not_found","message":"Resource not found","details":"Cannot find customer with id nonexistent-source-id","request_id":"v-12bdef050f2cb1ef6e","resource_id":"nonexistent-source-id","resource_type":"customer"}},"No membership":{"title":"No membership","value":{"code":404,"key":"not_found","message":"Resource not found","details":"Cannot find member with id cust_6onRrs4kCnvSVrTs5YtDPFBG","request_id":"v-12bdef050f2cb1ef71","resource_id":"cust_6onRrs4kCnvSVrTs5YtDPFBG","resource_type":"member"}}},"exampleType":"examples"}},"exampleType":"examples"},"384e34e6-5980-4067-9004-81ea8ae8e2ed":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","description":"Standard error response returned by all Loyalty v2 endpoints.","properties":{"code":{"type":"integer","description":"HTTP status code of the error.","uniqueKey":"code","typeLabel":"integer"},"key":{"type":"string","description":"Machine-readable error key.","uniqueKey":"key","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message.","uniqueKey":"message","typeLabel":"string"},"details":{"type":"string","description":"Additional details about the error.","uniqueKey":"details","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier of the request that produced the error.","uniqueKey":"request_id","typeLabel":"string"},"resource_id":{"type":"string","description":"Unique identifier of the resource that produced the error.","uniqueKey":"resource_id","typeLabel":"string"},"resource_type":{"type":"string","description":"Type of the resource that produced the error.","uniqueKey":"resource_type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Internal server error":{"title":"Internal server error","value":{"code":500,"key":"api_error","message":"Something went wrong. Don't worry, your campaigns are still safe and the Voucherify Team has been notified. Check out our Help Center and forums for help, or head back to home."}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"4e9b27d0-316f-440f-8bb4-356b2570f543":{"X-App-Id":{"type":"apiKey","name":"X-App-Id","in":"header","scopes":[],"schemeName":"X-App-Id"},"X-App-Token":{"type":"apiKey","name":"X-App-Token","in":"header","scopes":[],"schemeName":"X-App-Token"}},"5d5f14ce-31e6-41db-bb3d-15059faa78ed":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7ff9fc50-9bbf-4909-95b5-ba922ad3102e":{"url":"https://{cluster}.voucherify.io","description":"Base URL","variables":{"cluster":{"default":"api","enum":["api","us1.api","as1.api","download","us1.download","as1.download"]}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"X-App-Id","in":"header","scopes":[],"schemeName":"X-App-Id"},"schema":{"title":"X-App-Id","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-App-Id","name":"X-App-Id"},{"scheme":{"type":"apiKey","name":"X-App-Token","in":"header","scopes":[],"schemeName":"X-App-Token"},"schema":{"title":"X-App-Token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"X-App-Token","name":"X-App-Token"}],"title":"X-App-Id \u0026 X-App-Token"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/loyalties-v2.json"},"subdomain":"voucherify","siteName":"Voucherify","title":"Get program membership - Voucherify","originalFileLocation":"api-reference/programs/get-program-membership.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=\"Returns the membership for one customer in the program: the member, the program, and the member\u0026#x27;s loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted. identification_type chooses how customerId is read. It defaults to customer_id. A successful call records no activity.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Voucherify\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_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/voucherify/srve3tXRVM8wZJwY/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get program membership - Voucherify\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the membership for one customer in the program: the member, the program, and the member\u0026#x27;s loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted. identification_type chooses how customerId is read. It defaults to customer_id. A successful call records no activity.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Voucherify\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voucherify.io/api-reference/programs/get-program-membership\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://voucherify.mintlify.site/_mintlify/api/og/v2?division=Members\u0026amp;title=Get+program+membership\u0026amp;description=Returns+the+membership+for+one+customer+in+the+program%3A+the+member%2C+the+program%2C+and+the+member%27s+loyalty+cards.+A+card+includes+%60tier_progress%60+when+its+card+d\u0026amp;theme=02a90c23734367428f93d0a5\u0026amp;signature=b7634103b82532c9e230a79ee2d25a1c98f74218ea8680d7f565dad069fd9d66\">\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=\"Get program membership - Voucherify\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the membership for one customer in the program: the member, the program, and the member\u0026#x27;s loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted. identification_type chooses how customerId is read. It defaults to customer_id. A successful call records no activity.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://voucherify.mintlify.site/_mintlify/api/og/v2?division=Members\u0026amp;title=Get+program+membership\u0026amp;description=Returns+the+membership+for+one+customer+in+the+program%3A+the+member%2C+the+program%2C+and+the+member%27s+loyalty+cards.+A+card+includes+%60tier_progress%60+when+its+card+d\u0026amp;theme=02a90c23734367428f93d0a5\u0026amp;signature=b7634103b82532c9e230a79ee2d25a1c98f74218ea8680d7f565dad069fd9d66\">\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/voucherify/srve3tXRVM8wZJwY/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Voucherify\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#163ED4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voucherify.io/api-reference/programs/get-program-membership\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/programs/get-program-membership.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voucherify.io/#organization\",\"name\":\"Voucherify\",\"url\":\"https://docs.voucherify.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/voucherify/1CLLMV_7y-xjMglv/images/voucherify_logo_black.png?fit=max\u0026auto=format\u0026n=1CLLMV_7y-xjMglv\u0026q=85\u0026s=44f1ac052a12ff4f06419b90c4227570\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voucherify.io#website\",\"name\":\"Voucherify\",\"url\":\"https://docs.voucherify.io\",\"publisher\":{\"@id\":\"https://docs.voucherify.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership#webpage\",\"url\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership\",\"name\":\"Get program membership\",\"description\":\"Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted. identification_type chooses how customerId is read. It defaults to customer_id. A successful call records no activity.\",\"isPartOf\":{\"@id\":\"https://docs.voucherify.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.voucherify.io/api-reference/publications/publication-object\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Loyalty v2\",\"item\":\"https://docs.voucherify.io/api-reference/loyalty-v2-api-overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Members\",\"item\":\"https://docs.voucherify.io/api-reference/loyalty-v2-members-overview\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get program membership\",\"item\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership#apireference\",\"headline\":\"Get program membership\",\"name\":\"Get program membership\",\"description\":\"Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes tier_progress when its card definition has a tier structure and the member has a tier on that card. Otherwise tier_progress is omitted. identification_type chooses how customerId is read. It defaults to customer_id. A successful call records no activity.\",\"url\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voucherify.io/api-reference/programs/get-program-membership#webpage\"},\"publisher\":{\"@id\":\"https://docs.voucherify.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voucherify.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Voucherify\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Voucherify\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/programs/get-program-membership.md","siteName":"Voucherify","nav":{"global":null,"tabs":[{"tab":"Voucherify","groups":[{"group":"Get started","public":true,"pages":[{"title":"Voucherify docs","description":"Welcome to Voucherify documentation!","mode":"frame","contextual":true,"keywords":["introduction","documentation"],"diataxis":"explanation","href":"/get-started/introduction"},{"title":"Voucherify overview","description":"Learn about Voucherify and its possibilities","keywords":["learn","possibility","explore","solve"],"diataxis":"explanation","href":"/get-started/welcome-to-voucherify"},{"title":"Integration blueprint","description":"Follow this blueprint for a successful Voucherify launch","keywords":["blueprint","launch","discover","plan","integrate","migrate","business scenario","use case"],"diataxis":"explanation","href":"/get-started/integration-overview"},{"title":"Key concepts","description":"Learn the key concepts to help you implement loyalty and promotional campaigns and integrate Voucherify with your stack","keywords":["concept","implement","integrate","definition","glossary"],"diataxis":"explanation","href":"/get-started/key-concepts"}]}]},{"tab":"Developer guides","groups":[{"group":"Develop","public":true,"pages":[{"title":"API quickstart","description":"Make your first API call in minutes","keywords":["project","create","first","start","first API call","API keys","account","team","sandbox","demo shop","Postman","developer"],"diataxis":"tutorial","href":"/guides/api-quickstart"},{"title":"Development checklist","description":"Learn what development steps you need to take to integrate with Voucherify","keywords":["development","integration","checklist","step"],"diataxis":"how-to","href":"/guides/development"},{"title":"Authentication and authorization","description":"Authorization methods and principles used to access the Voucherify platform HTTP APIs.","keywords":["overview","authentication","primary","secret","keys","client-side","OAuth 2.0","integration"],"diataxis":"reference","href":"/guides/authentication"},{"title":"Integration processes","description":"Integrate Voucherify with your system and apply different scenarios","keywords":["case","integration","process","journey"],"diataxis":"explanation","href":"/guides/integration-processes"},{"title":"API overview","description":"Learn how Voucherify’s API works to build, optimize, or maintain your integration","keywords":["API","overview","optimization","version","endpoint","region","region","client-side","performance","p95","response times","rate limiting"],"diataxis":"explanation","href":"/guides/api-overview"},{"title":"Management API","description":"API endpoints for managing account-related operations","keywords":["operations","account","management","project","manage project","automate"],"diataxis":"how-to","href":"/guides/management-api"},{"title":"Data parsing","description":"Learn how to read and use data sent by Voucherify","keywords":["response","end-customer","analysis","parsing","which data to use"],"diataxis":"how-to","href":"/guides/data-parsing"},{"title":"Metadata mapping","description":"Custom attributes (metadata) and their use in Voucherify","keywords":["custom","attribute","example","library","custom attribute","schema"],"diataxis":"how-to","href":"/guides/metadata-mapping"},{"title":"Voucherify Core MCP","description":"Use AI to access Voucherify data","keywords":["AI","LLM","model","Voucherify AI integration","Large Language Models","Voucherify Core MCP","Model Context Protocol","MCP integration guide","AI agent data access","MCP client configuration","Voucherify AI tools","MCP server installation"],"diataxis":"how-to","href":"/guides/voucherify-core-mcp"},{"title":"Voucherify Docs MCP","description":"Connect AI tools like Claude, Cursor, and VS Code to Voucherify documentation using MCP","keywords":["docs MCP","use docs with AI tools","Model Context Protocol","Claude","Cursor","Claude code","Visual Studio Code","documentation MCP","AI integration","LLM integration"],"diataxis":"how-to","href":"/guides/voucherify-docs-mcp"},{"title":"Data synchronization","description":"Learn what kind of data you can synchronize with Voucherify and how you can do this","keywords":["synchronization","import","override","update"],"diataxis":"explanation","href":"/guides/data-synchronization"},{"title":"SDKs","keywords":["library","SDK","restful","API","JS","Java","PHP","Python","Ruby","Node.js","DotNET","Software Development Kit"],"diataxis":"reference","description":null,"href":"/guides/sdks"},{"title":"Security","description":"Voucherify data security","keywords":["ISO","compliance","GDPR","privacy","PII"],"diataxis":"explanation","href":"/guides/security"},{"title":"Limits","description":"API calls limits and optimization","keywords":["summary","limits","optimization","buy API calls","API package"],"diataxis":"reference","href":"/guides/limits"},{"title":"Transfer loyalty points","description":"See how to transfer points between loyalty cards.","keywords":["transfer","combine","multiple","reward"],"tag":"SUNSET","diataxis":"how-to","href":"/guides/transfer-loyalty-points"}]},{"group":"Incentivize","public":true,"pages":[{"title":"Loyalty v2 developer overview","description":"Learn basics about your loyalty v2 integration: API surface, core objects, and the member journey","keywords":["loyalty v2","developer","integration","API overview","loyalties","system integrator"],"diataxis":"explanation","href":"/guides/loyalty-v2-overview"},{"title":"Integrate loyalty v2","description":"Learn how to integrate with Voucherify's new loyalty v2 API","keywords":["loyalty integration","point wallets","examine earning rules","examine rewards","pay with points","voucherify v2"],"diataxis":"how-to","href":"/guides/loyalty-v2-integrate"},{"title":"Take loyalty v2 to production","description":"Move your Voucherify Loyalty v2 integration from Sandbox to Production, and solve most frequent issues","keywords":["loyalty integration","production","go-live","troubleshooting","voucherify v2"],"diataxis":"how-to","href":"/guides/loyalty-v2-take-to-production"}]},{"group":"Explore","public":true,"pages":[{"title":"Qualification - checking eligibility","keywords":["eligibility","upsell","qualification","scenario","bundle","customer wallet","product catalog"],"diataxis":"how-to","description":null,"href":"/guides/checking-eligibility"},{"title":"Locking validation session","description":"Temporarily lock the voucher's usage until redemption is successful.","keywords":["session","mechanism","transaction","lock","redemption","validation"],"diataxis":"how-to","href":"/guides/locking-validation-session"},{"title":"CSV export with API","keywords":["CSV","export","API"],"diataxis":"how-to","description":null,"href":"/guides/csv-export"},{"title":"Import legacy codes","keywords":["import","legacy","tool","program","CSV","JSON","API","dashboard"],"diataxis":"how-to","description":null,"href":"/guides/import-codes"}]},{"group":"Integrate","public":true,"pages":[{"group":"Workflows","public":true,"root":{"title":"Workflows overview","description":"Understand how Workflows send Loyalty v2 events to external applications, including when conditional logic chooses the path","keywords":["workflows","loyalty v2","webhook callout","if operator","conditional logic","loyalty transaction","loyalty activity","automation"],"diataxis":"explanation","href":"/integrations/workflows"},"pages":[{"title":"Build workflows","description":"Create, connect, publish, and activate a workflow for Loyalty v2 events, with optional conditional logic","keywords":["workflows","loyalty v2","webhook callout","if operator","conditional logic","loyalty transaction","loyalty activity","automation"],"diataxis":"how-to","href":"/integrations/build-workflows"},{"title":"Workflow options and limits","sidebarTitle":"Workflow options","description":"Review workflow triggers, conditional logic, webhook callouts, statuses, behavior, and limits","keywords":["workflows","loyalty v2","webhook callout","if operator","conditional logic","loyalty transaction","loyalty activity","limits"],"diataxis":"reference","href":"/integrations/workflow-options-limits"}]},{"title":"Distribution overview","description":"Learn how Voucherify distributions work and what triggers and channels are available","keywords":["distributions","guidebook","triggers"],"diataxis":"explanation","href":"/integrations/distributions-overview"},{"title":"Create distribution","description":"Create manual and automatic distributions to deliver messages, rewards, and vouchers to your customers","keywords":["distributions","customer messages","automatic distribution","manual distribution","customer engagement"],"diataxis":"how-to","href":"/integrations/create-distribution"},{"group":"Customer Engagement \u0026 Experience","public":true,"root":{"title":"Customer engagement platforms","description":"Integrate Voucherify with CEPs to deliver personalized incentives across channels","keywords":["integration","CEP","customer engagement","Braze","Klaviyo","MoEngage","Bloomreach","Iterable"],"diataxis":"explanation","href":"/integrations/customer-engagement-platforms"},"pages":[{"group":"Braze","public":true,"root":{"title":"Braze","description":"Connect Voucherify with Braze to deliver incentives, sync customer data, and trigger messages based on promotion events","keywords":["integration","braze","connected content","custom attributes","promotion codes","events"],"diataxis":"explanation","href":"/integrations/braze-overview"},"pages":[{"title":"Stream events to Braze","description":"Set up action-based delivery by tracking customer activity in Braze with Voucherify events","keywords":["integration","braze","events","inbound","tracking","notifications","trigger sendouts"],"diataxis":"how-to","href":"/integrations/stream-events-to-braze"},{"title":"Send data from Braze to Voucherify","description":"Synchronize Braze customer segments and send events with webhooks","keywords":["integration","braze","segments","webhooks","customers","sync","canvas","Braze outbound"],"diataxis":"how-to","href":"/integrations/send-data-from-braze"},{"group":"Braze Connected Content","public":true,"root":{"title":"Braze Connected Content overview","description":"Understand how Voucherify data works with Braze Connected Content","keywords":["integration","braze","connected content"],"diataxis":"explanation","href":"/integrations/braze-connected-content-overview"},"pages":[{"title":"Get started with Braze Connected Content","description":"Publish your first Voucherify coupon code in a Braze campaign","keywords":["integration","braze","connected content","quickstart"],"diataxis":"tutorial","href":"/integrations/braze-connected-content-quickstart"},{"title":"Optimize your Connected Content scripts","description":"Configure rate limiting, caching, and retry mechanisms for Braze Connected Content","keywords":["integration","braze","connected content","security"],"diataxis":"how-to","href":"/integrations/braze-connected-content-optimization"},{"title":"Connected Content script reference","description":"API endpoints, script templates, and parameter configurations for Braze Connected Content","keywords":["integration","braze","connected content","reference"],"diataxis":"reference","href":"/integrations/braze-connected-content-reference"}]},{"title":"Distribute to Braze custom attributes","description":"Learn how to use distributions to push incentives to Braze custom attributes","keywords":["integration","braze","custom","attribute"],"diataxis":"how-to","href":"/integrations/braze-custom-attributes"},{"title":"Export coupons to Braze","description":"Use Braze discount code snippet to share Voucherify coupons","keywords":["integration","braze","promotion","code"],"diataxis":"how-to","href":"/integrations/braze-promotion-codes"}]},{"title":"MoEngage","description":"Let customers know about promotions and distribute customized coupons","keywords":["integration","moengage"],"diataxis":"how-to","href":"/integrations/moengage"},{"title":"Klaviyo","description":"Share Voucherify codes through Klaviyo","keywords":["integration","klaviyo"],"diataxis":"how-to","href":"/integrations/klaviyo"},{"title":"Bloomreach Engagement","description":"Connect with Bloomreach CDP","keywords":["integration","bloomreach"],"diataxis":"how-to","href":"/integrations/bloomreach-engagement"},{"title":"Iterable","description":null,"keywords":["integration","iterable"],"diataxis":"how-to","href":"/integrations/iterable"},{"title":"CleverTap","description":"Transfer data from Voucherify to CleverTap and trigger messages and deliver codes to customers","keywords":["integration","clevertap"],"diataxis":"how-to","href":"/integrations/clevertap"},{"title":"Customer.io integration","sidebarTitle":"Customer.io","description":"Learn how to integrate Voucherify with Customer.io to deliver personalized, cross-channel journeys and dynamically distribute voucher codes.","diataxis":"how-to","href":"/integrations/customer-io"},{"title":"Infobip","description":"Engage customers with messages and Voucherify incentives","keywords":["integration","infobip"],"diataxis":"how-to","href":"/integrations/infobip"},{"title":"ActiveCampaign","keywords":["integration","active","campaign","messaging"],"diataxis":"how-to","description":null,"href":"/integrations/activecampaign"},{"title":"Airship","keywords":["integration","airship","messaging","crm"],"diataxis":"how-to","description":null,"href":"/integrations/airship"},{"title":"Autopilot","keywords":["integration","autopilot"],"diataxis":"how-to","description":null,"href":"/integrations/autopilot"},{"title":"Batch","description":"Integrate with Batch","keywords":["integration","batch"],"diataxis":"how-to","href":"/integrations/batch"},{"title":"Mailchimp","description":"Create Mailchimp automations with Voucherify promo codes","keywords":["integration","mailchimp"],"diataxis":"how-to","href":"/integrations/mailchimp"},{"title":"SendGrid","keywords":["integration","sendgrid"],"diataxis":"how-to","description":null,"href":"/integrations/sendgrid"},{"title":"Twilio","description":"Send personalized text messages with coupons straight from Voucherify dashboard","keywords":["integration","twilio"],"diataxis":"how-to","href":"/integrations/twilio"},{"title":"Salesforce Marketing Cloud","keywords":["integration","salesforce","marketing","cloud"],"diataxis":"how-to","description":null,"href":"/integrations/salesforce-marketing-cloud"},{"title":"Wyng","keywords":["integration","wyng"],"diataxis":"how-to","description":null,"href":"/integrations/wyng"}]},{"group":"CDP","public":true,"pages":[{"title":"Hightouch integration","sidebarTitle":"Hightouch","description":"Send customer and custom-event data from Hightouch to Voucherify, and confirm it landed on the right profiles.","keywords":["hightouch","integration","sync","data","customer data","custom event data","sync customer data","sync custom event data"],"tag":"NEW","diataxis":"how-to","href":"/integrations/hightouch"},{"title":"mParticle","keywords":["integration","mparticle"],"diataxis":"how-to","description":null,"href":"/integrations/mparticle"},{"title":"Segment","keywords":["integration","segment"],"diataxis":"how-to","description":null,"href":"/integrations/segment"}]},{"group":"Commerce Platforms","public":true,"pages":[{"title":"BigCommerce","keywords":["integration","bigcommerce"],"diataxis":"how-to","description":null,"href":"/integrations/bigcommerce"},{"title":"commercetools","keywords":["integration","commercetools","gift card connector"],"diataxis":"how-to","description":null,"href":"/integrations/commercetools"},{"title":"Shopify","keywords":["integration","shopify"],"diataxis":"how-to","description":null,"href":"/integrations/shopify"},{"title":"WooCommerce","keywords":["integration","woocommerce"],"diataxis":"how-to","description":null,"href":"/integrations/woocommerce"}]},{"group":"CRM","public":true,"pages":[{"title":"Salesforce","keywords":["integration","salesforce"],"diataxis":"how-to","description":null,"href":"/integrations/salesforce"},{"title":"ZOHO CRM","description":"Configure Voucherify and ZOHO CRM to publish codes to your customers","keywords":["integration","zoho"],"diataxis":"how-to","href":"/integrations/zoho-crm"},{"title":"Intercom","description":null,"keywords":["integration","intercom"],"diataxis":"how-to","href":"/integrations/intercom"}]},{"group":"CMS","public":true,"pages":[{"title":"Amplience","description":"Learn how to integrate Voucherify and Amplience ","keywords":["integration","amplience"],"diataxis":"how-to","href":"/integrations/amplience"},{"title":"Bloomreach CMS","description":"Connect with Bloomreach CMS","keywords":["integration","bloomreach","cms","customer management system"],"diataxis":"how-to","href":"/integrations/bloomreach-cms"},{"title":"Contentful","description":"Learn how to integrate Voucherify and Contentful","keywords":["integration","contentful"],"diataxis":"how-to","href":"/integrations/contentful"}]}]}]},{"tab":"User guides","groups":[{"group":"Discover","public":true,"pages":[{"title":"Voucherify user guide","description":"Learn how to prepare data, build campaigns, optimize incentives, orchestrate operations, analyze performance, and manage your account in the Voucherify dashboard","keywords":["Voucherify dashboard","user guide","campaigns","promotions","marketing"],"diataxis":"explanation","href":"/discover/voucherify-user-guide"},{"title":"Dashboard quickstart","description":"Learn dashboard basics, create your first campaign, and test it in the Demo Shop","keywords":["Voucherify dashboard","basics","create account","onboarding","sandbox"],"diataxis":"tutorial","href":"/discover/dashboard-quickstart"},{"title":"Vincent","description":"Automate incentive campaigns and cross-system analysis using natural language with Vincent, Voucherify's AI agent.","keywords":["Vincent","AI agent","incentive automation","natural language campaigns","agentic commerce"],"diataxis":"explanation","href":"/discover/vincent"}]},{"group":"Prepare","pages":[{"title":"Prepare overview","description":"Set up the foundational data that powers your incentive campaigns","keywords":["prepare","data","customers","products","orders","metadata","custom events","setup"],"diataxis":"explanation","href":"/prepare/prepare-overview"},{"group":"Customers","root":{"title":"Customer overview","description":"Understand how customers and segments help you run targeted incentives in Voucherify","keywords":["customers","segments","audience","targeting","overview"],"diataxis":"explanation","href":"/prepare/customer-overview"},"pages":[{"title":"Manage customers","description":"A comprehensive guide on creating, importing, and maintaining individual customer records in the Voucherify Dashboard","keywords":["customer","manage","profile","import customers","export customers"],"diataxis":"how-to","href":"/prepare/customers"},{"title":"Customer segments","description":"Learn how to organize customers into static, passive, or active segments","keywords":["customer segment","customer group","filter customers","dynamic segment","static segment","active segment","passive segment","distribution segment"],"diataxis":"how-to","href":"/prepare/customer-segments"}]},{"group":"Products","root":{"title":"Product overview","description":"Understand how products and collections help you build product-based incentives in Voucherify","keywords":["products","collections","catalog","validation","overview"],"diataxis":"explanation","href":"/prepare/product-overview"},"pages":[{"title":"Manage products","description":"A guide on how to create, import, and organize products and SKUs","keywords":["manage","product","catalog","import","export","bulk"],"diataxis":"how-to","href":"/prepare/products"},{"title":"Product collections","description":"Learn how to group products into static or dynamic collections","keywords":["product","collection","static","dynamic"],"diataxis":"how-to","href":"/prepare/product-collections"}]},{"title":"Orders","description":"Create and track customer purchase history","keywords":["customer cart","customer order","tracking orders","order status","export orders","add order"],"diataxis":"how-to","href":"/prepare/orders"},{"title":"Metadata","description":"Learn how to add custom attributes to your objects using metadata schema and how to manage them","keywords":["custom","attribute","metadata","manage","create","schema"],"diataxis":"how-to","href":"/prepare/metadata"},{"title":"Custom events","description":"Configure, track, and use custom events for segmentation, validation rules, distributions, and loyalty automation","keywords":["custom","events","automation","personalization","workflow"],"diataxis":"how-to","href":"/prepare/custom-events"},{"title":"Bin","description":"Manage resources moved to the bin and permanently delete them to free up unique identifiers","keywords":["bin","delete","soft delete","permanent deletion"],"diataxis":"how-to","href":"/prepare/bin"}]},{"group":"Build","public":true,"pages":[{"title":"Build campaign overview","description":"Understand how to prepare and configure campaigns in Voucherify","keywords":["campaigns","overview","build","type","incentive optimization"],"diataxis":"explanation","href":"/build/campaign-overview"},{"group":"Discount campaigns","public":true,"root":{"title":"Discount campaign overview","description":"Understand the core concepts and workflow of building discount programs in Voucherify","keywords":["discount overview","coupons","promotions","bulk codes","generic codes","how discounts work"],"diataxis":"explanation","href":"/build/discount-promotion-overview"},"pages":[{"title":"Create discount coupons","description":"Learn how to create generic or bulk discount coupons in the Campaign builder","keywords":["discount","coupons","generic code","personalized coupons","personalized codes","generic coupon"],"diataxis":"how-to","href":"/build/create-discount-coupons"},{"title":"Create cart promotions","description":"Configure a cart-level promotion campaign in Voucherify","keywords":["discount","promotions","create","cart promotion"],"diataxis":"how-to","href":"/build/create-discount-promotions"},{"title":"Discount types and effects","description":"Learn about various discount types and effects","keywords":["discount","type","effect","complete","guide"],"diataxis":"explanation","href":"/build/discount-types-and-effects"},{"title":"Discount code import","description":"Learn how to import codes to Voucherify","keywords":["discount","code","import","CSV","generic code import","coupon import"],"diataxis":"how-to","href":"/build/discount-code-import"},{"title":"Product bundles","description":"Overview of product bundles, BOGO mechanics, discount types, limits, and bundle behavior","keywords":["product bundles","BOGO","bundles","discounts","cart promotions"],"diataxis":"explanation","href":"/build/product-bundles"}]},{"group":"Gift card campaigns","public":true,"root":{"title":"Gift card campaign overview","description":"Understand the mechanics and configuration of gift card campaigns in Voucherify","keywords":["gift cards","campaigns","prepaid","balance","redemption"],"diataxis":"explanation","href":"/build/gift-card-overview"},"pages":[{"title":"Create gift cards","description":"Set up and manage gift card campaigns in Voucherify","keywords":["gift card","prepaid card","stored value","gift voucher","bulk codes","unique code","code pattern"],"diataxis":"how-to","href":"/build/create-gift-cards"},{"title":"Gift card import","description":"Learn how to import gift cards to Voucherify","keywords":["gift card","code","import","CSV","generic gift card import"],"diataxis":"how-to","href":"/build/gift-card-import"}]},{"group":"Loyalty programs","public":true,"root":{"title":"Loyalty program overview","description":"Understand the new loyalty program model and how its components work together.","keywords":["loyalty programs","loyalty hub","point wallets","earning rules","benefits","rewards","tiers"],"diataxis":"explanation","href":"/build/loyalty-overview"},"pages":[{"title":"Loyalty key concepts","description":"Standard terms and relationships used across Loyalty Hub documentation","keywords":["loyalty","loyalty hub","loyalty program","points","wallets","earning rules","tiers","rewards"],"diataxis":"explanation","href":"/build/loyalty-key-concepts"},{"title":"Tutorial – Create a basic loyalty program","description":"Learn how to create a loyalty program with a point wallet and an earning rule","keywords":["loyalty program","loyalty points","point wallet","earning rule","loyalty designer"],"diataxis":"tutorial","href":"/build/create-loyalty-program"},{"title":"Create point wallets","description":"Configure and manage point wallets","keywords":["point wallet","wallet builder","pending points","point expiration","pay with points","earning limits","spending limits"],"diataxis":"how-to","href":"/build/create-point-wallets"},{"title":"Create tier structures","description":"Set up rules that group customers based on their loyalty activity","keywords":["tier structures","loyalty tiers","tier levels","tier builder","tier configuration"],"diataxis":"how-to","href":"/build/create-tier-structures"},{"title":"Create earning rules","description":"Create and manage rules that control how loyalty points are awarded","keywords":["earning rules","earning rule builder","loyalty earning rules","points earning","loyalty rules","earning conditions"],"diataxis":"how-to","href":"/build/create-earning-rules"},{"title":"Create benefits","description":"Configure a reusable benefit for loyalty earning rules","keywords":["benefits","loyalty benefits","benefit builder","earning rule benefits"],"diataxis":"how-to","href":"/build/create-benefits"},{"title":"Create loyalty rewards","description":"Configure digital and material rewards for loyalty programs, define spendings, and manage rewards in the Loyalty hub","keywords":["rewards","loyalty rewards","reward builder","discount coupons","gift cards","material rewards","digital rewards","spendings","loyalty hub"],"diataxis":"how-to","href":"/build/create-loyalty-rewards"},{"group":"Legacy loyalty","public":true,"root":{"title":"Loyalty campaign overview","description":"Understand the core concepts and workflow of building loyalty programs in Voucherify","keywords":["loyalty overview","general info about loyalty","how does loyalty work","how loyalty works"],"tag":"Legacy","diataxis":"explanation","href":"/build/loyalty-campaign-overview"},"pages":[{"title":"Create loyalty campaign","description":"Learn how to create a loyalty campaign in the Campaign builder","keywords":["loyalty program","loyalty tiers","earn points","loyalty card","earning rule","pending points","distribution"],"tag":"Legacy","diataxis":"how-to","href":"/build/create-loyalty-campaign"},{"title":"Earning rules","description":"Learn about earning rules, their types, limits, and configuration parameters in Voucherify","keywords":["loyalty earning rules","gaining loyalty points","how to earn points","earning points"],"tag":"Legacy","diataxis":"reference","href":"/build/earning-rules"},{"title":"Loyalty points","description":"Comprehensive guide to loyalty points mechanics","keywords":["pending points","auto-redeem","automatic redemption","expiration rules","loyalty point expiration","loyalty point calculation","add loyalty points","remove loyalty points"],"tag":"Legacy","diataxis":"explanation","href":"/build/loyalty-points"},{"title":"Loyalty tiers","description":"Learn how loyalty tiers work in Voucherify","tag":"Legacy","diataxis":"explanation","href":"/build/loyalty-tiers"},{"title":"Loyalty card import","description":"Learn how to import loyalty cards to Voucherify","keywords":["loyalty card","import","CSV","loyalty points"],"tag":"Legacy","diataxis":"how-to","href":"/build/loyalty-card-import"}]}]},{"group":"Referral programs","public":true,"root":{"title":"Referral program overview","description":"Understand the core concepts and workflow of building referral programs in Voucherify","keywords":["referral program","referrer","referee","referral code","conversion event","double-sided referral","single-sided referral","referral tier","referee reward","referrer reward","referral workflow","custom event","loyalty hub"],"diataxis":"explanation","tag":"UPDATED","href":"/build/referral-campaign-overview"},"pages":[{"title":"Create referral campaign","description":"Learn how to create a referral campaign in the Campaign builder","keywords":["referral program","referral tiers","referral code","conversion event","referrer reward","referee reward","loyalty hub"],"diataxis":"how-to","tag":"UPDATED","href":"/build/create-referral-campaign"},{"title":"Referral code import","description":"Learn how to import referral codes to Voucherify","keywords":["referral code","import","CSV","referral campaign"],"diataxis":"how-to","href":"/build/referral-code-import"}]},{"title":"Campaign templates","description":"A conceptual overview of campaign templates in Voucherify","keywords":["campaign templates","promotion tier templates","discount coupon templates","gift voucher templates","campaign configuration","template creation","project migration","validation rules","metadata schema","custom events","resource cloning","campaign builder"],"diataxis":"explanation","href":"/build/campaign-templates"}]},{"group":"Optimize","public":true,"pages":[{"title":"Optimize overview","description":"Move from static discounts to always-on experimentation that drives revenue, repurchase, and smarter growth","keywords":["optimize","validation rules","rewards","time limits","redemptions","targeting","experimentation"],"diataxis":"explanation","href":"/optimize/optimize-overview"},{"title":"Validations and redemptions","description":"Track code validation, validation sessions, and successful redemptions in Voucherify","keywords":["validations","redemptions","session","tracking"],"diataxis":"explanation","href":"/optimize/validations-and-redemptions"},{"group":"Validation rules","public":true,"pages":[{"title":"Create validation rules","description":"A step-by-step guide to building validation rules that limit redemptions, control loyalty earning, or trigger distributions","keywords":["create","validation","rule","manager"],"diataxis":"how-to","href":"/optimize/create-validation-rules"},{"title":"Validation rule reference","description":"Learn about rules, limits, and budget constraints available in the Voucherify validation rule builder","keywords":["validation","rules","reference"],"diataxis":"reference","href":"/optimize/validation-rules-reference"}]},{"title":"Time limits","description":"Learn about time-related campaign limits, validity timeframes, and recurring schedules in Voucherify","keywords":["timeframe","limit","validity","schedule"],"diataxis":"explanation","href":"/optimize/time-limits"},{"group":"Dynamic formulas","public":true,"pages":[{"title":"Create dynamic formulas","description":"How to create dynamic discount and loyalty point formulas","keywords":["dynamic","formula","builder","discount","points"],"diataxis":"how-to","href":"/optimize/create-dynamic-formulas"},{"title":"Dynamic formula reference","description":"Reference for dynamic discount and loyalty point formulas using operands and operators","keywords":["dynamic","formula","builder","discount","points"],"diataxis":"reference","href":"/optimize/dynamic-formula-reference"}]},{"title":"Create rewards","description":"Learn how to create and manage rewards for loyalty and referral campaigns","keywords":["rewards","loyalty rewards","referral rewards","discount coupon","gift card credits","loyalty points","material reward","pay with points","loyalty hub"],"diataxis":"how-to","tag":"UPDATED","href":"/optimize/create-rewards"},{"title":"Fraud prevention best practices","description":"Learn how to prevent promotion fraud, protect your campaigns, and monitor suspicious activity using Voucherify features and external tools","keywords":["fraud prevention","promotion fraud","coupon abuse","campaign security","voucher fraud"],"diataxis":"explanation","href":"/optimize/fraud-prevention-best-practices"}]},{"group":"Orchestrate","public":true,"pages":[{"title":"Orchestrate overview","description":"Manage campaigns after launch with code publication, stacking rules, areas and stores, and geofencing","keywords":["orchestrate","code publication","campaign maintenance","stacking rules","categories","areas and stores","geofencing"],"diataxis":"explanation","href":"/orchestrate/orchestrate-overview"},{"title":"Code publication","description":"Learn how codes are assigned to customers in Voucherify and how publications improve control and tracking","keywords":["assign code to a customer","assign voucher to a customer","code assignment","publish code"],"diataxis":"how-to","href":"/orchestrate/code-publication"},{"title":"Campaign maintenance","keywords":["campaigns","maintenance","manage","track"],"description":"Manage, edit, and maintain campaigns after launch","diataxis":"how-to","href":"/orchestrate/campaign-maintenance"},{"title":"Voucher maintenance","description":"Find, update, disable, and delete vouchers in Voucherify","keywords":["voucher maintenance","voucher search","campaign search","delete voucher","clone campaign","filter vouchers"],"diataxis":"how-to","href":"/orchestrate/voucher-maintenance"},{"title":"Promotion tier maintenance","description":"Manage, reuse, activate, and transfer promotion tiers","keywords":["promotion tier","promotion tiers","maintenance","transfer","template"],"diataxis":"how-to","href":"/orchestrate/promotion-tier-maintenance"},{"group":"Stacking rules and categories","public":true,"root":{"title":"Stacking rules and categories overview","description":"Control how multiple incentives interact in a single redemption with stacking rules and categories","keywords":["stacking rules","categories","incentive stacking","discount stacking","overview","orchestrate"],"diataxis":"explanation","href":"/orchestrate/stacking-rules-overview"},"pages":[{"title":"Manage categories","description":"Learn how to create and manage categories","keywords":["categories","stacking rules","campaign categories","category hierarchy","compatibility matrix"],"diataxis":"how-to","href":"/orchestrate/manage-categories"},{"title":"Stacking rules","description":"Control how multiple incentives behave in a single request","keywords":["stacking rules","discount stacking","application order","validation policy","discount calculation","stack limits"],"diataxis":"how-to","href":"/orchestrate/stacking-rules"},{"title":"Using stacking rules and categories","description":"Business scenarios that show what you can configure with stacking rules and categories","keywords":["stacking rules","categories","incentive stacking","never stackable","always stackable","discount order","stacking rule use cases","stacking rule business scenarios"],"diataxis":"how-to","href":"/orchestrate/using-stacking-rules-and-categories"}]},{"group":"Areas and stores","public":true,"pages":[{"title":"Areas and stores","description":"Understand the basic principles, roles, and resource visibility in Areas and Stores","keywords":["areas and stores","campaign visibility","role permissions","campaign assignment"],"diataxis":"explanation","href":"/orchestrate/areas-and-stores"},{"title":"Manage areas and stores","description":"Configure areas, stores, restricted users, and API keys to manage your regional promotional structure","keywords":["areas","stores","restricted user","manage"],"diataxis":"how-to","href":"/orchestrate/manage-areas-and-stores"},{"title":"Areas and stores access scenario","description":"See how area and store assignments affect campaign visibility and management for restricted users","keywords":["areas and stores example","restricted user visibility","campaign assignment overlap","area vs store access","areas and stores use case","areas and stores scenario"],"diataxis":"tutorial","href":"/orchestrate/areas-and-stores-scenario"}]},{"title":"Geofencing","description":"Create location-based campaigns by checking customer, product, or SKU coordinates against locations you define","keywords":["geofencing","location","enterprise"],"diataxis":"how-to","href":"/orchestrate/geofencing"}]},{"group":"Analyze","public":true,"pages":[{"title":"Analyze overview","description":"Track campaign performance, voucher activity, redemption analytics, and project audit logs","keywords":["analyze","campaign tracking","voucher tracking","reporting","analytics","audit logs"],"diataxis":"explanation","href":"/analyze/analyze-overview"},{"title":"Campaign tracking","description":"Track campaign performance, customer activity, and incentive usage across Voucherify campaigns","keywords":["campaign tracking","analytics","loyalty tracking","referral tracking","campaign calendar"],"diataxis":"how-to","href":"/analyze/campaign-tracking"},{"title":"Voucher tracking","description":"Track voucher activity and transactions for gift and loyalty cards","keywords":["voucher tracking","gift card transactions","loyalty card transactions","voucher export"],"diataxis":"how-to","href":"/analyze/voucher-tracking"},{"title":"Performance analytics","description":"Learn what analytics data Voucherify displays in the Dashboard, Team Settings, Project Settings, and Loyalty hub","keywords":["reporting","analytics","dashboard","api usage","team settings","project settings","redemptions","campaign performance","loyalty hub","loyalty export"],"diataxis":"explanation","href":"/analyze/performance-analytics"},{"title":"Audit log","description":"Learn what audit log is, what data it includes, and how to use it in Voucherify","keywords":["audit logs","logs","monitoring","troubleshooting","debugging","API log","webhook logs"],"diataxis":"explanation","href":"/analyze/audit-logs"}]},{"group":"Manage","public":true,"pages":[{"title":"Manage Voucherify overview","description":"Configure your Voucherify account, projects, team, and organization security from one place","keywords":["manage","overview","account","team settings","project settings","security","members","roles"],"diataxis":"explanation","href":"/manage/manage-voucherify-overview"},{"title":"Voucherify account","description":"Learn how to manage your Voucherify account, subscription, buy extra API packages, request consultation services, and handle subscription cancellation","keywords":["subscription","billing","API packages","consultation","account management","cancellation"],"diataxis":"how-to","href":"/manage/voucherify-account"},{"title":"Team settings","description":"Learn what you can configure in Team settings as an account owner","keywords":["team","settings","account","owner","configuration"],"diataxis":"how-to","href":"/manage/team-settings"},{"title":"Project settings","description":"Learn what you can find and configure in Voucherify project settings","keywords":["project","settings","configure"],"diataxis":"reference","href":"/manage/project-settings"},{"group":"Organization security","public":true,"root":{"title":"Organization security overview","description":"Protect your Voucherify account with authentication, role-based access, approval workflows, and data protection controls","keywords":["security","overview","account security","roles","approval requests","GDPR","data protection"],"diataxis":"explanation","href":"/manage/security-overview"},"pages":[{"title":"Account security","description":"Learn how to protect your Voucherify account using authentication options, access controls, and monitoring tools","keywords":["account","security","SAML","2FA"],"diataxis":"how-to","href":"/manage/account-security"},{"title":"Members and roles","description":"Learn how to invite members and control access with roles in Voucherify","keywords":["manage","member","roles","owner","admin"],"diataxis":"how-to","href":"/manage/members-and-roles"},{"title":"Approval requests","description":"Create and manage approval workflows to protect campaigns from errors and unauthorized changes","keywords":["approval","requests","operations"],"diataxis":"how-to","href":"/manage/approval-requests"},{"title":"Security and data protection","description":"Data privacy regulations and instructions on how to execute data protection procedures","keywords":["GDPR","CCPA","security","protection","data protection","dpo","data protection officer","security and data protection policy"],"diataxis":"how-to","href":"/manage/security-and-data-protection"},{"title":"Transactional data retention","description":"Default retention periods for redemptions, validations, order details, and voucher transactions","keywords":["data retention","redemptions","validations","orders","voucher transactions","rollback"],"diataxis":"reference","href":"/manage/transactional-data-retention"}]}]}]},{"tab":"API reference","groups":[{"group":"Introduction","public":true,"pages":[{"title":"Introduction","description":"What is Voucherify API?","keywords":["JSON","API","application","introduction","Management API","Client API","Application API"],"diataxis":"explanation","href":"/api-reference/introduction-api"},{"title":"Errors","description":"Learn about the errors returned to responses and how you can customize them to improve your customer experience","keywords":["HTTP","error","customize","message"],"diataxis":"reference","href":"/api-reference/errors"},{"title":"API versioning","description":"What is the latest API version?","keywords":["API","version","change","current","upgrade"],"diataxis":"reference","href":"/api-reference/versioning"},{"title":"Fetching Data","description":"Learn how to specify the data you would like to fetch","keywords":["resource","listing","data","response"],"diataxis":"reference","href":"/api-reference/listing"},{"title":"Object Schemas","description":"Schema model definitions","keywords":["model","definition","object","schema"],"diataxis":"reference","href":"/api-reference/object-schemas"}]},{"group":"Endpoints","public":true,"pages":[{"group":"Publications","public":true,"pages":[{"title":"Publication Object","mode":"frame","description":null,"href":"/api-reference/publications/publication-object"},{"title":"List Publications","description":"Retrieve a list of publications. To return a **particular** publication, you can use the `source_id` query parameter and provide the `source_id` of the publication you are looking for specifically.\n\n## Pagination\n\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Important!\u003c/Badge>\n\nIf you want to scroll through a huge set of records, it is recommended to use the [Exports API](/api-reference/exports/create-export). This API will return an error `page_over_limit` if you reach a page above 1000.\n\n\u003c/Warning>\n\n## Filter Query\n\nThe `filters` query parameter allows for joining multiple parameters with logical operators. The syntax looks as follows:\n\n\n```\n \"$in\"\n \"$not_in\"\n \"$is\"\n \"$is_not\"\n \"$has_value\"\n \"$is_unknown\"\n \"$contains\"\n \"$starts_with\"\n \"$ends_with\"\n \"$more_than\"\n \"$less_than\"\n \"$more_than_equal\"\n \"$less_than_equal\"\n```\n\n### Examples\n\n\n```url\nGET /v1/publications?filters[customer_id][conditions][$is][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL\n```\n\n```url\nGET /v1/publications?filters[customer_id][conditions][$in][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL\u0026filters[customer_id][conditions][$in][1]=cust_aR7NfHusxT7PdTMAKMfWDXnc\n```\n\n```url\nGET /v1/publications?filters[customer_id][conditions][$is][0]=cust_lUET6gRpO5Wxlg5p2j2gRCgL\u0026filters[customer_id][conditions][$is][1]=cust_aR7NfHusxT7PdTMAKMfWDXnc\u0026filters[junction]=OR\n```","deprecated":null,"version":null,"openapi":"/openapi/publications.json get /v1/publications","href":"/api-reference/publications/list-publications","autogeneratedByOpenApi":true},{"title":"Create Publication","description":"This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication.\n\nA voucher is suitable for publication when it's active and hasn't been published yet. \n\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Clearly define the source of the voucher\u003c/Badge>\n\nYou must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.\n\n\u003c/Warning>\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Publish multiple vouchers\u003c/Badge>\n\nIn case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish.\n\n\u003c/Warning>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Auto-update campaign\u003c/Badge>\n\nIn case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/publications.json post /v1/publications","href":"/api-reference/publications/create-publication","autogeneratedByOpenApi":true},{"title":"Create Publication with GET","description":"This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication.\n\nA voucher is suitable for publication when it's active and hasn't been published yet.\n\u003cDanger>\n\n\u003cBadge color=\"red\">Limited access\u003c/Badge>\n\nAccess to this endpoint is limited. This endpoint is designed for specific integrations and the API keys need to be configured to access this endpoint. Navigate to the **Dashboard** \u0026rarr; **Project Settings** \u0026rarr; **General** \u0026rarr; **Integration Keys** to set up a pair of API keys and use them to send the request.\n\n\u003c/Danger>\n\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Clearly define the source of the voucher\u003c/Badge>\n\nYou must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.\n\n\u003c/Warning>\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Publish multiple vouchers\u003c/Badge>\n\nThis endpoint does not support the publishing of multiple vouchers from a single campaign. In case you want to publish multiple vouchers within a single publication, you need to use a [dedicated endpoint](/api-reference/publications/create-publication).\n\n\u003c/Warning>\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Auto-update campaign\u003c/Badge>\n\nIn case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.\n\n\u003c/Note>\n\n## Example Request \n```markdown Publication Query \n/publications/create?campaign[name]=BlackFriday\u0026customer[source_id]=Customer_Source_ID \n``` \n\n\n\u003cDanger>\n\n\u003cBadge color=\"red\">Required\u003c/Badge>\n\nQuery param `voucher` OR `campaign` MUST be filled out. If you provide both, `campaign` param will be skipped.\n\n\u003c/Danger>","deprecated":null,"version":null,"openapi":"/openapi/publications.json get /v1/publications/create","href":"/api-reference/publications/create-publication-with-get","autogeneratedByOpenApi":true}]},{"group":"Qualifications","public":true,"pages":[{"title":"Qualification Object","mode":"frame","description":null,"href":"/api-reference/qualifications/qualification-object"},{"title":"Check Eligibility","description":"\n\u003cWarning>\n\nThe Qualifications endpoint ignores the rules checking:\n\n- Limit of total redeemed discount amount per campaign\n- Limit of total redemptions count per campaign\n- Redemptions per customer\n- Redemptions per customer in a campaign\n- Total amount before discount\n\n\u003c/Warning>\n\nGenerate a list of redeemables that are applicable in the context of the customer and order.\n\nThe new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements:\n\n- Qualification results are returned faster\n- No limit on the number of returned redeemables\n- Introduces new qualification scenarios, not available in the previous version\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Scenario Guide\u003c/Badge>\n\nRead [the dedicated guide](/guides/checking-eligibility) to learn about some use cases this endpoint can cover.\n\n\u003c/Tip>\n\n## Paging \n\nThe Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the `starting_after` cursor.\n\nTo process of paging the redeemables works in the following manner:\n\n- You send the first API request for Qualifications without the `starting_after` parameter.\n- The response will contain a parameter named `has_more`. If the parameter's value is set to `true`, then more redeemables are available.\n- Get the value of the `created_at` parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables.\n- Send another API request for Qualification with the `starting_after` parameter set to the value taken from the `created_at` parameter from the last returned redeemable.\n- Voucherify will return the next page of redeemables.\n- If the `has_more` parameter is set to `true`, apply steps 3-5 to get the next page of redeemables.\n\n## Caching\n\nQualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.","deprecated":null,"version":null,"openapi":"/openapi/qualifications.json post /v1/qualifications","href":"/api-reference/qualifications/check-eligibility","autogeneratedByOpenApi":true}]},{"group":"Validations","public":true,"pages":[{"title":"Validation Object","mode":"frame","description":null,"href":"/api-reference/validations/validation-object"},{"title":"Validate Stackable Discounts","description":"Verify redeemables provided in the request. This method is designed for server side integration which means that it is accessible only through private keys.\n\nAPI keys with a Merchant role can't use this endpoint.","deprecated":null,"version":null,"openapi":"/openapi/validations.json post /v1/validations","href":"/api-reference/validations/validate-stackable-discounts","autogeneratedByOpenApi":true},{"title":"Validate Voucher","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for voucher validation, and we do not recommend using it. The new [Stackable Discounts API](/api-reference/validations/validate-stackable-discounts) introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nTo verify a voucher code given by a customer, you can use this method. It is designed for a server side integration, which means that is accessible only through private keys. \n\n\n\u003cDanger>\n\n\u003cBadge color=\"red\">Important\u003c/Badge>\n\nThis endpoint supports the validation of a single promo code. If you need to validate more than one incentive, you can use the [Stackable discounts API](/api-reference/validations/validate-stackable-discounts). The stacking discounts API lets you validate up to 30 incentives per call. Before integrating Voucherify, choose which validation endpoint you prefer to use.\n\n\u003c/Danger>\n\n#### Gift Vouchers - validate Gift Card and control amount to redeem\nVoucherify also gives the possibility to create a gift card, which allows using credits to fulfill the order. A user can specify how many credits he wants to use from the gift card. The available balance of credits is counted based on policy rules attached to the Gift Voucher definition. \n\nThis operation returns information about the validity of the code. Moreover, it returns a hashed source identifier which can be used as a tracking ID in future calls.\n\nIf a validation session is established, then the session details will be returned as well. Read more about sessions [here](/guides/locking-validation-session).\n\nVoucher validation might fail because of one of these reasons:\n* `voucher not found` - voucher doesn't exist or was [deleted](/api-reference/vouchers/delete-voucher)\n* `voucher expired` - voucher is out of start date - expiration date time frame\n* `voucher is disabled` - learn more about a [disabled voucher](/api-reference/vouchers/disable-voucher)\n* `customer does not match segment rules` - learn more [customer tracking](/api-reference/customers/customer-object) \n* `order does not match validation rules` - learn more about [validation rules](/api-reference/validation-rules/validation-rule-object)","deprecated":true,"version":null,"openapi":"/openapi/validations.json post /v1/vouchers/{code}/validate","href":"/api-reference/validations/validate-voucher","autogeneratedByOpenApi":true},{"title":"Validate Promotions","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for qualification, and we do not recommend using it. The new [Qualifications API](/api-reference/qualifications/check-eligibility) introduces additional features and improvements while maintaining backward compatibility. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\n \n\u003cDanger>\n\n\u003cBadge color=\"red\">Limitation\u003c/Badge>\n\nOnly the first 150 most recent promotion tiers are checked for eligibility. Older promotion tiers are ignored and not returned.\n\n\u003c/Danger>\n\n Use this method to get valid promotions for a given customer and order.\n\n### Advanced validation filters\n\nYou can narrow down a validation to a specific promotion ID or tier metadata.","deprecated":true,"version":null,"openapi":"/openapi/validations.json post /v1/promotions/validation","href":"/api-reference/validations/validate-promotions","autogeneratedByOpenApi":true},{"title":"Validate Promotion Tier","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for promotion tier redemption, and we do not recommend using it. The new [Stackable Discounts API](/api-reference/validations/validate-stackable-discounts) introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nTo verify whether the promotion tier discount can be applied to an order. This method is designed for server side integration which means that it is accessible only through private keys.","deprecated":true,"version":null,"openapi":"/openapi/validations.json post /v1/promotions/tiers/{tierId}/validation","href":"/api-reference/validations/validate-promotion-tier","autogeneratedByOpenApi":true}]},{"group":"Redemptions","public":true,"pages":[{"title":"Redemption Object","mode":"frame","description":null,"href":"/api-reference/redemptions/redemption-object"},{"title":"Redemption Rollback Object","mode":"frame","description":null,"href":"/api-reference/redemptions/redemption-rollback-object"},{"title":"Stackable Redemptions Object","mode":"frame","description":null,"href":"/api-reference/redemptions/stackable-redemptions-object"},{"title":"Redeem Stackable Discounts","description":"In the table below, you can see the logic the API follows to calculate discounts and amounts:\n\n| **Field** | **Calculation** | **Description** |\n|:---|:---|:---|\n| amount | N/A | This field shows the order amount before applying any discount |\n| total_amount | `total_amount` = `amount` - `total_discount_amount` | This field shows the order amount after applying all the discounts |\n| discount_amount | `discount_amount` = `previous_discount_amount` + `applied_discount_amount` | This field sums up all order-level discounts up to and including the specific discount being calculated for the stacked redemption. |\n| items_discount_amount | sum(items, i => i.discount_amount) | This field sums up all product-specific discounts |\n| total_discount_amount | `total_discount_amount` = `discount_amount` + `items_discount_amount` | This field sums up all order-level and all product-specific discounts |\n| applied_discount_amount | N/A | This field shows the order-level discount applied in a particular request |\n| items_applied_discount_amount | sum(items, i => i.applied_discount_amount) | This field sums up all product-specific discounts applied in a particular request |\n| total_applied_discount_amount | `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | This field sums up all order-level and all product-specific discounts applied in a particular request |\n\n\n\nAPI keys with a Merchant role can't use this endpoint.\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Rollbacks\u003c/Badge>\n\nYou can't roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).\n\n\u003c/Note>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Also available on client-side\u003c/Badge>\n\nThis method is also accessible through public keys which you can use in client-side apps: mobile and web browser apps. Go to the dedicated [endpoint](/api-reference/client-side/redeem-stackable-discounts-client-side) to learn more.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/redemptions.json post /v1/redemptions","href":"/api-reference/redemptions/redeem-stackable-discounts","autogeneratedByOpenApi":true},{"title":"List Redemptions","description":"Returns a list of redemptions previously created. The redemptions are returned in a sorted order, with the most recent redemptions appearing first. The response returns a list of redemptions of all vouchers. \n\n## Filtering results\nThe result can be narrowed according to specified (or default) filters, for example, you can sort redemptions by date:\n`https://api.voucherify.io/v1/redemptions?limit=3\u0026[created_at][before]=2017-09-08T13:52:18.227Z`.\nA filter based on the object `created_at` field narrows down the results and lists redemptions done before or after a particular date time. You can use the following options: `[created_at][after]`, `[created_at][before]`.\nA date value must be presented in ISO 8601 format (`2016-11-16T14:14:31Z` or `2016-11-16`). An example: `[created_at][before]=2017-09-08T13:52:18.227Z`.\n\n## Failed Redemptions\n\nA redemption may fail for various reasons. You can figure out an exact reason from the `failure_code`:\n- `resource_not_found` - voucher with given code does not exist\n- `voucher_not_active` - voucher is not active yet (before start date)\n- `voucher_expired` - voucher has already expired (after expiration date)\n- `voucher_disabled` - voucher has been disabled (`active: false`)\n- `quantity_exceeded` - voucher's redemptions limit has been exceeded\n- `gift_amount_exceeded` - gift amount has been exceeded\n- `customer_rules_violated` - customer did not match the segment\n- `order_rules_violated` - order did not match validation rules\n- `invalid_order` - order was specified incorrectly\n- `invalid_amount` - order amount was specified incorrectly\n- `missing_amount` - order amount was not specified\n- `missing_order_items` - order items were not specified\n- `missing_customer` - customer was not specified","deprecated":null,"version":null,"openapi":"/openapi/redemptions.json get /v1/redemptions","href":"/api-reference/redemptions/list-redemptions","autogeneratedByOpenApi":true},{"title":"Get Redemption","description":"Return a redemption or redemption rollback object. This object can either be a successfull or failed redemption or redemption rollback.","deprecated":null,"version":null,"openapi":"/openapi/redemptions.json get /v1/redemptions/{redemptionId}","href":"/api-reference/redemptions/get-redemption","autogeneratedByOpenApi":true},{"title":"Get Voucher's Redemptions","description":"Retrieve the number of times a voucher was redeemed and each of the redemption details.","deprecated":null,"version":null,"openapi":"/openapi/redemptions.json get /v1/vouchers/{code}/redemption","href":"/api-reference/redemptions/get-vouchers-redemptions","autogeneratedByOpenApi":true},{"title":"Rollback Redemption","description":"Your business logic may include a case when you need to undo a redemption. You can revert a redemption by calling this API endpoint. This endpoint rolls back only single redemptions, meaning those that are not stacked. Stacked redemptions belong to a parent redemption. To roll back a parent redemption, including all of its individual redemptions, use the [POST Rollback Stackable Redemptions](/api-reference/redemptions/rollback-stackable-redemptions) \n\u003cWarning>\n\nYou can roll back a redemption up to 3 months back.\n\n\u003c/Warning>\n\n ## Effect \nThe operation \n- creates a rollback entry in voucher's redemption history (`redemption.redemption_entries`) and \n- gives 1 redemption back to the pool (decreases `redeemed_quantity` by 1). \n## Returned funds \nIn case of *gift card vouchers*, this method returns funds back according to the source redemption. In case of *loyalty card vouchers*, this method returns points back according to the source redemption.","deprecated":null,"version":null,"openapi":"/openapi/redemptions.json post /v1/redemptions/{redemptionId}/rollback","href":"/api-reference/redemptions/rollback-redemption","autogeneratedByOpenApi":true},{"title":"Rollback Stackable Redemptions","description":"Rollback a stackable redemption. When you roll back a stacked redemption, all child redemptions will be rolled back. Provide the parent redemption ID as the path parameter. However, you can use this endpoint to roll back a single redemption that does not have a parent, similarly to [POST Rollback redemption](/api-reference/redemptions/rollback-redemption).\n\u003cWarning>\n\nYou can roll back a redemption up to 3 months back.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/redemptions.json post /v1/redemptions/{parentRedemptionId}/rollbacks","href":"/api-reference/redemptions/rollback-stackable-redemptions","autogeneratedByOpenApi":true},{"title":"Redeem Voucher","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for voucher redemption, and we do not recommend using it. The new [Stackable Discounts API](/api-reference/redemptions/redeem-stackable-discounts) introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nTo redeem a voucher, you create a redemption object. It increments the redemption counter and updates the history of the voucher. \n\n## How discounts and order amounts are calculated in the API response?\n\nIn the table below, you can see the logic the API follows to calculate discounts and amounts:\n\n| **Field** | **Calculation** | **Description** |\n|:---|:---|:---|\n| amount | N/A | This field shows the order amount before applying any discount |\n| total_amount | total_amount = amount - total_discount_amount | This field shows the order amount after applying all the discounts |\n| discount_amount | discount_amount = previous_discount_amount + applied_discount_amount | This field sums up all order-level discounts applied to a patricular order |\n| items_discount_amount | sum(items, i => i.discount_amount) | This field sums up all product-specific discounts applied to this order |\n| total_discount_amount | total_discount_amount = discount_amount + items_discount_amount | This field sums up all order-level and all product-specific discounts applied to this order |\n| applied_discount_amount | N/A | This field shows order-level discount applied in a particular request |\n| items_applied_discount_amount | sum(items, i => i.applied_discount_amount) | This field sums up all product-specific discounts applied in a particular request |\n| total_applied_discount_amount | total_applied_discount_amount = applied_discount_amount + items_applied_discount_amount | This field sums up all order-level and all product-specific discounts applied in a particular request |","deprecated":true,"version":null,"openapi":"/openapi/redemptions.json post /v1/vouchers/{code}/redemption","href":"/api-reference/redemptions/redeem-voucher","autogeneratedByOpenApi":true},{"title":"Redeem Promotion","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for promotion tier redemption, and we do not recommend using it. The new [Stackable Discounts API](/api-reference/redemptions/redeem-stackable-discounts) introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nTo redeem a promotion, you create a redemption object passing a context.\n\nYou can retrieve a list of active promotions through the [Validate Promotions](/api-reference/validations/validate-promotion-tier) endpoint. That validation method will return a list of active promotion tiers identified by thier IDs. \n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Redemption rollback\u003c/Badge>\n\nDo you need to undo a redemption? You can do it with [redemption rollback](/api-reference/redemptions/rollback-redemption).\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/redemptions.json post /v1/promotions/tiers/{promotionTierId}/redemption","href":"/api-reference/redemptions/redeem-promotion","autogeneratedByOpenApi":true}]},{"group":"Vouchers","public":true,"pages":[{"title":"Voucher Object","mode":"frame","description":null,"href":"/api-reference/vouchers/voucher-object"},{"title":"List Vouchers","description":"Returns a list of vouchers. By default, the vouchers are returned sorted by creation date, with the most recent vouchers appearing first. A maximum of 100 vouchers are returned in the response.\n\nWhen you get a list of vouchers, you can optionally specify query parameters to customize the number of vouchers returned per call using `limit`, which page of vouchers to return using `page`, sort the vouchers using the `order` query parameter and more.\n\nThis method will return an error when trying to return a limit of more than 100 vouchers.\n","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json get /v1/vouchers","href":"/api-reference/vouchers/list-vouchers","autogeneratedByOpenApi":true},{"title":"Get Voucher","description":"Retrieves the voucher with the given `code` or unique Voucherify ID. You can either pass the voucher ID which was assigned by Voucherify, e.g., `v_7HxHkf4VAkMuc8u4lZs78lyRwhRze5UE`, or the `code` of the voucher as the path parameter value, e.g., `7fjWdr`.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json get /v1/vouchers/{code}","href":"/api-reference/vouchers/get-voucher","autogeneratedByOpenApi":true},{"title":"Create Voucher","description":"Create a generic (standalone) voucher or a voucher in a campaign. You can choose to create a `GIFT_VOUCHER`, a `DISCOUNT_VOUCHER`, or a legacy `LOYALTY_CARD`. The code path parameter can use all letters of the English alphabet, Arabic numerals and special characters.\n\nWhen you create a new voucher, you can specify a type to create it.\nIf no `campaign` name or `campaign_id` is provided, the new voucher will be a generic (standalone) one. However, if an ID or name of a campaign with the `type` set to `STANDALONE` is provided, the voucher will be added to this campaign. For a loyalty card, a campaign name or ID is required.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Standalone Vouchers and Campaigns\u003c/Badge>\n\nGeneric (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers created through The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for `campaign` and `campaign_id` are `null`.\n\nTo create a generic (standalone) voucher with a `\"type\": \"STANDALONE\"`, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/{code}","href":"/api-reference/vouchers/create-voucher","autogeneratedByOpenApi":true},{"title":"Generate Random Code","description":"Create a generic (standalone) vouchers. You can choose to create a `GIFT_VOUCHER`, a `DISCOUNT_VOUCHER`, or a legacy `LOYALTY_CARD`. \n\nWhen you create a new voucher, you can specify a type to create it.\nCreating a new voucher will create a new generic (standalone) vouchers if no `campaign` name or `campaign_id` is provided. However, if an ID or name of a campaign with the `type` set to `STANDALONE` is provided, the voucher will be added to such campaign. In case of the loyalty card, a campaign name is required.\n\nYou can optionally use the `code` parameter to define a specific code or the `code_config` parameter to design rules for Voucherify API to create a random code. If neither of the two parameters are passed, then a random code is generated by the Voucherify API.\n\nThis method will return an error when trying to create a voucher that already exists.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Standalone Vouchers and Campaigns\u003c/Badge>\n\nGeneric (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. The vouchers created with POST Create voucher and POST Generate random code endpoints do not have a campaign attached, so the values for `campaign` and `campaign_id` are `null`.\n\nTo create a generic (standalone) voucher with a `\"type\": \"STANDALONE\"`, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers","href":"/api-reference/vouchers/generate-random-code","autogeneratedByOpenApi":true},{"title":"Update Voucher","description":"Updates the specified voucher by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.\n\nFields other than the ones listed in the request body won't be modified. Even if provided, they will be silently skipped.\n\nIf you want to change the amount on a gift card or the number of points on a loyalty card (**legacy loyalty**), use the [Adjust voucher balance](/api-reference/vouchers/adjust-voucher-balance) endpoint.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json put /v1/vouchers/{code}","href":"/api-reference/vouchers/update-voucher","autogeneratedByOpenApi":true},{"title":"Delete Voucher","description":"Deletes a voucher. This operation cannot be undone. Additionally, this operation removes any redemptions on the voucher.\n\nIf the `force` parameter is set to `false` or not set at all, the voucher will be moved to [the bin](/api-reference/bin/list-bin-entries).","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json delete /v1/vouchers/{code}","href":"/api-reference/vouchers/delete-voucher","autogeneratedByOpenApi":true},{"title":"Enable Voucher","description":"The method sets the voucher state to **active**. The voucher can be redeemed - only if the redemption occurs after the start date and the voucher is not expired.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/{code}/enable","href":"/api-reference/vouchers/enable-voucher","autogeneratedByOpenApi":true},{"title":"Disable Voucher","description":"This method sets the voucher state to **inactive**. The voucher cannot be redeemed.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/{code}/disable","href":"/api-reference/vouchers/disable-voucher","autogeneratedByOpenApi":true},{"title":"Adjust Voucher Balance","description":"Add balance to an existing gift card or loyalty card. For loyalty cards (**legacy loyalty**), the card must be assigned to a holder. For Loyalty hub cards, use `/v2/loyalties` card transaction endpoints.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/{code}/balance","href":"/api-reference/vouchers/adjust-voucher-balance","autogeneratedByOpenApi":true},{"title":"List Voucher Transactions","description":"List transactions that are associated with credit movements on a gift card or loyalty card (**legacy loyalty**).","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json get /v1/vouchers/{code}/transactions","href":"/api-reference/vouchers/list-voucher-transactions","autogeneratedByOpenApi":true},{"title":"Export Voucher Transactions","description":"Export transactions that are associated with credit movements on a gift card or loyalty card (**legacy loyalty**).\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique transaction ID. | vtx_0cb7811f1c07765800 |\n| type | Transaction type. | - `CREDITS_REMOVAL` \u003cbr /> - `CREDITS_ADDITION` \u003cbr /> - `CREDITS_REFUND` \u003cbr /> - `CREDITS_REDEMPTION` \u003cbr /> - `POINTS_ACCRUAL` \u003cbr /> - `POINTS_REDEMPTION`\u003cbr /> - `POINTS_REFUND`\u003cbr /> - `POINTS_ADDITION`\u003cbr /> - `POINTS_REMOVAL`\u003cbr /> - `POINTS_EXPIRATION`\u003cbr /> - `POINTS_TRANSFER_IN`\u003cbr /> - `POINTS_TRANSFER_OUT` |\n| source_id | Unique transaction source ID. | 8638 |\n| reason | Contains the reason for the transaction if one was included originally. | |\n| balance | The gift card or loyalty card (**legacy loyalty**) balance after the transaction. | |\n| amount | The amount of gift card or loyalty card (**legacy loyalty**) credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |\n| voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |\n| campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |\n| source| Channel through which the transaction was initiated. | API |\n| details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |\n| related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/{code}/transactions/export","href":"/api-reference/vouchers/export-voucher-transactions","autogeneratedByOpenApi":true},{"title":"Import Vouchers","description":"Import generic (standalone) vouchers and gift cards into the repository.\nYou can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. \n Also, the request can include up to **10 MB** of data.\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Important notes\u003c/Badge>\n\n- **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z.\n- Custom code attributes (not supported by-default) need to be added as code **metadata**.\n- You **cannot import the same codes** to a single Voucherify Project.\n\n\u003c/Note>\n\nAny parameters not provided in the payload will be left blank or null.\n\nFor both **standalone discount vouchers and gift cards**, you can import the following fields: \n\n- code\n- category\n- active\n- type\n- start_date\n- expiration_date\n- redemption.quantity\n- additional_info\n- metadata\n\nFor **gift cards**, you can also import the following field:\n\n- gift.amount\n\nFor **discount vouchers**, you can import the `discount` object. The object will slightly vary depending on the type of discount. Each discount type **requires** the `type` to be defined in the import.\n\n| **Discount Type** | **Required fields** |\n|:---|:---|\n| Amount | amount_off, effect |\n| Percent | percent_off, effect |\n| Fixed | fixed_amount, effect |\n| Unit - One item | unit_off, unit_type, effect |\n| Unit - Multiple items | unit_off, unit_type, effect |\n| Shipping | unit_off, unit_type, effect |\n\nFields other than the ones listed above won't be imported. Even if provided, they will be silently skipped.\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Standalone Vouchers and Campaigns\u003c/Badge>\n\nGeneric (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for `campaign` and `campaign_id` are `null`.\n\nTo create a generic (standalone) voucher with a `\"type\": \"STANDALONE\"`, use the [POST Create campaign](/api-reference/campaigns/create-campaign) endpoint.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/import","href":"/api-reference/vouchers/import-vouchers","autogeneratedByOpenApi":true},{"title":"Import Vouchers using CSV","description":"Import generic (standalone) vouchers into the repository using a CSV file.\n\nThe CSV file has to include headers in the first line. All properties listed in the file headers that cannot be mapped to standard voucher fields will be added to the metadata object.\nYou can upload up to 100,000 codes to a campaign, as a campaign can have up to 100,000 codes by default. \n Also, the request can include a max. **10 MB** CSV file.\n\nYou can find an example CSV file [here](/build/discount-code-import).\n___\n\n```cURL cURL example\ncurl -X **POST** \\\n https://api.voucherify.io/v1/vouchers/importCSV \\\n -F file=@/path/to/vouchers.csv \\\n -F webhooks_enable=true\\\n -H \"X-App-Id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\" \\\n -H \"X-App-Token: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n```\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Standard voucher fields mapping\u003c/Badge>\n\n- Go to the [import vouchers](/api-reference/vouchers/import-vouchers) endpoint to see all standard CSV fields description (body params section).\n- Supported CSV file headers: Code,Voucher Type,Value,Discount Type,Category,Start Date,Expiration Date,Redemption Limit,Redeemed Quantity, Redeemed Amount,Active,Additional Info,Custom Metadata Property Name\n- **Start and expiration dates** need to be provided in compliance with the ISO 8601 standard. For example, 2020-03-11T09:00:00.000Z.\n - `YYYY-MM-DD`\n - `YYYY-MM-DDTHH`\n - `YYYY-MM-DDTHH:mm`\n - `YYYY-MM-DDTHH:mm:ss`\n - `YYYY-MM-DDTHH:mm:ssZ`\n - `YYYY-MM-DDTHH:mm:ssZ`\n - `YYYY-MM-DDTHH:mm:ss.SSSZ`\n- Custom code attributes (not supported by-default) need to be added as code **metadata**.\n- You **cannot import the same codes** to a single Voucherify project.\n- You can, however, upload the same codes to update them.\n\n\u003c/Note>\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Categories\u003c/Badge>\n\nIn the structure representing your data, you can define a category that the voucher belongs to. You can later use the category of a voucher to group and search by specific criteria in the Dashboard and using the [List Vouchers](/api-reference/vouchers/list-vouchers) endpoint.\n\n\u003c/Note>\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).\n\nYou can pass the `webhooks_enable=true` parameter to trigger a webhook sendout for created or updated vouchers. Configure the [respective webhooks](/api-reference/introduction-to-webhooks) in Project settings. For updated webhooks, a webhook is sent even if the voucher hasn't been changed in the CSV file.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Generic (standalone) vouchers and campaigns\u003c/Badge>\n\nGeneric (standalone) vouchers created through the Voucherify dashboard always create a campaign for that voucher. However, vouchers imported through the dashboard in the Vouchers section or through the API do not have a campaign attached, so the values for `campaign` and `campaign_id` are `null`.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/importCSV","href":"/api-reference/vouchers/import-vouchers-using-csv","autogeneratedByOpenApi":true},{"title":"Update Vouchers in Bulk","description":"Updates specific metadata parameters for each code, respectively, in one asynchronous operation.\n\nThe request can include up to **10 MB** of data.\n\nUpserts are not supported.\n\n\u003cWarning>\n\nCurrently, only **metadata** updates are supported.\n\n\u003c/Warning>\n\nThe response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.:\n\n- The status of your request (in queue, in progress, done, or failed)\n\n- Resources that failed to be updated\n\n- The report file with details about the update\n\n\n\nThis API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/bulk/async","href":"/api-reference/vouchers/update-vouchers-in-bulk","autogeneratedByOpenApi":true},{"title":"Update Vouchers' Metadata in Bulk","description":"Updates metadata parameters for a list of codes. Every resource in the list will receive the metadata defined in the request.\n\nThe request can include up to **10 MB** of data.\n\nUpserts are not supported.\n\nThe response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.:\n\n- The status of your request (in queue, in progress, done, or failed)\n\n- Resources that failed to be updated\n\n- The report file with details about the update\n\n\n\nThis API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/metadata/async","href":"/api-reference/vouchers/update-vouchers-metadata-in-bulk","autogeneratedByOpenApi":true},{"title":"Release Validation Session","description":"Manually release the validation session lock for the voucher in the path. This undoes the lock described in the [Locking validation session](/guides/locking-validation-session) guide for that voucher only.\n\nIf several redeemables were locked with the same session key (for example in a stackable validation), this call removes the lock for the path voucher only. Other redeemables that still use the same session key stay locked. A session-released event is recorded only for the unlocked voucher, and only when a lock was actually removed.\n\nCalling this endpoint again when the voucher no longer has that session lock still returns `204` and does not create another session-released event.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Release session in the Dashboard\u003c/Badge>\n\nOn a redeemable's details **Validations** tab, **Release session** unlocks only that redeemable (same scope as this endpoint). To unlock the session for every redeemable that still holds the key, use **Redemptions** > **Sessions**. See [Validations and redemptions](/optimize/validations-and-redemptions#sessions).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/vouchers.json delete /v1/vouchers/{code}/sessions/{sessionKey}","href":"/api-reference/vouchers/release-validation-session","autogeneratedByOpenApi":true},{"title":"Examine Voucher Qualification","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for qualification, and we do not recommend using it. The new [Qualifications API](/api-reference/qualifications/check-eligibility) introduces additional features and improvements while maintaining backward compatibility. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nDisplay vouchers qualified to the given customer and context (e.g., order, loyalty reward). Checks up to 50 **generic (standalone) vouchers**. \n\n\u003cTip>\n\n\u003cBadge color=\"green\">Prevailing assumption\u003c/Badge>\n\nYou data is synced with Voucherify.\n\n\u003c/Tip>\n\n ## How does this endpoint work? \n\n A property's value that does not meet a validation rule requirement will disqualify that particular voucher and it will not be listed in the results.\n\nAs a sample use case, you can imagine a requirement of displaying coupons available for the customer below the shopping cart. The customer can choose and apply the proposed voucher.\n\n ## What's excluded? \n\n The verification logic won't run against _coupons from bulk unique code campaigns_. For campaigns with multiple unique codes, you should run a [dedicated function](/api-reference/campaigns/examine-campaign-qualification) for searching and identifying qualified campaigns.\n\n ## Customizing the response\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Query parameters let you sort and filter the returned vouchers\u003c/Badge>\n\nCustomize your response:\n\n- If you only care about verifying a customer, use `audienceRulesOnly` set to `true`.\n- If you want to limit the number of vouchers to be returned from the entire pool of eligible vouchers, set a `limit`. This will return vouchers sorted by `-created_at`, by default beginning with the most recent vouchers listed at the top.\n- If you have a preference on the sorting order of the returned vouchers, you can use `order` to customize your response.\n\n\u003c/Note>\n\n ## Sending the request body payload\n\n\n ## Customer\n\nYou have the option of sending customer data via the dedicated `customer` object in the request body or a nested `customer` object within the `order` object.\n ### Available options:\n\n - You can either pass a customer `id` (Voucherify system generated),\n\n - a `source_id` (your own unique internal customer identifier e.g., email, database ID, CRM id), \n\n - a combination of the remaining parameters in the customer object, \n\n - a combination of customer `id` and remaining parameters excluding `source_id`, or\n\n - a combination of `source_id` and remaining parameters excluding `id`\n\n #### Note:\n\n For the latter two options, if you pass the `source_id` or the `id` with the other parameters, the logic will run independently for parameters explicitly passed in the request body versus those not explicitly passed in the request body. For _parameters not explicitly listed in the payload_, the verification will be against the data stored for that customer in the system. On the other hand, for any _parameter values explicitly passed in the payload_, the logic will ignore those stored in the system and will use the new values provided in the qualification request body. \n\n The qualification runs against rules that are defined through the [Create Validation Rules](/api-reference/validation-rules/create-validation-rules) endpoint or via the Dashboard. [Read more](/personalize/create-validation-rules). \n\n## Order\n\n ### Available options:\n\n - You can either pass an order `id` (Voucherify system generated),\n\n - a `source_id` (your own unique internal order identifier), \n\n - a combination of the remaining parameters in the order object, \n\n - a combination of order `id` and remaining parameters excluding `source_id`, or\n\n - a combination of `source_id` and remaining parameters excluding `id`\n\n #### Note:\n\n For the latter two options, if you pass the `source_id` or the `id` with the other parameters, the logic will run independently for parameters explicitly passed in the request body versus those not explicitly passed in the request body. For _parameters not explicitly listed in the payload_, the verification will be against the data stored for that order in the system. On the other hand, for any _parameter values explicitly passed in the payload_, the logic will ignore those stored in the system and will use the new values provided in the qualification request body. \n\n The qualification runs against rules that are defined through the [Create Validation Rules](/api-reference/validation-rules/create-validation-rules) endpoint or via the Dashboard. [Read more](/personalize/create-validation-rules).\n\n## Guidelines:\n\nTo validate against vouchers with total order `amount` requirements, make sure to include the total order `amount` in the order object or alternatively the `amount` for _every_ order item (the application will then add each amount to get the total and perform the qualification checks). If the total order `amount` is provided along with the individual items' amounts, the total order `amount` will take precedence.\n\n\n| **Case** | **Order-Level Parameter Included** | **Item-Level Parameter Included** | **Precedence** | **Calculation Result** | **Parameter included in payload accounts for checks against requirements in these validation rules** |\n|:---:|:---:|:---:|:---:|---|---|\n| **1** | `amount` | `amount` | Order-level | Uses order-level `amount` | - Total order amount |\n| **2** | | `amount` | Item-level | Sums each item-level `amount` | - Total order amount \u003cbr />- subtotal of matched items |\n| **3** | | `price`\u003cbr />`quantity` | Item-level | Multiplies each item's (`price` x `quantity`) to get item `amount` and then adds each item's `amount` to get total order `amount` | - Total order amount\u003cbr />- Subtotal of matched items\u003cbr />- Unit price of any matching order line\u003cbr />- Price of each item/Price of any item |\n| **4** | | `amount` \u003cbr />`price` \u003cbr />`quantity` | Item-level `amount` | Uses item-level `amount` for total order `amount` calculation, ignores (`price` x `quantity`) calculation | - Total order amount (uses item `amount` if provided or `price` x `quantity` for items without `amount` property; `amount` takes precedence in case all 3 properties are provided for an item)\u003cbr />- Subtotal of matched items (uses item `amount`, takes precedence if all 3 properties are provided)\u003cbr />- Unit price of any matching order line\u003cbr />- Price of each item/Price of any item |\n| **5** | `amount` | `amount` \u003cbr />`price` \u003cbr />`quantity` | Order-level | Uses order-level `amount` for total order `amount` | - Total order amount (uses order-level `amount`). \u003cbr />- Subtotal of matched items (see case **4** for details). \u003cbr />- Unit price of any matching order line \u003cbr />- Price of each item/Price of any item |","deprecated":true,"version":null,"openapi":"/openapi/vouchers.json post /v1/vouchers/qualification","href":"/api-reference/vouchers/examine-voucher-qualification","autogeneratedByOpenApi":true}]},{"group":"Campaigns","public":true,"pages":[{"title":"Campaign Object","mode":"frame","description":null,"href":"/api-reference/campaigns/campaign-object"},{"title":"List Campaigns","description":"Retrieve a list of campaigns in a project. \n\nThe campaigns are returned sorted by creation date, with the most recent campaigns appearing first. \n\nWhen you get a list of campaigns, you can optionally specify query parameters to customize the amount of campaigns returned per call using `limit`, which page of campaigns to return using `page`, sort the campaigns using the `order` query parameter and filter the results by the `campaign_type`.\n\nThis method will return an error when trying to return a limit of more than 100 campaigns.","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json get /v1/campaigns","href":"/api-reference/campaigns/list-campaigns","autogeneratedByOpenApi":true},{"title":"Create Campaign","description":"Method to create a batch of vouchers aggregated in one campaign. You can choose a variety of voucher types and define a unique pattern for generating codes. \n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Global uniqueness\u003c/Badge>\n\nAll campaign codes are unique across the whole project. Voucherify will not allow you to generate 2 campaigns with the same coupon code.\n\n\u003c/Note>\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Code generation status\u003c/Badge>\n\nThis is an asynchronous action; you can't read or modify a newly created campaign until the code generation is completed. See the `creation_status` field in the [campaign object](/api-reference/campaigns/campaign-object) description.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns","href":"/api-reference/campaigns/create-campaign","autogeneratedByOpenApi":true},{"title":"Get Campaign","description":"Retrieves the campaign with the given campaign ID or campaign name.","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json get /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/get-campaign","autogeneratedByOpenApi":true},{"title":"Update Campaign","description":"Updates the specified campaign by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged. \n\nFields other than the ones listed in the request body won't be modified. Even if provided, they will be silently skipped. \n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Vouchers will be affected\u003c/Badge>\n\nThis method will update vouchers aggregated in the campaign. It will affect all vouchers that are not published or redeemed yet.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json put /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/update-campaign","autogeneratedByOpenApi":true},{"title":"Delete Campaign","description":"Deletes a campaign and all related vouchers. This action cannot be undone. Also, this method immediately removes any redemptions on the voucher.\n\nIf the `force` parameter is set to `false` or not set at all, the campaign and all related vouchers will be moved to [the bin](/api-reference/bin/list-bin-entries).\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json delete /v1/campaigns/{campaignId}","href":"/api-reference/campaigns/delete-campaign","autogeneratedByOpenApi":true},{"title":"List Campaign Transactions","description":"Retrieves all transactions for the campaign with the given campaign ID or campaign name. The `id` filter denotes the unique transaction identifier.\n\n\u003cWarning>\n\nThe endpoint works only for gift card and **legacy loyalty** campaigns.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json get /v1/campaigns/{campaignId}/transactions","href":"/api-reference/campaigns/list-campaign-transactions","autogeneratedByOpenApi":true},{"title":"Export Campaign Transactions","description":"Export transactions is an asynchronous process that generates a CSV file with the data about credit movements on all gift cards or point movements on all loyalty cards (**legacy loyalty**) in a given campaign.\n\nTo export transactions:\n1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered.\n2. Use the returned `id` to track the export status with the [GET Export](/api-reference/exports/get-export) method.\n3. In the GET Export method, when the returned `status` field has the `DONE` value, the export file has been generated.\n4. Use the URL in the `result` property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file.\n\nAn export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files.\n\nAn example export file can look as follows:\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| `id` | Unique transaction ID. | `vtx_0cb7811f1c07765800` |\n| `type` | Transaction type. |**Gift cards**:\u003cbr />- `CREDITS_REMOVAL`\u003cbr />- `CREDITS_ADDITION`\u003cbr />- `CREDITS_REFUND`\u003cbr />- `CREDITS_REDEMPTION`\u003cbr />**Loyalty cards**:\u003cbr />- `POINTS_ACCRUAL`\u003cbr />- `POINTS_REDEMPTION`\u003cbr />- `POINTS_REFUND`\u003cbr />- `POINTS_ADDITION`\u003cbr />- `POINTS_REMOVAL`\u003cbr />- `POINTS_EXPIRATION`\u003cbr />- `POINTS_TRANSFER_IN`\u003cbr />- `POINTS_TRANSFER_OUT` |\n| `source_id` | Unique transaction source ID. Optional and only in manual operations: `CREDITS_ADDITION`, `CREDITS_REMOVAL`, `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_TRANSFER_OUT`. | 8638 |\n| `reason` | Contains the reason for the transaction if one was included originally. Optional and only in the following manual operations: `CREDITS_ADDITION`, `CREDITS_REMOVAL`, `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_TRANSFER_OUT`, `POINTS_TRANSFER_IN`. | `Apology for sending a broken item` |\n| `balance` | The gift card or loyalty card balance after the transaction. | |\n| `amount` | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| `created_at` | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | `2024-10-09T09:16:32.521Z` |\n| `voucher_id` | Unique voucher ID. | `v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp` |\n| `source`| Channel through which the transaction was initiated. | `API` |\n| `details` | More detailed information stored in the form of JSON. | Provides more details related to the transaction in the form of an object. |\n| `related_transaction_id` | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | `vtx_0c9afe802593b34b80` |\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Export Loyalty Campaign Transactions\u003c/Badge>\n\nFor **legacy loyalty** campaigns, this method works in the same way the [POST Export Loyalty Campaign Transactions](/api-reference/loyalties/export-loyalty-campaign-transactions) does.\n\n\u003c/Tip>","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/transactions/export","href":"/api-reference/campaigns/export-campaign-transactions","autogeneratedByOpenApi":true},{"title":"Add Vouchers to Campaign","description":"This method gives the possibility to push new vouchers to an existing campaign. New vouchers will inherit properties from the campaign profile. However, it is possible to overwrite some of them in the request body. If you provide an optional `code_config` parameter with a voucher code configuration, then it will be used to generate new voucher codes. Otherwise, the voucher code configuration from the campaign will be used.\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/vouchers","href":"/api-reference/campaigns/add-vouchers-to-campaign","autogeneratedByOpenApi":true},{"title":"Add Voucher with Specific Code to Campaign","description":"This method gives a possibility to add a new voucher to an existing campaign. The voucher definition will be inherited from the definition kept in the campaign profile. However, you are able to overwrite a few properties inherited from the campaign.","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/vouchers/{code}","href":"/api-reference/campaigns/add-voucher-with-specific-code-to-campaign","autogeneratedByOpenApi":true},{"title":"Import Vouchers to Campaign","description":"Imports vouchers to an **existing** campaign.\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/import","href":"/api-reference/campaigns/import-vouchers-to-campaign","autogeneratedByOpenApi":true},{"title":"Import Vouchers to Campaign by CSV","description":"Imports vouchers to an **existing** campaign. \n\n\nThe CSV file has to include headers in the first line. \n\nCurl Example\n\n```cURL\ncurl -X **POST** \\\n https://api.voucherify.io/v1/campaigns/TEST-CAMPAIGN/importCSV \\\n -F file=@/path/to/campaigns.csv \\\n -H \"X-App-Id: c70a6f00-cf91-4756-9df5-47628850002b\" \\\n -H \"X-App-Token: 3266b9f8-e246-4f79-bdf0-833929b1380c\"\n```\n\nYou can import values for the following fields: `Code` (**required**), `Category`, `Active`. In a gift cards import, you can also include the current card balance using the `Gift Amount` header and the amount that was redeemed using the `Redeemed Amount` header. In a loyalty cards import, you can also include the current loyalty card score in points using the `Loyalty Points` header. Remaining CSV columns will be mapped to metadata properties. \n\nDiscount type, time limits, and validation rules will be taken from the [campaign object](/api-reference/campaigns/campaign-object) settings. \n\n\n| **Active** | **Code** | **Loyalty Points** | **Gift Amount** | **Redeemed Amount** | **Redeemed Quantity** | **Category** | **Custom_metadata_property** |\n|---|---|---|---|---|---|---|---|\n| Use `true` or `false` to enable or disable the voucher; this flag can be used to turn off the ability to redeem a voucher even though it is within the campaign's start/end validity timeframe. | The unique voucher code. | The number of points to be added to the loyalty card. If you leave this undefined, then the initial number of points will be set according to the campaign settings.\u003cbr />Context: `LOYALTY_PROGRAM` | The initial gift card balance.\u003cbr />Context: `GIFT_VOUCHERS` | The amount that was redeemed from the available balance on a gift card. | The number of times the voucher has been redeemed. | A custom tag for the voucher to help you filter codes; you can either import the category name or a unique Voucherify-assigned category ID. | Any additional data that you would like to store for the given loyalty card as a Custom attribute. Remember to define the metadata schema in the Dashboard prior to importing codes. |\n|\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Active\u003c/Badge>\n\nThe CSV file is allowed in two versions; either with or without a column titled `Active`. It indicates whether the voucher is enabled after the import event.\n\n\u003c/Note>\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/importCSV","href":"/api-reference/campaigns/import-vouchers-to-campaign-by-csv","autogeneratedByOpenApi":true},{"title":"Enable Campaign","description":"Sets campaign state to **active**. The vouchers in this campaign can be redeemed - only if the redemption occurs after the start date of the campaign and voucher and the voucher and campaign are not expired.","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/enable","href":"/api-reference/campaigns/enable-campaign","autogeneratedByOpenApi":true},{"title":"Disable Campaign","description":"Sets campaign state to **inactive**. The vouchers in this campaign can no longer be redeemed.","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/{campaignId}/disable","href":"/api-reference/campaigns/disable-campaign","autogeneratedByOpenApi":true},{"title":"Get Campaign Summary","description":"Returns data for campaign analytics, covering validations, redemptions, publications, and other details specific to a given campaign type.\n\nUse `start_date` and `end_date` to narrow down the data to specific periods.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Campaigns created before 17 June 2025\u003c/Badge>\n\nThis endpoint returns analytics data for campaigns that were created after 17 June 2025. Older campaigns return empty data.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/campaigns.json get /v1/campaigns/{campaignId}/summary","href":"/api-reference/campaigns/get-campaign-summary","autogeneratedByOpenApi":true},{"title":"Examine Campaign Qualification","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for qualification, and we do not recommend using it. The new [Qualifications API](/api-reference/qualifications/check-eligibility) introduces additional features and improvements while maintaining backward compatibility. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nThe method can be used for sending a request to display all campaigns qualified to the given customer and context (e.g., order). \n\nThe maximum number of **returned campaigns is 50**.\n\n## What campaign types are included in the response?\n\n- `DISCOUNT_COUPONS`\n- `GIFT_VOUCHERS`\n- `REFERRAL_PROGRAM`\n\n## What's excluded?\n\nA checking logic will be run only among campaigns and will ignore _generic (standalone) vouchers_. For generic (standalone) vouchers, you should run a [dedicated endpoint](/api-reference/vouchers/examine-voucher-qualification) for searching and identifing vouchers. \n\n## Subsequent Steps\n\nAs a recommended subsequent step after selecting a qualified campaign is to publish a voucher code from that campaign. The [API method for publishing](/api-reference/publications/create-publication) will return a unique code which will belong to a given customer.\n\n## Sample use case\n\nAs a sample use case, you can imagine a requirement of displaying coupons (grouped in campaigns) that a customer is eligible to use. The customer should get assigned to the particular voucher from the campaign and then may redeem that particular code when he/she places an order.\n\n[Read](/guides/checking-eligibility) about Qualification API limits before you start.","deprecated":true,"version":null,"openapi":"/openapi/campaigns.json post /v1/campaigns/qualification","href":"/api-reference/campaigns/examine-campaign-qualification","autogeneratedByOpenApi":true}]},{"group":"Promotions","public":true,"pages":[{"title":"Promotion Tier Object","mode":"frame","description":null,"href":"/api-reference/promotions/promotion-tier-object"},{"title":"List Promotion Tiers","description":"This method enables you to list promotion tiers.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json get /v1/promotions/tiers","href":"/api-reference/promotions/list-promotion-tiers","autogeneratedByOpenApi":true},{"title":"List Promotion Tiers from Campaign","description":"This method enables you to list promotion tiers from a specified campaign.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json get /v1/promotions/{campaignId}/tiers","href":"/api-reference/promotions/list-promotion-tiers-from-campaign","autogeneratedByOpenApi":true},{"title":"Add Promotion Tier to Campaign","description":"This method allows you to add a new promotion tier to an existing campaign. The tier hierarchy will be set as the next consequtive integer following the lowest ranking tier.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json post /v1/promotions/{campaignId}/tiers","href":"/api-reference/promotions/add-promotion-tier-to-campaign","autogeneratedByOpenApi":true},{"title":"Get Promotion Tier","description":"This method enables you to retrieve a specific promotion tier.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json get /v1/promotions/tiers/{promotionTierId}","href":"/api-reference/promotions/get-promotion-tier","autogeneratedByOpenApi":true},{"title":"Update Promotion Tier","description":"This method updates a promotion tier.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json put /v1/promotions/tiers/{promotionTierId}","href":"/api-reference/promotions/update-promotion-tier","autogeneratedByOpenApi":true},{"title":"Delete Promotion Tier","description":"This method deletes a promotion tier.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json delete /v1/promotions/tiers/{promotionTierId}","href":"/api-reference/promotions/delete-promotion-tier","autogeneratedByOpenApi":true},{"title":"Enable Promotion Tier","description":"This method enables a promotion tier, i.e. makes the `active` parameter = `true`.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json post /v1/promotions/tiers/{promotionTierId}/enable","href":"/api-reference/promotions/enable-promotion-tier","autogeneratedByOpenApi":true},{"title":"Disable Promotion Tier","description":"This method disables a promotion tier, i.e. makes the `active` parameter = `false`.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json post /v1/promotions/tiers/{promotionTierId}/disable","href":"/api-reference/promotions/disable-promotion-tier","autogeneratedByOpenApi":true},{"title":"List Promotion Stacks","description":"This method enables you to list promotion stacks irrespective of the campaign they are associated with. \n\nYou can use filters in the query parameters to specify the stacks to be returned in the response.\n\n## Advanced filters for fetching promotion stacks\n\n| **Filters** | **Examples** |\n| :--- | :--- |\n| Created Before | - `[created_at][before]=2021-12-30T13:52:18.227Z`\u003cbr />- `[filters][created_at][conditions][$before][0]=2021-12-30T13:52:18.227Z` |\n| Created After | - `[created_at][after]=2021-12-30T13:52:18.227Z`\u003cbr />- `[filters][created_at][conditions][$after][0]=2021-12-30T13:52:18.227Z` |\n| Updated Before | - `[updated_at][before]=2021-12-30T13:52:18.227Z`\u003cbr />- `[filters][updated_at][conditions][$before][0]=2021-12-30T13:52:18.227Z` |\n| Updated After | - `[updated_at][after]=2021-12-30T13:52:18.227Z`\u003cbr />- `[filters][updated_at][conditions][$after][0]=2021-12-30T13:52:18.227Z` |","deprecated":null,"version":null,"openapi":"/openapi/promotions.json get /v1/promotions/stacks","href":"/api-reference/promotions/list-promotion-stacks","autogeneratedByOpenApi":true},{"title":"List Promotion Stacks in Campaign","description":"This method enables you to list promotion stacks from a specified campaign.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json get /v1/promotions/{campaignId}/stacks","href":"/api-reference/promotions/list-promotion-stacks-in-campaign","autogeneratedByOpenApi":true},{"title":"Get Promotion Stack","description":"This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json get /v1/promotions/{campaignId}/stacks/{stackId}","href":"/api-reference/promotions/get-promotion-stack","autogeneratedByOpenApi":true},{"title":"Create Promotion Stack","description":"This method creates one promotion stack. The sequence of promotion tier IDs will determine the promotion stacking order.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json post /v1/promotions/{campaignId}/stacks","href":"/api-reference/promotions/create-promotion-stack","autogeneratedByOpenApi":true},{"title":"Update Promotion Stack","description":"This methods allows for editing an existing stack.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json put /v1/promotions/{campaignId}/stacks/{stackId}","href":"/api-reference/promotions/update-promotion-stack","autogeneratedByOpenApi":true},{"title":"Delete Promotion Stack","description":"This method deletes a promotion stack.","deprecated":null,"version":null,"openapi":"/openapi/promotions.json delete /v1/promotions/{campaignId}/stacks/{stackId}","href":"/api-reference/promotions/delete-promotion-stack","autogeneratedByOpenApi":true}]},{"group":"Templates","public":true,"pages":[{"title":"List Campaign Templates","description":"Lists all campaign templates available in the project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json get /v1/templates/campaigns","href":"/api-reference/templates/list-campaign-templates","autogeneratedByOpenApi":true},{"title":"Get Campaign Template","description":"Retrieves a campaign template available in the project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json get /v1/templates/campaigns/{campaignTemplateId}","href":"/api-reference/templates/get-campaign-template","autogeneratedByOpenApi":true},{"title":"Create Campaign Template","description":"Creates a template for a discount or gift campaign, or a promotion tier.\n\nA template stores campaign configuration **without** the following details:\n- Campaign name\n- Category\n- Code count\n\nThe following elements are not supported by campaign templates:\n- Redeeming API keys\n- Redeeming users\n- Customer loyalty tier (**legacy loyalty**)\n- Static segments\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Promotion Tiers and Campaign Templates\u003c/Badge>\n\nYou can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the `DISCOUNT_COUPON` type. You can use this template to create:\n\n- [Discount campaign](/api-reference/templates/create-campaign-from-template),\n- [Promotion tier](/api-reference/templates/add-promotion-tier-from-template).\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json post /v1/templates/campaigns","href":"/api-reference/templates/create-campaign-template","autogeneratedByOpenApi":true},{"title":"Update Campaign Template","description":"Updates the name or description of the campaign template.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json put /v1/templates/campaigns/{campaignTemplateId}","href":"/api-reference/templates/update-campaign-template","autogeneratedByOpenApi":true},{"title":"Delete Campaign Template","description":"Deletes the campaign template permanently.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json delete /v1/templates/campaigns/{campaignTemplateId}","href":"/api-reference/templates/delete-campaign-template","autogeneratedByOpenApi":true},{"title":"Create Campaign From Template","description":"Creates a campaign out of a campaign template.\n\nTo create a campaign, you need to provide the name in the request, while other fields are optional. If no other fields are sent, the configuration from the template will be used.\n\nYou can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the campaign. When the campaign has been created, then you can:\n- [Update the validation rule](/api-reference/validation-rules/update-validation-rule),\n- [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment),\n- [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rules-assignments).\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Promotion Tiers and Campaign Templates\u003c/Badge>\n\nYou can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the `DISCOUNT_COUPON` type. You can use this template to create:\n\n- [Discount campaign](/api-reference/templates/create-campaign-from-template)\n- [Promotion tier](/api-reference/templates/add-promotion-tier-from-template)\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json post /v1/templates/campaigns/{campaignTemplateId}/campaign-setup","href":"/api-reference/templates/create-campaign-from-template","autogeneratedByOpenApi":true},{"title":"Add Promotion Tier From Template","description":"Creates a promotion tier out of a discount campaign template and adds it to an existing promotion campaign.\n\nTo add a promotion tier to a campaign, you need to provide the name in the request and the campaign ID. Other fields are optional. If no other fields are sent, the configuration from the template will be used.\n\nYou can send new values of the fields listed below to replace the settings saved in the template. However, you cannot assign an action or an existing validation rule or create a new one in the request. If the template has a validation rule, a new validation rule is always created for the promotion tier. When the promotion tier has been created, then you can:\n- [Update the validation rule](/api-reference/validation-rules/update-validation-rule),\n- [Unassign the validation rule](/api-reference/validation-rules/delete-validation-rule-assignment),\n- [Assign an existing validation rule](/api-reference/validation-rules/create-validation-rule-assignment).\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Promotion Tiers and Campaign Templates\u003c/Badge>\n\nYou can create a campaign template out of a promotion tier. Promotion tiers are converted to a discount campaign with the `DISCOUNT_COUPON` type. You can use this template to create:\n\n- [Discount campaign](/api-reference/templates/create-campaign-from-template)\n- [Promotion tier](/api-reference/templates/add-promotion-tier-from-template)\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/templates.json post /v1/templates/campaigns/{campaignTemplateId}/tier-setup","href":"/api-reference/templates/add-promotion-tier-from-template","autogeneratedByOpenApi":true}]},{"group":"Loyalty v2","public":true,"root":{"title":"Loyalty v2 API: Overview","description":"Map the Loyalty v2 API under /v2/loyalties: Programs, reusable components, members, examine, and reports","keywords":["loyalty v2","loyalties","API overview","loyalty programs","loyalty hub"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-api-overview"},"pages":[{"group":"Members","root":{"title":"Members: Overview","description":"Understand how customers are enrolled as members of a Loyalty v2 program, and how their loyalty cards, points, rewards, and payments are managed","keywords":["loyalty v2","loyalty members","loyalty cards","pending points","reward purchases","pay with points"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-members-overview"},"pages":[{"title":"Get customer memberships","description":"Returns loyalty memberships for a customer, including the resolved customer and each membership's member, program, and cards. `identification_type` chooses how `customerId` is read. It defaults to `customer_id`.\n\n`customer_id` and `customer_source_id` return every membership for that customer. `member_id` returns the customer linked to that member and only the membership for that member's program.\n\nCards omit `tier_progress`. See [Get program membership](/api-reference/programs/get-program-membership) when you need tier progress.\n\nReturns an empty `memberships` array when the customer exists and has no memberships. Returns `404` when the customer or member cannot be resolved.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/memberships/{customerId}","href":"/api-reference/programs/get-customer-memberships","autogeneratedByOpenApi":true},{"title":"List program members","description":"Returns a cursor-paginated list of members of the program. Deleted members are omitted. Results can be filtered by ID, status, customer ID and creation date. Results can be ordered by creation date, status, or customer ID (ascending or descending). The same field cannot be ordered both ascending and descending at the same time.\n\nReturns `404` when the program does not exist.\n\nList items do not include the `cards` array. Use the following endpoints to retrieve cards for a given member:\n- [Get customer memberships](/api-reference/programs/get-customer-memberships),\n- [Get program member](/api-reference/programs/get-program-member),\n- [Get program membership](/api-reference/programs/get-program-membership).\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members","href":"/api-reference/programs/list-program-members","autogeneratedByOpenApi":true},{"title":"Create program member","description":"Enrolls an existing customer as a member of the loyalty program and creates a loyalty card for each card definition assigned to the program. Card `code` generation is asynchronous, so `code` can be `null` right after creation.\n\nThe program must be `ACTIVE` and inside its validity window, and the customer must already exist. A customer can be a member of a program only once. Identify the customer with `customer_identification`. `status` defaults to `ACTIVE`.\n\nA successful call records [`vl.member.created`](/api-reference/loyalty-activity/members/created) and, for each card, [`vl.card.created`](/api-reference/loyalty-activity/cards/created), [`vl.card.assigned`](/api-reference/loyalty-activity/cards/assigned), and [`vl.member.card.assigned`](/api-reference/loyalty-activity/members/card-assigned); card code generation later records [`vl.card.code_generation.succeeded`](/api-reference/loyalty-activity/cards/code-generation-succeeded) or [`vl.card.code_generation.failed`](/api-reference/loyalty-activity/cards/code-generation-failed).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members","href":"/api-reference/programs/create-program-member","autogeneratedByOpenApi":true},{"title":"Batch create program members","description":"Schedules creation of program members from a JSON array and returns `202` with `async_action_id`. The program must exist, be `ACTIVE`, and be inside its validity window. The body isn't checked before that response. Entries are processed in batches of 100. The raw body must be at most 10 MB.\n\nEach entry uses the same fields as [Create program member](/api-reference/programs/create-program-member). A failed entry is skipped. Its report row sets `created` to `false` and explains the failure in `error`. Skipped cases include an invalid `customer_identification`, an unknown customer, an invalid `status`, a duplicate customer in the batch (`Duplicate customer ID`), a customer who is already a member (`Member already exists`), metadata that doesn't match the `vl_member` schema, and entries past the loyalty members plan limit. Successful entries enroll the customer and create a loyalty card for each card definition on the program. Report columns are `identification_type`, `customer_id`, `customer_source_id`, `program_id`, `member_id`, `created`, and `error`.\n\nAn empty array or a `null` entry fails the async action with `invalid_request_payload`. A body that isn't a JSON array fails it with `top_level_object_should_be_an_array`. Use [Get async action](/api-reference/async-actions/get-async-action) to read the status and the report. You can also open the result from Audit log, [Background tasks](/analyze/audit-logs#background-tasks).\n\nA successful call records no activity; the scheduled batch records [`vl.member.created`](/api-reference/loyalty-activity/members/created) and, for each card, [`vl.card.created`](/api-reference/loyalty-activity/cards/created), [`vl.card.assigned`](/api-reference/loyalty-activity/cards/assigned), and [`vl.member.card.assigned`](/api-reference/loyalty-activity/members/card-assigned), and card code generation later records [`vl.card.code_generation.succeeded`](/api-reference/loyalty-activity/cards/code-generation-succeeded) or [`vl.card.code_generation.failed`](/api-reference/loyalty-activity/cards/code-generation-failed).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/batch","href":"/api-reference/programs/batch-create-program-members","autogeneratedByOpenApi":true},{"title":"Get program member","description":"Returns one member of the program together with that member's loyalty cards. Each card includes `balance`, `lifetime_bucket`, `next_expiration`, and `next_activation`. `tier_progress` is not included. Use [Get program membership](/api-reference/programs/get-program-membership) when you need tier progress.\n\n`card.code` can be `null` shortly after member creation, while code generation is still running.\n\nReturns `404` when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}","href":"/api-reference/programs/get-program-member","autogeneratedByOpenApi":true},{"title":"Get program membership","description":"Returns the membership for one customer in the program: the member, the program, and the member's loyalty cards. A card includes `tier_progress` when its card definition has a tier structure and the member has a tier on that card. Otherwise `tier_progress` is omitted.\n\n`identification_type` chooses how `customerId` is read. It defaults to `customer_id`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/memberships/{customerId}","href":"/api-reference/programs/get-program-membership","autogeneratedByOpenApi":true},{"title":"Update program member","description":"Updates a program member's metadata. Provided object keys are merged into the existing metadata; omitted keys are preserved. Pass `metadata: null` to clear all metadata (sets it to an empty object).\n\nThis endpoint cannot change `status`. Use [Activate program member](/api-reference/programs/activate-program-member) or [Deactivate program member](/api-reference/programs/deactivate-program-member) for status transitions.\n\nReturns the updated member without the `cards` array. Returns `404` when the program or member does not exist. Returns `400` when the request body fails validation or the project `vl_member` metadata schema rejects the payload.\n\nA successful call records [`vl.member.updated`](/api-reference/loyalty-activity/members/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/programs/{programId}/members/{memberId}","href":"/api-reference/programs/update-program-member","autogeneratedByOpenApi":true},{"title":"Delete program member","description":"Deletes the member and sets `status` to `DELETED`. Removes the member's card assignments in this program.\n\nReturns the member without a `cards` array. Delete doesn't change `updated_at`.\n\nEach unassigned card also records `vl.member.card.unassigned` and `vl.card.unassigned`. When an assignment has a tier, the delete records a `LEFT` tier transaction with origin `member_card_deleted`.\n\nThe same customer can join the program again. The new member gets a new ID.\n\nReturns `404` when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first. Deleting a member that is already `DELETED` returns `404`.\n\nA successful call records [`vl.member.card.unassigned`](/api-reference/loyalty-activity/members/card-unassigned) and [`vl.card.unassigned`](/api-reference/loyalty-activity/cards/unassigned) for each assigned card, then [`vl.member.deleted`](/api-reference/loyalty-activity/members/deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/programs/{programId}/members/{memberId}","href":"/api-reference/programs/delete-program-member","autogeneratedByOpenApi":true},{"title":"Activate program member","description":"Moves an `INACTIVE` member to `ACTIVE` and sets `updated_at`. Records a `vl.member.activated` activity. No request body.\n\nReturns the member without a `cards` array.\n\nReturns `404` when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first. A `DELETED` member returns `404`. Returns `400` with key `invalid_state_transition` when the member is already `ACTIVE`.\n\nA successful call records [`vl.member.activated`](/api-reference/loyalty-activity/members/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/activate","href":"/api-reference/programs/activate-program-member","autogeneratedByOpenApi":true},{"title":"Deactivate program member","description":"Moves an `ACTIVE` member to `INACTIVE` and sets `updated_at`. Records a `vl.member.deactivated` activity. An `INACTIVE` member can't earn or spend points. No request body.\n\nReturns the member without a `cards` array.\n\nReturns `404` when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first. A `DELETED` member returns `404`. Returns `400` with key `invalid_state_transition` when the member is already `INACTIVE`.\n\nA successful call records [`vl.member.deactivated`](/api-reference/loyalty-activity/members/deactivated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/deactivate","href":"/api-reference/programs/deactivate-program-member","autogeneratedByOpenApi":true},{"title":"List program member activities","description":"Returns a cursor-paginated list of lifecycle and card-assignment activities recorded for the member. Filters are `id`, `type`, and `created_at`. Default order is `-created_at`, then `id` ascending.\n\nReturns 404 when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first. A DELETED member returns 404.\n\nReturns 400 with key `invalid_query_params` when the query fails validation. That check runs before the program and member lookup. A cursor that doesn't match `^lcrsambr_[a-f0-9]+$`, a `limit` outside 1 to 100, an `order` other than `created_at` or `-created_at`, or an array that orders by both directions fails here.\n\nAfter the program and member are found, an unknown or expired cursor returns `invalid_or_expired_cursor`. A cursor recorded for different `filters` or `order` returns `cursor_and_query_mismatch`. The cursor stays valid when only `limit` changes.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/activities","href":"/api-reference/programs/list-program-member-activities","autogeneratedByOpenApi":true},{"title":"Adjust card points","description":"Manually adjusts the points balance of the member's card.\n\nA positive `points` value creates an `ADMIN_CREDIT` card transaction. The expiration date comes from the member tier when that tier defines its own points expiration. Otherwise the date comes from the card definition. `expiration_date` is `null` when points don't expire.\n\nA negative `points` value creates an `ADMIN_DEBIT` card transaction.\n\nWhen `points` is `0`, no transaction is created and `status` is `NO_CHANGE`.\n\nThe transaction is created with status `PENDING` and processed asynchronously. The program and the member must be `ACTIVE`. The program must also be inside its validity window. Otherwise the response is `423`. The response is `404` when the program or the member doesn't exist, or when the card isn't assigned to that member.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/points","href":"/api-reference/programs/adjust-card-points","autogeneratedByOpenApi":true},{"title":"List card activities","description":"Returns a cursor-paginated list of activities recorded for the member's card. The card must still be assigned to that member. Filters are `id`, `type`, and `created_at`. Default order is `-created_at`, then `id` ascending.\n\nReturns 404 when the program doesn't exist, when the member doesn't exist in that program, or when the card isn't currently assigned to that member. The program is checked first, then the member. A DELETED member returns 404 with `resource_type` `member`. A missing assignment and a missing or deleted card both return 404 with `resource_type` `card`.\n\nReturns 400 with key `invalid_query_params` when the query fails validation. That check runs before the program, member, and card lookup. A cursor that doesn't match `^lcrsacrd_[a-f0-9]+$`, a `limit` outside 1 to 100, an `order` other than `created_at` or `-created_at`, or an array that orders by both directions fails here.\n\nAfter the program, member, and card are found, an unknown or expired cursor returns `invalid_or_expired_cursor`. A cursor recorded for different `filters` or `order` returns `cursor_and_query_mismatch`. The cursor stays valid when only `limit` changes.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/activities","href":"/api-reference/programs/list-card-activities","autogeneratedByOpenApi":true},{"title":"List card pending point buckets","description":"Returns a cursor-paginated list of pending point buckets for the member's card. Every bucket has status `PENDING`. Pending points wait for activation (`PERIOD_BASED`, `FIXED_DATES`, or `EVENT_BASED`), following the card definition.\n\nThe list starts on the next project day. The current day's bucket is omitted because it's still accumulating.\n\nResults can be filtered by card definition ID and ordered by `date`.\n\nReturns `404` when the program or the member doesn't exist, or when the card isn't assigned to that member.\n\nBucket IDs from this list are the `bucketId` for [Activate pending point bucket](/api-reference/programs/activate-pending-point-bucket) and [Cancel pending point bucket](/api-reference/programs/cancel-pending-point-bucket).\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points","href":"/api-reference/programs/list-card-pending-point-buckets","autogeneratedByOpenApi":true},{"title":"Activate pending point bucket","description":"Activates a pending points bucket and creates a `PENDING_POINTS_ACTIVATED` card transaction. The transaction is created with status `PENDING` and processed asynchronously. No request body.\n\nThe bucket must be `PENDING`, and its `date` must be after the current project day. The program and the member must be `ACTIVE`, and the program must be inside its validity window. Otherwise the response is `423`.\n\nReturns `404` when the program or the member doesn't exist, when the card isn't assigned to that member, or when the bucket isn't on that card.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points/{bucketId}/activate","href":"/api-reference/programs/activate-pending-point-bucket","autogeneratedByOpenApi":true},{"title":"Cancel pending point bucket","description":"Cancels a pending points bucket so its points aren't activated. Creates a `PENDING_POINTS_CANCELED` card transaction. The transaction is created with status `PENDING` and processed asynchronously. No request body.\n\nThe bucket must be `PENDING`, and its `date` must be after the current project day. The program and the member must be `ACTIVE`, and the program must be inside its validity window. Otherwise the response is `423`.\n\nReturns `404` when the program or the member doesn't exist, when the card isn't assigned to that member, or when the bucket isn't on that card.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/pending-points/{bucketId}/cancel","href":"/api-reference/programs/cancel-pending-point-bucket","autogeneratedByOpenApi":true},{"title":"List card expiring points buckets","description":"Returns a cursor-paginated list of `ACTIVE` point expiration buckets for the member's card. Each bucket groups points that share an expiration date and expiration type, including points from separate transactions.\n\nThe list starts on the current project day. Earlier buckets are omitted.\n\nResults can be filtered by card definition ID and expiration date, and ordered by `expiration_date`.\n\nReturns an empty list when the card has no matching buckets. Returns `400` when the query is invalid or the cursor is invalid, expired, or doesn't match the query. Returns `404` when the program or the member doesn't exist, or when the card isn't assigned to that member.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points","href":"/api-reference/programs/list-card-expiring-points-buckets","autogeneratedByOpenApi":true},{"title":"Expire point bucket","description":"Expires an `ACTIVE` points bucket. Creates an `ADMIN_POINTS_EXPIRATION` card transaction. The transaction is created with status `PENDING` and processed asynchronously. No request body.\n\nThe bucket must be `ACTIVE`, and its `expiration_date` must be on or after the current project day. The program and the member must be `ACTIVE`, and the program must be inside its validity window. Otherwise the response is `423`.\n\nReturns `404` when the program, the member, or the card definition doesn't exist, when the card isn't assigned to that member, or when the bucket isn't on that card.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/expiring-points/{bucketId}/expire","href":"/api-reference/programs/expire-point-bucket","autogeneratedByOpenApi":true},{"title":"List card transactions","description":"Returns a cursor-paginated list of transactions on the member's card. Filter by `id`, `card_definition_id`, and `created_at`. Order by `id` (default `-id`, newest first). Returns `404` when the program, member, or card doesn't exist. The program is checked first, then the member, then the card. A member of another program, or a card that isn't assigned to this member, is not found.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/transactions","href":"/api-reference/programs/list-card-transactions","autogeneratedByOpenApi":true},{"title":"List member reward purchases","description":"Lists stored `PURCHASE` reward transactions for the program member, with cursor pagination. Filter by `id`, `reward_id`, `card_definition_id`, and `created_at`. Order by `id` (default `-id`, newest first). Purchases rejected before a transaction is stored don't appear. A purchase accepted with `202` that later fails is stored as `REJECTED` with `details.rejection`. Returns `404` when the program or the member doesn't exist. The program is checked first.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/rewards/purchases","href":"/api-reference/programs/list-member-reward-purchases","autogeneratedByOpenApi":true},{"title":"Purchase reward with points","description":"Purchases a reward for the program member by spending points from the member's card. The card comes from the matching reward cost's card definition.\n\nThe program, reward, and member must be `ACTIVE`. The program and reward must be inside their validity windows. The reward must be assigned to the program with stock available, a cost must match the customer, and the purchase must stay inside frequency, cooldown, balance, and spending limits.\n\nModes:\n- `TRANSACTION` (default): creates a `PENDING` reward transaction and a `PENDING` card transaction. Returns `202`.\n- `DRY_RUN`: simulates the purchase and doesn't create a transaction. Returns `200` with status `SIMULATED`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/rewards/purchases","href":"/api-reference/programs/purchase-reward-with-points","autogeneratedByOpenApi":true},{"title":"List member order payments","description":"Lists stored `PAY_WITH_POINTS` order transactions for the program member, with cursor pagination. Filter by `id`, `card_definition_id`, and `created_at`. Order by `id` (default `-id`, newest first). Dry-run (`SIMULATED`) results aren't stored and don't appear. Returns `404` when the program or the member doesn't exist. The program is checked first.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/orders/payments","href":"/api-reference/programs/list-member-order-payments","autogeneratedByOpenApi":true},{"title":"Pay for order with points","description":"Pays for an order with points from the member's card. The amount and points come from the card definition's pay-with-points exchange ratio, limited by the order total, the card balance, card spending caps, and the optional `payment_limit`. The binding cap is returned as `details.spending_cap`.\n\nThe program and member must be `ACTIVE`, and the program must be inside its validity window. The card must belong to the member. The card definition must have pay-with-points enabled and an exchange-ratio formula. The order must already exist, identified by `id` or `source_id`.\n\nModes:\n- `TRANSACTION` (default): creates a `PENDING` order transaction and a `PENDING` card transaction. Returns `202`. The same order can be paid again; each call creates a new transaction.\n- `DRY_RUN`: simulates the payment and doesn't create a transaction. Returns `200` with status `SIMULATED`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/members/{memberId}/orders/payments","href":"/api-reference/programs/pay-for-order-with-points","autogeneratedByOpenApi":true},{"title":"List member benefit transactions","description":"Lists benefit transactions (benefit fulfillments) for a given program member, with cursor-based pagination.\n\nSupports filtering by benefit ID and creation date.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/benefits/transactions","href":"/api-reference/programs/list-member-benefit-transactions","autogeneratedByOpenApi":true},{"title":"List member tier transactions","description":"Lists tier transactions for the member: joins, leaves, upgrades, downgrades, expiration changes, and evaluation refreshes. Results use cursor pagination. Default order is `-id`, newest first.\n\nFilters are `card_id`, `card_definition_id`, and `created_at`.\n\nReturns 404 when the program doesn't exist, or when the member doesn't exist in that program. The program is checked first. A DELETED member returns 404.\n\nReturns 400 with key `invalid_query_params` when the query fails validation. That check runs before the program and member lookup. `order` must be `id` or `-id`. An array that orders by both directions is rejected. A cursor that doesn't match `^lcrsttx_[a-f0-9]+$` fails here.\n\nAfter the program and member are found, an unknown or expired cursor returns `invalid_or_expired_cursor`. A cursor recorded for different `filters` or `order` returns `cursor_and_query_mismatch`. The cursor stays valid when only `limit` changes.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/tiers/transactions","href":"/api-reference/programs/list-member-tier-transactions","autogeneratedByOpenApi":true}]},{"group":"Examine","root":{"title":"Examine: Overview","description":"Understand how the examine endpoints estimate earning opportunities and reward availability for a Loyalty v2 member without any side effects","keywords":["loyalty v2","examine earning rules","examine rewards","dry run","points estimation"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-examine-overview"},"pages":[{"title":"Examine earning rules","description":"Estimates earning opportunities for a customer without triggering any actual earning for loyalty v2 earning rules. The `trigger` selects whether all trigger events or one specific event is examined. When a specific event is selected, exactly one matching context object is required: `customer_order_paid` for `customer.order.paid`, `customer_segment_entered` for `customer.segment.entered`, and `customer_custom_event` for `customer.custom_event`. The other context objects must not be present.\n\nThis endpoint can examine earning rules for all loyalty programs the customer belongs to by using `customer_identification` with `customer_id` or `customer_source_id`. To examine earning rules only for one program, use `member_id` in `customer_identification`, as `member_id` is loyalty program-specific. A customer who exists but has no active membership returns `200` with an empty `memberships` array.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/examine/earning-rules","href":"/api-reference/examine/examine-earning-rules","autogeneratedByOpenApi":true},{"title":"Examine rewards","description":"Evaluates rewards assigned to a customer's active Loyalty v2 program memberships. Applies temporary customer and member metadata overrides without updating stored data. Returns reward availability by card, including points costs and applicable unavailability reasons. Omits a reward when it is inactive, out of stock, has no matching cost, or the member has no card for that cost.\n\nThis endpoint can examine rewards for all loyalty programs the customer belongs to by using `customer_identification` with `customer_id` or `customer_source_id`. To examine rewards only for one program, use `member_id` in `customer_identification`, as `member_id` is loyalty program-specific. A customer who exists but has no active membership returns `200` with an empty `memberships` array.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/examine/rewards","href":"/api-reference/examine/examine-rewards","autogeneratedByOpenApi":true}]},{"group":"Reports","root":{"title":"Reports: Overview","description":"Understand how Loyalty v2 report endpoints return aggregated spending, earnings, tier movements, earning-rule statistics, and finished nightly task counts for programs and members","keywords":["loyalty v2","loyalty reports","points spending","points earnings","tier reports","earning rule reports","daily tasks report"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-reports-overview"},"pages":[{"title":"List program spending daily reports","description":"Returns aggregated points-spending statistics for the program over the given date range and resolution. Each row covers one card definition and one period with recorded spending. Periods without recorded spending are omitted. Optionally filters by card definition.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/spending/daily","href":"/api-reference/programs/list-program-spending-daily-reports","autogeneratedByOpenApi":true},{"title":"List program spending summary reports","description":"Returns all-time point-spending totals for the program, one row per card definition that has recorded spending. Filters rows with `filters[card_definition_id]`. Returns at most 10 rows (max number of card definitions per program), ordered by `id` descending. `limit` and `order` are not query parameters.\n\nReturns `200` with an empty `data` array when no spending is recorded. Returns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/spending/summary","href":"/api-reference/programs/list-program-spending-summary-reports","autogeneratedByOpenApi":true},{"title":"List program daily task reports","description":"Returns counts of nightly tasks the job has already finished for the program, over the given date range and resolution. Each row covers one period with finished tasks. Periods with no finished tasks are omitted.\n\nDoes not list what is scheduled. Pending points, activation dates, and expiration dates that are still waiting do not appear. A count is stored on the date the job finishes the task. Tasks finished before this report existed are not included.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/daily-tasks/daily","href":"/api-reference/programs/list-program-daily-task-reports","autogeneratedByOpenApi":true},{"title":"List program tiers daily reports","description":"Returns aggregated tier-movement statistics for the program over the given date range and resolution, optionally filtered by tier structure and tier. Each row covers one tier structure, one tier, and one period with recorded movement. Periods without recorded movement are omitted. A filter that matches no rows returns an empty `data` array.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/tiers/daily","href":"/api-reference/programs/list-program-tiers-daily-reports","autogeneratedByOpenApi":true},{"title":"List program tiers summary reports","description":"Returns all-time tier-movement totals for the program, one row per tier structure and tier that has recorded movement. Filters rows with `filters[tier_structure_id]` and `filters[tier_id]`. Returns at most 100 rows, ordered by `id` descending. `limit` and `order` are not query parameters. A filter that matches no rows returns an empty `data` array.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/tiers/summary","href":"/api-reference/programs/list-program-tiers-summary-reports","autogeneratedByOpenApi":true},{"title":"List program points-earnings daily reports","description":"Returns aggregated daily points-earnings statistics for the program over the given date range and resolution, optionally filtered by earning rule and card definition. Each entry sums earning operations recorded for one period, earning rule, earning item, and card definition. Periods without recorded activity are omitted. A filter that matches no rows returns an empty `data` array.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/points-earnings/daily","href":"/api-reference/programs/list-program-points-earnings-daily-reports","autogeneratedByOpenApi":true},{"title":"List program points-earnings summary reports","description":"Returns total points-earnings statistics for the program (all time), optionally filtered by earning rule or card definition. Each entry sums earning operations for one earning rule, earning item, and card definition. Returns at most 100 rows, ordered by `id` descending. `limit` and `order` are not query parameters. A filter that matches no rows returns an empty `data` array.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/points-earnings/summary","href":"/api-reference/programs/list-program-points-earnings-summary-reports","autogeneratedByOpenApi":true},{"title":"List program earning-rules daily reports","description":"Returns aggregated daily earning-rule evaluation statistics for the program over the given date range and resolution, optionally filtered by earning rule. Each entry counts eligibility checks for one period and earning rule. Periods without recorded activity are omitted. `failures_breakdown` is always an empty object. A filter that matches no rows returns an empty `data` array.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/earning-rules/daily","href":"/api-reference/programs/list-program-earning-rules-daily-reports","autogeneratedByOpenApi":true},{"title":"List program earning-rules summary reports","description":"Returns total earning-rule evaluation statistics for the program (all time), optionally filtered by earning rule. Includes success and failure counts with a failures breakdown. Each entry counts eligibility checks for one earning rule. Returns at most 100 rows, ordered by `id` descending. `limit` and `order` are not query parameters. A filter that matches no rows returns an empty `data` array.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/earning-rules/summary","href":"/api-reference/programs/list-program-earning-rules-summary-reports","autogeneratedByOpenApi":true},{"title":"List program rewards daily reports","description":"Returns aggregated reward-purchase statistics for the program over the given date range and resolution, optionally filtered by reward. Each row covers one reward and one period with recorded purchases. Periods without recorded purchases are omitted. `failures_breakdown` is always an empty object. A filter that matches no rows returns an empty `data` array.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/rewards/daily","href":"/api-reference/programs/list-program-rewards-daily-reports","autogeneratedByOpenApi":true},{"title":"List program rewards summary reports","description":"Returns all-time reward-purchase totals for the program, one row per reward with a recorded purchase attempt. Filters rows with `filters[reward_id]`. Returns at most 100 rows, ordered by `id` descending. `limit` and `order` are not query parameters. A filter that matches no rows returns an empty `data` array.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/rewards/summary","href":"/api-reference/programs/list-program-rewards-summary-reports","autogeneratedByOpenApi":true},{"title":"List program rewards spendings daily reports","description":"Returns aggregated points spent on reward purchases for the program over the given date range and resolution. Each row covers one reward, reward cost, reward spending, card definition, and period with an approved point spend. Periods without an approved point spend are omitted. Optionally filters by reward, cost, spending, and card definition. A filter that matches no rows returns an empty `data` array.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/rewards/spendings/daily","href":"/api-reference/programs/list-program-rewards-spendings-daily-reports","autogeneratedByOpenApi":true},{"title":"List program rewards spendings summary reports","description":"Returns all-time points spent on reward purchases for the program. Each row covers one reward, reward cost, reward spending, and card definition with an approved point spend. Filters rows by reward, cost, spending, and card definition. Returns at most 100 rows, ordered by `id` descending. `limit` and `order` are not query parameters. A filter that matches no rows returns an empty `data` array.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/rewards/spendings/summary","href":"/api-reference/programs/list-program-rewards-spendings-summary-reports","autogeneratedByOpenApi":true},{"title":"List program members daily reports","description":"Returns member and card changes for the program over the given date range and resolution. Each row covers one period with recorded activity. Periods without activity are omitted.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/members/daily","href":"/api-reference/programs/list-program-members-daily-reports","autogeneratedByOpenApi":true},{"title":"List program members summary reports","description":"Returns all-time member and card totals for the program. The response contains one row when activity was recorded, and an empty `data` array otherwise. `limit` and `order` are not query parameters.\n\nReturns `400` when query validation fails. Returns `404` when the program does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/reports/members/summary","href":"/api-reference/programs/list-program-members-summary-reports","autogeneratedByOpenApi":true},{"title":"List card daily points reports","description":"Returns aggregated points statistics for a member's loyalty card over the given date range and resolution. Each entry sums the point operations recorded in one period. Periods without recorded activity are omitted.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program or member does not exist, or when the card does not exist or is not assigned to the member in the program.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/cards/{cardId}/reports/daily","href":"/api-reference/programs/list-card-daily-points-reports","autogeneratedByOpenApi":true},{"title":"List member earning-rule daily reports","description":"Returns aggregated daily usage statistics for a specific earning rule and member over the given date range and resolution. Each entry sums successful earning-rule triggers recorded in one period. Periods without recorded activity are omitted.\n\nThe date range is limited per resolution:\n- 90 days for `day`,\n- 12 weeks for `week`,\n- 12 months for `month`,\n- 4 quarters for `quarter`,\n- `start_date` must be before `end_date`,\n- `start_date` and `end_date` are inclusive.\n\nReturns `400` when query validation fails. Returns `404` when the program or member does not exist, or when the earning rule does not exist or is not assigned to the program.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/members/{memberId}/earning-rules/{earningRuleId}/reports/daily","href":"/api-reference/programs/list-member-earning-rule-daily-reports","autogeneratedByOpenApi":true}]},{"group":"Card definitions","root":{"title":"Card definitions: Overview","description":"Understand how card definitions configure the loyalty cards (point wallets) that store and govern a member's points in Loyalty v2","keywords":["loyalty v2","card definitions","point wallets","points expiration","earning limits","spending limits"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-card-definitions-overview"},"pages":[{"title":"List Card Definitions","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of card definitions.\n\nFiltering is supported through the `filters` deep-object query parameter,\ne.g. `filters[name][conditions][$is]=Standard%20Card`.\nThe same field cannot be requested in both ascending and descending\norder at the same time.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/card-definitions","href":"/api-reference/card-definitions/list-card-definitions","autogeneratedByOpenApi":true},{"title":"Create Card Definition","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nCreates a new card definition. Only `name` and `type` are required; all other\nsections default server-side as follows:\n- `code_config`: 10-character alphanumeric code pattern (`##########`)\n- `points_expiration`: `NO_EXPIRATION`\n- `pending_points`: `IMMEDIATE`\n- `earning_limits`: global `NO_LIMIT`, transactions `NO_LIMIT`\n- `spending_limits`: global `NO_LIMIT`, transactions `NO_LIMIT`\n- `refunds`: spent points `NONE`, earned points `NONE`\n- `balance_settings`: `allow_negative: false`\n- `pay_with_points`: `NO_PAYMENTS`\n\nCross-field rules:\n- `balance_settings.allow_negative` can only be `true` when `points_expiration.type`\n is `NO_EXPIRATION`. Additionally, the earned points refund mode `REVOKE_BELOW_ZERO`\n requires `balance_settings.allow_negative` to be `true`.\n- The earned points refund method `REVOKE_FROM_PENDING` requires\n `pending_points.type` to be one of `PERIOD_BASED`, `FIXED_DATES`, `EVENT_BASED`.\n\nA successful call records [`vl.card_definition.created`](/api-reference/loyalty-activity/card-definitions/created).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/card-definitions","href":"/api-reference/card-definitions/create-card-definition","autogeneratedByOpenApi":true},{"title":"Get Card Definition","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a single card definition by its ID.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/card-definitions/{cardDefinitionId}","href":"/api-reference/card-definitions/get-card-definition","autogeneratedByOpenApi":true},{"title":"Update Card Definition","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nUpdates a card definition. All properties are optional; only provided sections\nare updated. `type` and `status` cannot be changed through this endpoint\n(status transitions are performed via the activate/draft endpoints).\n\nWhen the card definition is in use (e.g. assigned to a program with existing cards),\nupdates to restricted sections may be rejected with a resource-locked error;\nonly `name`, `metadata` and `pay_with_points` are always updatable.\n\nA successful call records [`vl.card_definition.updated`](/api-reference/loyalty-activity/card-definitions/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/card-definitions/{cardDefinitionId}","href":"/api-reference/card-definitions/update-card-definition","autogeneratedByOpenApi":true},{"title":"Delete Card Definition","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nDeletes a card definition by setting `status` to `DELETED`. Returns the deleted card definition. Returns `400` (`resource_in_use`) when a program, reward, earning rule, tier structure, or benefit still references the card definition.\n\nA successful call records [`vl.card_definition.deleted`](/api-reference/loyalty-activity/card-definitions/deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/card-definitions/{cardDefinitionId}","href":"/api-reference/card-definitions/delete-card-definition","autogeneratedByOpenApi":true},{"title":"Activate Card Definition","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nTransitions the card definition from `DRAFT` to `ACTIVE`. No request body. Activating from any other state returns `400` (`invalid_state_transition`).\n\nA successful call records [`vl.card_definition.activated`](/api-reference/loyalty-activity/card-definitions/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/card-definitions/{cardDefinitionId}/activate","href":"/api-reference/card-definitions/activate-card-definition","autogeneratedByOpenApi":true},{"title":"Draft Card Definition","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nTransitions the card definition from `ACTIVE` to `DRAFT`. No request body. Drafting from any other state returns `400` (`invalid_state_transition`). Returns `423` when the card definition is still used by a non-draft program (`connected_non_draft_program`), reward (`connected_non_draft_reward`), earning rule (`connected_non_draft_earning_rule`), benefit (`connected_non_draft_benefit`), or tier structure (`connected_non_draft_tier_structure`).\n\nA successful call records [`vl.card_definition.drafted`](/api-reference/loyalty-activity/card-definitions/drafted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/card-definitions/{cardDefinitionId}/draft","href":"/api-reference/card-definitions/draft-card-definition","autogeneratedByOpenApi":true},{"title":"List Card Definition Activities","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of activities recorded for the card definition\n(creation, updates, deletion, state transitions and program assignments).\nReturns `404` when the card definition does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/card-definitions/{cardDefinitionId}/activities","href":"/api-reference/card-definitions/list-card-definition-activities","autogeneratedByOpenApi":true}]},{"group":"Programs","root":{"title":"Programs: Overview","description":"Understand how a Loyalty v2 program connects card definitions, earning rules, tier structures, and rewards into one customer-facing loyalty setup","keywords":["loyalty v2","loyalty programs","program assignments","loyalty hub"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-programs-overview"},"pages":[{"title":"List programs","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of loyalty programs. Supports filtering by `id`, `name`,\n`status` and `created_at`. The same field cannot be used in both ascending and descending\norder at once.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs","href":"/api-reference/programs/list-programs","autogeneratedByOpenApi":true},{"title":"Create program","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nCreates a new loyalty program. The program can be created with status `DRAFT` (default) or\n`ACTIVE`. When created as `ACTIVE`, the program must be connected to at least one active\ncard definition and at least one active earning rule (provided via `card_definitions` and\n`earning_rules` arrays), otherwise the request is rejected with `423 Locked`\n(keys `missing_active_card_definition` / `missing_active_earning_rule`).\nOptionally assigns card definitions, earning rules, rewards and tier structures in the same request.\n\nA successful call records [`vl.program.created`](/api-reference/loyalty-activity/programs/created), and for each card definition in the body [`vl.card_definition.assigned`](/api-reference/loyalty-activity/card-definitions/assigned) and [`vl.program.card_definition.assigned`](/api-reference/loyalty-activity/programs/card-definition-assigned), for each earning rule [`vl.earning_rule.assigned`](/api-reference/loyalty-activity/earning-rules/assigned) and [`vl.program.earning_rule.assigned`](/api-reference/loyalty-activity/programs/earning-rule-assigned), for each tier structure [`vl.tier_structure.assigned`](/api-reference/loyalty-activity/tier-structures/assigned) and [`vl.program.tier_structure.assigned`](/api-reference/loyalty-activity/programs/tier-structure-assigned), and for each reward [`vl.reward.assigned`](/api-reference/loyalty-activity/rewards/assigned) and [`vl.program.reward.assigned`](/api-reference/loyalty-activity/programs/reward-assigned).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs","href":"/api-reference/programs/create-program","autogeneratedByOpenApi":true},{"title":"Get program","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a single loyalty program by its ID.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}","href":"/api-reference/programs/get-program","autogeneratedByOpenApi":true},{"title":"Update program","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nUpdates a loyalty program. When the program is not in `DRAFT` status, only `name`, `end_date`, and `metadata` may be changed.\n\nA successful call records [`vl.program.updated`](/api-reference/loyalty-activity/programs/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/programs/{programId}","href":"/api-reference/programs/update-program","autogeneratedByOpenApi":true},{"title":"Delete program","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nSoft-deletes a loyalty program and removes all of its card definition, earning rule,\nreward and tier structure assignments.\n\nA successful call records [`vl.program.deleted`](/api-reference/loyalty-activity/programs/deleted), and for each existing card-definition assignment [`vl.card_definition.unassigned`](/api-reference/loyalty-activity/card-definitions/unassigned) and [`vl.program.card_definition.unassigned`](/api-reference/loyalty-activity/programs/card-definition-unassigned), for each earning-rule assignment [`vl.earning_rule.unassigned`](/api-reference/loyalty-activity/earning-rules/unassigned) and [`vl.program.earning_rule.unassigned`](/api-reference/loyalty-activity/programs/earning-rule-unassigned), for each tier-structure assignment [`vl.tier_structure.unassigned`](/api-reference/loyalty-activity/tier-structures/unassigned) and [`vl.program.tier_structure.unassigned`](/api-reference/loyalty-activity/programs/tier-structure-unassigned), and for each reward assignment [`vl.reward.unassigned`](/api-reference/loyalty-activity/rewards/unassigned) and [`vl.program.reward.unassigned`](/api-reference/loyalty-activity/programs/reward-unassigned).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/programs/{programId}","href":"/api-reference/programs/delete-program","autogeneratedByOpenApi":true},{"title":"Activate program","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nTransitions the program to `ACTIVE` status. Allowed transitions to `ACTIVE` are from\n`DRAFT` and `INACTIVE`. Before activation the program's card definition, earning rule\nand tier structure assignments are validated (at least one active card definition and\nearning rule is required). An invalid state transition is rejected with `400`\n(key `invalid_state_transition`). No request body.\n\nA successful call records [`vl.program.activated`](/api-reference/loyalty-activity/programs/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/activate","href":"/api-reference/programs/activate-program","autogeneratedByOpenApi":true},{"title":"Deactivate program","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nTransitions the program to `INACTIVE` status. Only an `ACTIVE` program can be deactivated.\nAn invalid state transition is rejected with `400` (key `invalid_state_transition`).\nNo request body.\n\nA successful call records [`vl.program.deactivated`](/api-reference/loyalty-activity/programs/deactivated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/deactivate","href":"/api-reference/programs/deactivate-program","autogeneratedByOpenApi":true},{"title":"List program activities","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of activities recorded for a program (created, updated,\ndeleted, activated, deactivated and assignment changes). Supports filtering by activity\n`id`, `type` and `created_at`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/activities","href":"/api-reference/programs/list-program-activities","autogeneratedByOpenApi":true},{"title":"List program card definition assignments","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of card definitions assigned to the program.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/card-definitions","href":"/api-reference/programs/list-program-card-definition-assignments","autogeneratedByOpenApi":true},{"title":"Batch assign/unassign card definitions","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nAssigns and/or unassigns card definitions to/from a program in a single batch.\nUnassign operations are processed before assign operations.\nThe program must be in `DRAFT` status - otherwise the request is rejected with\n`423 Locked` (key `non_draft_program`). In strict mode (default) missing card\ndefinitions, inactive card definitions or missing assignments cause the whole\nbatch to fail.\n\nA successful call records [`vl.card_definition.assigned`](/api-reference/loyalty-activity/card-definitions/assigned) and [`vl.program.card_definition.assigned`](/api-reference/loyalty-activity/programs/card-definition-assigned) for each card definition it assigns, and [`vl.card_definition.unassigned`](/api-reference/loyalty-activity/card-definitions/unassigned) and [`vl.program.card_definition.unassigned`](/api-reference/loyalty-activity/programs/card-definition-unassigned) for each one it unassigns.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/card-definitions/batch","href":"/api-reference/programs/batch-assignunassign-card-definitions","autogeneratedByOpenApi":true},{"title":"List program earning rule assignments","description":"Returns a cursor-paginated list of earning rules assigned to the program.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/earning-rules","href":"/api-reference/programs/list-program-earning-rule-assignments","autogeneratedByOpenApi":true},{"title":"Batch assign/unassign earning rules","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nAssigns and/or unassigns earning rules to/from a program in a single batch.\nUnassign operations are processed before assign operations. When the program is\n`ACTIVE`, the batch is validated to leave at least one active earning rule assigned.\nIn strict mode (default) missing earning rules or missing assignments cause the whole\nbatch to fail.\n\nA successful call records [`vl.earning_rule.assigned`](/api-reference/loyalty-activity/earning-rules/assigned) and [`vl.program.earning_rule.assigned`](/api-reference/loyalty-activity/programs/earning-rule-assigned) for each earning rule it assigns, and [`vl.earning_rule.unassigned`](/api-reference/loyalty-activity/earning-rules/unassigned) and [`vl.program.earning_rule.unassigned`](/api-reference/loyalty-activity/programs/earning-rule-unassigned) for each one it unassigns.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/earning-rules/batch","href":"/api-reference/programs/batch-assignunassign-earning-rules","autogeneratedByOpenApi":true},{"title":"List program tier structure assignments","description":"Returns a cursor-paginated list of tier structures assigned to the program. Currently, a program can have only one tier structure assigned.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/tier-structures","href":"/api-reference/programs/list-program-tier-structure-assignments","autogeneratedByOpenApi":true},{"title":"Batch assign/unassign tier structures","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nAssigns and/or unassigns tier structures to/from a program in a single batch.\nUnassign operations are processed before assign operations. Unassigning is only\nallowed while the program is in `DRAFT` status - otherwise the request is rejected\nwith `423 Locked` (key `non_draft_program`). A program can have at most one tier\nstructure assigned. In strict mode (default) missing tier structures, inactive tier\nstructures or missing assignments cause the whole batch to fail.\n\nA successful call records [`vl.tier_structure.assigned`](/api-reference/loyalty-activity/tier-structures/assigned) and [`vl.program.tier_structure.assigned`](/api-reference/loyalty-activity/programs/tier-structure-assigned) for each tier structure it assigns, and [`vl.tier_structure.unassigned`](/api-reference/loyalty-activity/tier-structures/unassigned) and [`vl.program.tier_structure.unassigned`](/api-reference/loyalty-activity/programs/tier-structure-unassigned) for each one it unassigns.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/tier-structures/batch","href":"/api-reference/programs/batch-assignunassign-tier-structures","autogeneratedByOpenApi":true},{"title":"List program reward assignments","description":"Returns a cursor-paginated list of rewards assigned to the program, including their stock configuration and redemption counters.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/programs/{programId}/rewards","href":"/api-reference/programs/list-program-reward-assignments","autogeneratedByOpenApi":true},{"title":"Batch assign/unassign rewards","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nAssigns and/or unassigns rewards to/from a program in a single batch.\nUnassign operations are processed before assign operations. Each reward to assign\nmust include its `stock` configuration. In strict mode (default) missing rewards\nor missing assignments cause the whole batch to fail (`404 Not Found`).\n\nA successful call records [`vl.reward.assigned`](/api-reference/loyalty-activity/rewards/assigned) and [`vl.program.reward.assigned`](/api-reference/loyalty-activity/programs/reward-assigned) for each reward it assigns, and [`vl.reward.unassigned`](/api-reference/loyalty-activity/rewards/unassigned) and [`vl.program.reward.unassigned`](/api-reference/loyalty-activity/programs/reward-unassigned) for each one it unassigns.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/rewards/batch","href":"/api-reference/programs/batch-assignunassign-rewards","autogeneratedByOpenApi":true},{"title":"Update program reward assignment","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nUpdates the stock configuration of a reward assigned to a program.\nReturns the updated reward assignment.\n\nA successful call records [`vl.program.reward.updated`](/api-reference/loyalty-activity/programs/reward-updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/programs/{programId}/rewards/{rewardId}","href":"/api-reference/programs/update-program-reward-assignment","autogeneratedByOpenApi":true},{"title":"Refund reward purchase","description":"Refunds an `APPROVED` reward purchase made by a program member. The purchase transaction is marked `REFUNDED`, a new `REFUND` reward transaction is created with status `APPROVED`, and the points spent on the purchase are returned to the member's card.\n\nThe request body is optional and an empty payload is allowed. Policies default to `refund: DEFAULT` and `stock: DEFAULT`.\n\nThe endpoint responds with `202` before the card balance changes. A `POINTS_RETURNED` card transaction is created for the member's card and processed shortly after the response. When the member's tier or the card definition expires points, returned points receive a new expiration date from that setting. They don't inherit the expiration of the originally spent points. A `NO_EXPIRATION` setting leaves the returned points without an expiration date. Card earning limits don't block the refund.\n\nFor a legacy `LOYALTY_CARD_POINTS` reward, the points credited to the target card are also reversed, with a `POINTS_PURCHASE_REVERSED` card transaction on that card. That transaction is processed shortly after the response. Its expiration is copied from the original points-purchased transaction.\n\nA `DISCOUNT_COUPONS` refund deletes the issued vouchers. `details.result.digital.discount_coupons[].result` is `DELETED`, or `SKIPPED` when the voucher isn't deleted. A `GIFT_VOUCHERS` refund subtracts the credited amount. `details.result.digital.gift_vouchers[].result` is `CREDITS_SUBTRACTED`, or `SKIPPED` when the balance update is rejected.\n\nThe refund reverses that purchase in the reward's purchase limits for the project-local day of the original purchase. A day whose purchases are all refunded no longer counts as the member's last purchase.\n\nOnly rewards whose `refunds.type` is `REFUNDABLE` can be refunded. Any other reward is rejected with `423` and key `reward_refund_policy_does_not_allow_refunds`. `policies.refund` set to `ALLOW` refunds it anyway.\n\nThe program must exist, and the reward transaction must belong to that program. Otherwise the request fails with `404`. The program is checked first. The request is rejected with `423` when:\n- The program isn't `ACTIVE` (`non_active_program`) or is outside its validity window (`program_outside_validity_window`),\n- The transaction isn't a purchase (`non_purchase_reward_transaction`) or isn't `APPROVED` (`non_approved_reward_transaction`); refunding the same purchase twice fails here,\n- The reward no longer exists (`reward_not_found`), isn't assigned to the program (`refund_reward_not_assigned_to_program`), the member's card is gone (`refund_card_not_found`), or the card definition is gone (`refund_card_definition_not_found`),\n- The reward type isn't supported (`reward_type_not_supported_for_refunds`),\n- For a legacy `LOYALTY_CARD_POINTS` reward, the purchase result is missing (`loyalty_card_points_purchase_result_not_found`), the target card is gone (`loyalty_card_points_target_card_not_found`), the points-purchased card transaction is missing (`loyalty_card_points_purchase_not_found`), the target card's available balance is lower than the purchased points (`loyalty_card_points_insufficient_balance`), or the target card definition is gone (`loyalty_card_points_target_card_definition_not_found`).\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/programs/{programId}/rewards/purchases/{rewardTransactionId}/refund","href":"/api-reference/programs/refund-reward-purchase","autogeneratedByOpenApi":true}]},{"group":"Earning rules","root":{"title":"Earning rules: Overview","description":"Understand how earning rules define when and how Loyalty v2 members earn points or receive benefits","keywords":["loyalty v2","earning rules","triggers","trigger limits","earning limits","points"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-earning-rules-overview"},"pages":[{"title":"List earning rules","description":"Returns a cursor-paginated list of earning rules. Rules with status `DELETED` are excluded. The same field cannot be used\nin both ascending and descending order at once\n(e.g. `order=name\u0026order=-name` is rejected). Default order is `-created_at`;\n`id` is always appended as a tie-breaker.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/earning-rules","href":"/api-reference/earning-rules/list-earning-rules","autogeneratedByOpenApi":true},{"title":"Create earning rule","description":"Creates a new earning rule.\n\nWhen `status` is omitted the rule is created as `DRAFT`. Omitted or `null` `validity_hours` default to `{ \"type\": \"ANY_TIME\" }`, `trigger_limits` to `{ \"cooldown\": { \"type\": \"NO_COOLDOWN\" }, \"frequency\": { \"type\": \"NO_LIMIT\" } }`, and `earning_limits` to `{ \"global\": { \"type\": \"NO_LIMIT\", \"limits\": [] } }`. An `ACTIVE` rule whose trigger is `customer.segment.entered` activates a passive segment. Returns `423` when `status` is `ACTIVE` and an effect or tier rule points at a non-active benefit, card definition, or tier structure.\n\nA successful call records [`vl.earning_rule.created`](/api-reference/loyalty-activity/earning-rules/created).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/earning-rules","href":"/api-reference/earning-rules/create-earning-rule","autogeneratedByOpenApi":true},{"title":"Get earning rule","description":"Returns a single earning rule by its ID.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/earning-rules/{earningRuleId}","href":"/api-reference/earning-rules/get-earning-rule","autogeneratedByOpenApi":true},{"title":"Update earning rule","description":"Updates an earning rule. Each field is optional, and the body must include at least one field. `status` cannot be changed here. Use [Activate earning rule](/api-reference/earning-rules/activate-earning-rule), [Deactivate earning rule](/api-reference/earning-rules/deactivate-earning-rule), or [Move earning rule to draft](/api-reference/earning-rules/move-earning-rule-to-draft). Sending `status` returns `400`.\n\nWhen the earning rule is `ACTIVE` or `INACTIVE`, only `name`, `earnings`, `error`, `validity_hours`, `start_date`, `end_date`, `trigger_limits`, `earning_limits`, and `metadata` can change. A `DRAFT` rule can also change `trigger`.\n\n`earnings` replaces the earning list. An item whose `id` matches a stored `lernei_` id replaces that item. An omitted `id`, or an `id` that is not on this rule, creates an item and the server assigns the ID. Items left out of the array are removed. On an `ACTIVE` rule, the earnings that will be stored are checked for inactive or unassigned related resources and can return `423`.\n\nA successful call records [`vl.earning_rule.updated`](/api-reference/loyalty-activity/earning-rules/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/earning-rules/{earningRuleId}","href":"/api-reference/earning-rules/update-earning-rule","autogeneratedByOpenApi":true},{"title":"Delete earning rule","description":"Deletes an earning rule by setting `status` to `DELETED` and returns the deleted earning rule. Returns `400` (`resource_in_use`) when a program still references the earning rule.\n\nA successful call records [`vl.earning_rule.deleted`](/api-reference/loyalty-activity/earning-rules/deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/earning-rules/{earningRuleId}","href":"/api-reference/earning-rules/delete-earning-rule","autogeneratedByOpenApi":true},{"title":"Activate earning rule","description":"Moves the earning rule to `ACTIVE` from `DRAFT` or `INACTIVE`. No request body. Effect and tier rule checks run before the status check, so a rule that is already `ACTIVE` can return `423`, `404`, or `400` (`invalid_points_expiration_override`, `invalid_benefit_calculation_type`, `invalid_tier_structure_relation`) before `invalid_state_transition`.\n\nA successful call records [`vl.earning_rule.activated`](/api-reference/loyalty-activity/earning-rules/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/earning-rules/{earningRuleId}/activate","href":"/api-reference/earning-rules/activate-earning-rule","autogeneratedByOpenApi":true},{"title":"Deactivate earning rule","description":"Moves the earning rule from `ACTIVE` to `INACTIVE`. No request body. Any other status returns `400` (`invalid_state_transition`).\n\nA successful call records [`vl.earning_rule.deactivated`](/api-reference/loyalty-activity/earning-rules/deactivated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/earning-rules/{earningRuleId}/deactivate","href":"/api-reference/earning-rules/deactivate-earning-rule","autogeneratedByOpenApi":true},{"title":"List earning rule activities","description":"Returns a cursor-paginated list of activities (audit trail) for a single earning rule.\n\nA deleted earning rule returns `404`, so its activities are not listed.\n\nThe same field cannot be used in both ascending and descending order at once.\n\nDefault order is `-created_at`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/earning-rules/{earningRuleId}/activities","href":"/api-reference/earning-rules/list-earning-rule-activities","autogeneratedByOpenApi":true}]},{"group":"Tier structures","root":{"title":"Tier structures: Overview","description":"Understand how tier structures define the tiering model that determines how Loyalty v2 members qualify for and move between tiers","keywords":["loyalty v2","tier structures","loyalty tiers","point balance","point earned"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-tier-structures-overview"},"pages":[{"title":"List tier structures","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of tier structures. The same field cannot be\nrequested in both ascending and descending order at once. Default order is\n`-created_at`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/tier-structures","href":"/api-reference/tier-structures/list-tier-structures","autogeneratedByOpenApi":true},{"title":"Create tier structure","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nCreates a new tier structure. Depending on `type`, either\n`point_balance` (for `POINT_BALANCE`) or `point_earned` (for `POINT_EARNED`)\nis required and the other must be null/omitted. If `expiration` is omitted it\ndefaults to `{ \"type\": \"NO_RETENTION\" }`; if `downgrade` is omitted it defaults\nto `{ \"type\": \"NO_DOWNGRADE\" }`; if `status` is omitted it defaults to `DRAFT`.\n\nA successful call records [`vl.tier_structure.created`](/api-reference/loyalty-activity/tier-structures/created).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/tier-structures","href":"/api-reference/tier-structures/create-tier-structure","autogeneratedByOpenApi":true},{"title":"Get tier structure","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a single tier structure by its ID.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/tier-structures/{tierStructureId}","href":"/api-reference/tier-structures/get-tier-structure","autogeneratedByOpenApi":true},{"title":"Update tier structure","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nUpdates a tier structure. All properties are optional; provided\nvalues are merged with the existing tier structure. When `type` is provided as\n`POINT_EARNED`, `point_earned` is required and `point_balance` must be null; when\n`type` is `POINT_BALANCE`, `point_balance` is required and `point_earned` must be null.\nWhen the tier structure is not in `DRAFT` status, only `name` and `metadata` may be\nupdated; attempting to update other properties results in a validation error.\n\nA successful call records [`vl.tier_structure.updated`](/api-reference/loyalty-activity/tier-structures/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/tier-structures/{tierStructureId}","href":"/api-reference/tier-structures/update-tier-structure","autogeneratedByOpenApi":true},{"title":"Delete tier structure","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nDeletes a tier structure by deleting its tiers and setting `status` to `DELETED`, then returns the deleted tier structure. Returns `400` (`resource_in_use`) when a program, earning rule, or reward still references the tier structure.\n\nA successful call records [`vl.tier_structure.deleted`](/api-reference/loyalty-activity/tier-structures/deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/tier-structures/{tierStructureId}","href":"/api-reference/tier-structures/delete-tier-structure","autogeneratedByOpenApi":true},{"title":"Activate tier structure","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nMoves the tier structure to `ACTIVE` from `DRAFT` or `INACTIVE`. No request body. Any other status returns `400` (`invalid_state_transition`). Returns `403` (`tier_structure_assignments_limit_exceeded`) when a program already has another `DRAFT` or `ACTIVE` tier structure assigned.\n\nA successful call records [`vl.tier_structure.activated`](/api-reference/loyalty-activity/tier-structures/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/tier-structures/{tierStructureId}/activate","href":"/api-reference/tier-structures/activate-tier-structure","autogeneratedByOpenApi":true},{"title":"Move tier structure to draft","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nMoves the tier structure from `ACTIVE` to `DRAFT`. No request body. Any other status returns `400` (`invalid_state_transition`). Returns `423` when a non-draft program (`connected_non_draft_program`) or an active reward (`connected_active_reward`) still uses the tier structure.\n\nA successful call records [`vl.tier_structure.drafted`](/api-reference/loyalty-activity/tier-structures/drafted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/tier-structures/{tierStructureId}/draft","href":"/api-reference/tier-structures/move-tier-structure-to-draft","autogeneratedByOpenApi":true},{"title":"List tiers","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of tiers belonging to the tier structure. This\nendpoint does not support a `filters` parameter. The same field cannot be requested\nin both ascending and descending order at once. Default order is `-created_at`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/tier-structures/{tierStructureId}/tiers","href":"/api-reference/tier-structures/list-tiers","autogeneratedByOpenApi":true},{"title":"Delete tier","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nDeletes a tier by marking it deleted and returns the deleted tier. Returns `400` (`resource_in_use`) when an earning rule or a reward still references the tier.\n\nA successful call records [`vl.tier_structure.tier.deleted`](/api-reference/loyalty-activity/tier-structures/tier-deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/tier-structures/{tierStructureId}/tiers/{tierId}","href":"/api-reference/tier-structures/delete-tier","autogeneratedByOpenApi":true},{"title":"List tier structure activities","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of activities recorded for the tier structure\n(creation, updates, state transitions, assignments, and nested tier changes).\nThe same field cannot be requested in both ascending and descending order at once.\nDefault order is `-created_at`.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/tier-structures/{tierStructureId}/activities","href":"/api-reference/tier-structures/list-tier-structure-activities","autogeneratedByOpenApi":true}]},{"group":"Benefits","root":{"title":"Benefits overview","description":"Understand how benefits let Loyalty v2 earning rules grant points, material items, or digital incentives automatically","keywords":["loyalty v2","benefits","earning rule benefits","material rewards","digital rewards"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-benefits-overview"},"pages":[{"title":"List benefits","description":"Returns a cursor-paginated list of benefits. Supports filtering by `id`, `name`, `status`, `type`, and `created_at`, ordering by `created_at`, `name`, and `type` (prefix with `-` for descending), and cursor-based pagination. Deleted benefits are excluded. Multiple filters are combined with the `junction` (`AND` by default). The same field cannot be ordered both ascending and descending at the same time.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/benefits","href":"/api-reference/benefits/list-benefits","autogeneratedByOpenApi":true},{"title":"Create benefit","description":"Creates a new benefit. Exactly one type-specific configuration object (`points`, `points_proportional`, `material`, or `digital`) is required, matching the `type`.\n\nWhen `status` is omitted the benefit is created in `DRAFT` status. When `stock` is omitted, it defaults to `{ \"type\": \"UNLIMITED\" }`.\n\nReferenced resources are validated: the card definition (for points-based types) must exist and - when creating with `status: ACTIVE` - must be ACTIVE (423 `non_active_card_definition` otherwise); the product/SKU (for `MATERIAL`) and campaign (for `DIGITAL`) must exist; the campaign type must match the digital benefit type (`DISCOUNT_COUPONS` or `GIFT_VOUCHERS`, 400 `invalid_campaign_type` otherwise); and when creating with `status: ACTIVE`, the campaign must not be a draft (423 `non_active_campaign` otherwise).\n\nA successful call records [`vl.benefit.created`](/api-reference/loyalty-activity/benefits/created).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/benefits","href":"/api-reference/benefits/create-benefit","autogeneratedByOpenApi":true},{"title":"Get benefit","description":"Returns a single benefit by its ID.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/benefits/{benefitId}","href":"/api-reference/benefits/get-benefit","autogeneratedByOpenApi":true},{"title":"Update benefit","description":"Updates the benefit fields in the body. The body must contain at least one of `name`, `type`, `points`, `points_proportional`, `material`, `digital`, or `stock`. This operation does not change `status`.\n\nIn `DRAFT` status, any of these fields may be sent. In `ACTIVE` status, the body may contain only `name`, `stock`, `points`, `points_proportional`, and `digital`. On an `ACTIVE` benefit, `points.card_definition_id`, `points_proportional.calculation_type`, `points_proportional.card_definition_id`, `digital.type`, and `digital.gift_vouchers.campaign_id` cannot change. `digital` cannot be sent for an `ACTIVE` `DISCOUNT_COUPONS` benefit.\n\nA `POINTS` or `POINTS_PROPORTIONAL` benefit requires an `ACTIVE` card definition in `DRAFT` and `ACTIVE` status (`423` `non_active_card_definition`). An `ACTIVE` digital benefit cannot use a `DRAFT` campaign (`423` `non_active_campaign`).\n\nA successful call records [`vl.benefit.updated`](/api-reference/loyalty-activity/benefits/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/benefits/{benefitId}","href":"/api-reference/benefits/update-benefit","autogeneratedByOpenApi":true},{"title":"Delete benefit","description":"Deletes a benefit by setting `status` to `DELETED` and returns the deleted benefit. A benefit that is used by any earning rule cannot be deleted (400 `resource_in_use`, with `related_object_ids` and `related_object_type: earning_rule` in the error body).\n\nA successful call records [`vl.benefit.deleted`](/api-reference/loyalty-activity/benefits/deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/benefits/{benefitId}","href":"/api-reference/benefits/delete-benefit","autogeneratedByOpenApi":true},{"title":"Activate benefit","description":"Moves a benefit from `DRAFT` to `ACTIVE` status. The request has no body.\n\nRelated resources are checked before the status changes:\n- A `POINTS` benefit requires `points.card_definition_id` to be `ACTIVE`. Otherwise returns `423` `non_active_card_definition`.\n- A digital benefit cannot reference a `DRAFT` campaign. Otherwise returns `423` `non_active_campaign`.\n\nA benefit that is not `DRAFT` returns `400` `invalid_state_transition`, unless one of these checks fails first.\n\nA successful call records [`vl.benefit.activated`](/api-reference/loyalty-activity/benefits/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/benefits/{benefitId}/activate","href":"/api-reference/benefits/activate-benefit","autogeneratedByOpenApi":true},{"title":"List benefit activities","description":"Returns a cursor-paginated list of activities recorded for the benefit (created, updated, deleted, activated, drafted). Returns `404` when the benefit does not exist. Supports filtering by activity `id`, `type`, and `created_at`, ordering by `created_at` (default `-created_at`), and cursor-based pagination.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/benefits/{benefitId}/activities","href":"/api-reference/benefits/list-benefit-activities","autogeneratedByOpenApi":true}]},{"group":"Rewards","root":{"title":"Rewards overview","description":"Understand how rewards let Loyalty v2 members redeem their points for material products or digital incentives","keywords":["loyalty v2","rewards","reward purchases","material rewards","digital rewards","reward costs"],"diataxis":"explanation","href":"/api-reference/loyalty-v2-rewards-overview"},"pages":[{"title":"List rewards v2","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of rewards. Results can be filtered by id, name,\ntype and created_at, and ordered by created_at or name (ascending or descending).\nThe same field cannot be ordered both ascending and descending at the same time.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/rewards","href":"/api-reference/rewards/list-rewards-v2","autogeneratedByOpenApi":true},{"title":"Create a reward","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nCreates a new reward. `name`, `type` and `costs` are required. When `type` is\n`MATERIAL` the `material` object is required and `digital` must be null; when\n`type` is `DIGITAL` the `digital` object is required and `material` must be null.\nThe reward can be created directly in `DRAFT` (default) or `ACTIVE` status.\nWhen `validity_hours` is not provided it defaults to `{ \"type\": \"ANY_TIME\" }`.\n\nA successful call records [`vl.reward.created`](/api-reference/loyalty-activity/rewards/created).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/rewards","href":"/api-reference/rewards/create-a-reward","autogeneratedByOpenApi":true},{"title":"Get reward by ID","description":"Returns a single reward by its ID.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/rewards/{rewardId}","href":"/api-reference/rewards/get-reward-by-id","autogeneratedByOpenApi":true},{"title":"Update a reward","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nUpdates an existing reward. When `type` is provided as `MATERIAL` the `material`\nobject is required and `digital` must be null; when `type` is provided as `DIGITAL`\nthe `digital` object is required and `material` must be null.\n\nIn `DRAFT` status all properties can be updated. In `ACTIVE`/`INACTIVE` status only\nthe following properties can be updated: `name`, `metadata`, `refunds`,\n`validity_hours`, `start_date`, `end_date`, `costs`, `purchase_limits`.\n\nA successful call records [`vl.reward.updated`](/api-reference/loyalty-activity/rewards/updated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json put /v2/loyalties/rewards/{rewardId}","href":"/api-reference/rewards/update-a-reward","autogeneratedByOpenApi":true},{"title":"Delete a reward","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nDeletes a reward (moves it to the DELETED status). Returns the deleted reward. Returns `400` (`resource_in_use`) when a program still references the reward.\n\nA successful call records [`vl.reward.deleted`](/api-reference/loyalty-activity/rewards/deleted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json delete /v2/loyalties/rewards/{rewardId}","href":"/api-reference/rewards/delete-a-reward","autogeneratedByOpenApi":true},{"title":"Activate reward","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nMoves the reward to the ACTIVE status. Allowed from DRAFT or INACTIVE status;\nother transitions return 400 `invalid_state_transition`. This endpoint takes no\nrequest body. Activation returns 423 `resource_locked` when a linked card definition is not ACTIVE (`non_active_card_definition`), a tier structure in the tier rules is not ACTIVE (`non_active_tier_structure`), or a digital reward campaign is in `DRAFT` (`non_active_campaign`).\n\nA successful call records [`vl.reward.activated`](/api-reference/loyalty-activity/rewards/activated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/rewards/{rewardId}/activate","href":"/api-reference/rewards/activate-reward","autogeneratedByOpenApi":true},{"title":"Deactivate reward","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nMoves the reward to the INACTIVE status. Allowed only from ACTIVE status;\nother transitions return 400 `invalid_state_transition`. This endpoint takes no\nrequest body.\n\nA successful call records [`vl.reward.deactivated`](/api-reference/loyalty-activity/rewards/deactivated).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/rewards/{rewardId}/deactivate","href":"/api-reference/rewards/deactivate-reward","autogeneratedByOpenApi":true},{"title":"Move reward back to draft","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nMoves the reward back to the DRAFT status. Allowed only from `ACTIVE` status;\nother transitions return 400 `invalid_state_transition`. A reward assigned to a program that is not in `DRAFT` cannot be drafted (423 `resource_locked`, key `connected_non_draft_program`). This endpoint takes no\nrequest body.\n\nA successful call records [`vl.reward.drafted`](/api-reference/loyalty-activity/rewards/drafted).","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json post /v2/loyalties/rewards/{rewardId}/draft","href":"/api-reference/rewards/move-reward-back-to-draft","autogeneratedByOpenApi":true},{"title":"List reward activities","description":"\n\u003cInfo>\n\n\u003cBadge color=\"gray\">Documentation in progress\u003c/Badge>\n\nThis documentation is in progress. The parameters, fields, request and response bodies, and other data may be subject to change. If you need more information or you want to share feedback, contact [Voucherify support](https://www.voucherify.io/contact-support) or your Technical Account Manager.\n\n\u003c/Info>\n\nReturns a cursor-paginated list of activities recorded for the given reward\n(created, updated, deleted, assigned, unassigned, activated, deactivated, drafted).\nReturns `404` when the reward does not exist.\n\nA successful call records no activity.","deprecated":null,"version":null,"openapi":"/openapi/loyalties-v2.json get /v2/loyalties/rewards/{rewardId}/activities","href":"/api-reference/rewards/list-reward-activities","autogeneratedByOpenApi":true}]}]},{"group":"Referrals","public":true,"pages":[{"title":"List Referral Code Holders with campaign ID","description":"Retrieves all the redeemables that have been assigned to the customer.\n\nTo use this endpoint, you must have the following permissions:\n\n- Read Customers (`customers.details.read`)","deprecated":null,"version":null,"openapi":"/openapi/referrals.json get /v1/referrals/{campaignId}/members/{memberId}/holders","href":"/api-reference/referrals/list-referral-code-holders-with-campaign-id","autogeneratedByOpenApi":true},{"title":"List Referral Code Holders","description":"Retrieves the holders of the referral code from a referral campaign.\n\nTo use this endpoint, you must have the following permissions:\n\n- Read Customers (`customers.details.read`)\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to the [List Member Holders endpoint](/api-reference/referrals/list-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the `campaignId` as a path paremeter.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/referrals.json get /v1/referrals/members/{memberId}/holders","href":"/api-reference/referrals/list-referral-code-holders","autogeneratedByOpenApi":true},{"title":"Add Referral Code Holders with Campaign ID","description":"Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data.\n\nIf the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct.\n\nTo use this endpoint, you must have the following permissions:\n- Create and modify Customers and Segments (`customers.modify`)\n- Publish Voucher (`vouchers.publish`)\n\n\u003cTip>\n\nTo add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint.\n\n\u003c/Tip>","deprecated":null,"version":null,"openapi":"/openapi/referrals.json post /v1/referrals/{campaignId}/members/{memberId}/holders","href":"/api-reference/referrals/add-referral-code-holders-with-campaign-id","autogeneratedByOpenApi":true},{"title":"Add Referral Code Holders","description":"Adds new holders to a referral code as **referees**. The data sent in the request is upserted into the customer data.\n\nIf the request returns an error even for one customer, you have to resend the whole request. Customer data is upserted if the data for all customers is correct.\n\nTo use this endpoint, you must have the following permissions:\n- Create and modify Customers and Segments (`customers.modify`)\n- Publish Voucher (`vouchers.publish`)\n\n\u003cTip>\n\nTo add a holder as a referrer, use the [Create Publication](/api-reference/publications/create-publication) endpoint.\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to the [Add Referral Code Holders endpoint](/api-reference/referrals/add-referral-code-holders-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the `campaignId` as a path paremeter.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/referrals.json post /v1/referrals/members/{memberId}/holders","href":"/api-reference/referrals/add-referral-code-holders","autogeneratedByOpenApi":true},{"title":"Remove Referral Card Holder with campaign ID","description":"Removes the holder from a referral card. You can remove a referee only.\n\nTo use this endpoint, you must have the following permissions:\n- Create and modify Customers and Segments (`customers.modify`)\n- Publish Voucher (`vouchers.publish`)","deprecated":null,"version":null,"openapi":"/openapi/referrals.json delete /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId}","href":"/api-reference/referrals/remove-referral-card-holder-with-campaign-id","autogeneratedByOpenApi":true},{"title":"Remove Referral Card Holder","description":"Removes the holder from a referral card. You can remove a referee only.\n\nTo use this endpoint, you must have the following permissions:\n- Create and modify Customers and Segments (`customers.modify`)\n- Publish Voucher (`vouchers.publish`)\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to the [Remove Referral Card Holder endpoint](/api-reference/referrals/remove-referral-card-holder-with-campaign-id). The URL was re-designed to retrieve the referral member holders without providing the `campaignId` as a path paremeter.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/referrals.json delete /v1/referrals/members/{memberId}/holders/{holderId}","href":"/api-reference/referrals/remove-referral-card-holder","autogeneratedByOpenApi":true}]},{"group":"Rewards","public":true,"pages":[{"title":"Reward Object","mode":"frame","description":null,"href":"/api-reference/rewards/reward-object"},{"title":"Reward Assignment Object","mode":"frame","description":null,"href":"/api-reference/rewards/reward-assignment-object"},{"title":"List Rewards","description":"Retrieve campaign-linked rewards (referral campaigns and **legacy loyalty**). For Loyalty hub rewards, use `GET /v2/loyalties/rewards`.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json get /v1/rewards","href":"/api-reference/rewards/list-rewards","autogeneratedByOpenApi":true},{"title":"Get Reward","description":"Retrieve a reward by the reward ID.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json get /v1/rewards/{rewardId}","href":"/api-reference/rewards/get-reward","autogeneratedByOpenApi":true},{"title":"Create Reward","description":"Create a new reward. Use this endpoint for campaign-linked rewards (referral campaigns and **legacy loyalty**) and for `LOYALTY_POINTS` rewards that credit a `v2/loyalties` (loyalty hub) card from a referral tier. For Loyalty hub program rewards (a different resource), use `POST /v2/loyalties/rewards`.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json post /v1/rewards","href":"/api-reference/rewards/create-reward","autogeneratedByOpenApi":true},{"title":"Update Reward","description":"Update the details of a reward.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json put /v1/rewards/{rewardId}","href":"/api-reference/rewards/update-reward","autogeneratedByOpenApi":true},{"title":"Delete Reward","description":"Delete a reward.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json delete /v1/rewards/{rewardId}","href":"/api-reference/rewards/delete-reward","autogeneratedByOpenApi":true},{"title":"List Reward Assignments","description":"Retrieve reward assignments by the reward ID.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json get /v1/rewards/{rewardId}/assignments","href":"/api-reference/rewards/list-reward-assignments","autogeneratedByOpenApi":true},{"title":"Get Reward Assignment","description":"Retrieve a reward assignment.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json get /v1/rewards/{rewardId}/assignments/{assignmentId}","href":"/api-reference/rewards/get-reward-assignment","autogeneratedByOpenApi":true},{"title":"Create Reward Assignment","description":"Assigns a reward to a related object.\n\nFor **legacy loyalty** and digital or material rewards, send `campaign` with a loyalty or referral campaign ID.\n\nFor a `LOYALTY_POINTS` reward (credits a `v2/loyalties` (loyalty hub) card), send `related_object_type` `referral_tier` and `related_object_id` set to the referral tier ID. A `LOYALTY_POINTS` reward cannot be assigned to a campaign. Assigning it with `campaign` (or any non-`referral_tier` related object) returns `400` with `invalid_related_to`.\n\n`POST /v1/loyalties/{campaignId}/rewards` also cannot assign a `LOYALTY_POINTS` reward to a campaign.\n\nFor Loyalty hub program rewards, use `/v2/loyalties` reward endpoints.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json post /v1/rewards/{rewardId}/assignments","href":"/api-reference/rewards/create-reward-assignment","autogeneratedByOpenApi":true},{"title":"Update Reward Assignment","description":"Update the number of points needed to successfully redeem the reward.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json put /v1/rewards/{rewardId}/assignments/{assignmentId}","href":"/api-reference/rewards/update-reward-assignment","autogeneratedByOpenApi":true},{"title":"Delete Reward Assignment","description":"This method deletes a reward assignment for a particular reward.","deprecated":null,"version":null,"openapi":"/openapi/rewards.json delete /v1/rewards/{rewardId}/assignments/{assignmentId}","href":"/api-reference/rewards/delete-reward-assignment","autogeneratedByOpenApi":true}]},{"group":"Customers","public":true,"pages":[{"title":"Customer Object","mode":"frame","description":null,"href":"/api-reference/customers/customer-object"},{"title":"Customer Activity Object","mode":"frame","description":null,"href":"/api-reference/customers/customer-activity-object"},{"title":"List Customers","description":"Returns a list of customers.","deprecated":null,"version":null,"openapi":"/openapi/customers.json get /v1/customers","href":"/api-reference/customers/list-customers","autogeneratedByOpenApi":true},{"title":"Get Customer","description":"Retrieves details of a given customer by customer's `id` or `source_id`.","deprecated":null,"version":null,"openapi":"/openapi/customers.json get /v1/customers/{customerId}","href":"/api-reference/customers/get-customer","autogeneratedByOpenApi":true},{"title":"List Customer Activity","description":"Retrieves activity details of a given customer by customer's `id` or `source_id`.","deprecated":null,"version":null,"openapi":"/openapi/customers.json get /v1/customers/{customerId}/activity","href":"/api-reference/customers/list-customer-activity","autogeneratedByOpenApi":true},{"title":"List Customer's Segments","description":"Returns the list of segments IDs to which the customer belongs to. \n\nIf you pass a `customerId` which is not stored and recognized by Voucherify as an existing customer in the system, the response will generate a list of segments that the customer would potentialy qualify for if they were to become a customer tracked in the system.","deprecated":null,"version":null,"openapi":"/openapi/customers.json get /v1/customers/{customerId}/segments","href":"/api-reference/customers/list-customers-segments","autogeneratedByOpenApi":true},{"title":"List Customer's Redeemables","description":"Retrieves all the redeemables that have been assigned to the customer.\n\nTo use this endpoint, you must have the following permissions:\n\n- Read Customers (`customers.details.read`)","deprecated":null,"version":null,"openapi":"/openapi/customers.json get /v1/customers/{customerId}/redeemables","href":"/api-reference/customers/list-customers-redeemables","autogeneratedByOpenApi":true},{"title":"Create Customer","description":"Creates a customer object.\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Upsert Mode\u003c/Badge>\n\nIf you pass an `id` or a `source_id` that already exists in the customer database, Voucherify will return a related customer object with updated fields.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/customers.json post /v1/customers","href":"/api-reference/customers/create-customer","autogeneratedByOpenApi":true},{"title":"Import and Update Customers using CSV","description":"This API method lets you import or update customer data. To get a proper and valid response, please send a CSV file with data separated by commas. \n\n## Request Example\n\n```cURL\ncurl -X **POST** \\\n https://api.voucherify.io/v1/customers/importCSV \\\n -F file=@/path/to/customers.csv \\\n -H \"X-App-Id: c70a6f00-cf91-4756-9df5-47628850002b\" \\\n -H \"X-App-Token: 3266b9f8-e246-4f79-bdf0-833929b1380c\"\n```\n## CSV File Format\n\nThe CSV file has to include headers in the first line. All properties which cannot be mapped to standard customer fields will be added to the metadata object.\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Standard customer fields mapping\u003c/Badge>\n\n**No spaces allowed in field names** `Id`, `Name`, `Email`, `Phone`, `Birthdate`, `Source_id`, `Address_line_1`, `Address_line_2`, `Address_Postal_Code`, `Address_City`, `Address_State`, `Address_Country`, `Description`, `Metadata_name_1`, `Metadata_name_2`\n\n\u003c/Note>\n\n## Update Customers using CSV\n\nIf you would like to update customer's data, you can do it using the CSV file with new data. However, remember to include a `source_id` in your CSV file to manage the update successfully.\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/customers.json post /v1/customers/importCSV","href":"/api-reference/customers/import-and-update-customers-using-csv","autogeneratedByOpenApi":true},{"title":"Update Customer","description":"Updates the specified customer by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.","deprecated":null,"version":null,"openapi":"/openapi/customers.json put /v1/customers/{customerId}","href":"/api-reference/customers/update-customer","autogeneratedByOpenApi":true},{"title":"Update Customers in Bulk","description":"Updates customers in one asynchronous operation.\n\nThe request can include up to **10 MB** of data.\n\nThe response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.:\n\n- The status of your request (in queue, in progress, done, or failed)\n\n- Resources that failed to be updated\n\n- The report file with details about the update\n\n\n\nIf a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value `false` in the `found` column and `true` in the `updated` column.\n\nThis API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.","deprecated":null,"version":null,"openapi":"/openapi/customers.json post /v1/customers/bulk/async","href":"/api-reference/customers/update-customers-in-bulk","autogeneratedByOpenApi":true},{"title":"Update Customers' Metadata in Bulk","description":"Updates metadata parameters for a list of customers. Every resource in the list will receive the metadata defined in the request.\n\nThe request can include up to **10 MB** of data.\n\nThe response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.:\n\n- The status of your request (in queue, in progress, done, or failed)\n\n- Resources that failed to be updated\n\n- The report file with details about the update\n\nIf a customer object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value `false` in the `found` column and `true` in the `updated` column.\n\nThis API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.","deprecated":null,"version":null,"openapi":"/openapi/customers.json post /v1/customers/metadata/async","href":"/api-reference/customers/update-customers-metadata-in-bulk","autogeneratedByOpenApi":true},{"title":"Delete Customer","description":"This method deletes a customer.\n\nThe customer is permanently deleted. This means that a new customer with the same `source_id` can be created.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">GDPR compliance\u003c/Badge>\n\nThis method does NOT delete all related data, including personal data, from Voucherify databases. To delete these records and fulfil the right to be forgotten in the sense of the GDPR, use the [Delete Customer Permanently](/api-reference/customers/delete-customer-permanently) endpoint or go to [Delete people data](/manage/team-settings#delete-people-data) in the Voucherify [Team settings](/manage/team-settings).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/customers.json delete /v1/customers/{customerId}","href":"/api-reference/customers/delete-customer","autogeneratedByOpenApi":true},{"title":"Delete Customer Permanently","description":"The organization user can remove customer data permanently from the Voucherify system by using this API method. It deletes all customer data and connected resources. It makes the customer profile forgotten by Voucherify as per the GDPR.","deprecated":null,"version":null,"openapi":"/openapi/customers.json post /v1/customers/{customerId}/permanent-deletion","href":"/api-reference/customers/delete-customer-permanently","autogeneratedByOpenApi":true},{"title":"List Customer Activities","description":"\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for listing customer activities and we do not recommend using it. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nRetrieve customer activities.","deprecated":true,"version":null,"openapi":"/openapi/customers.json get /v1/customers/{customerId}/activities","href":"/api-reference/customers/list-customer-activities","autogeneratedByOpenApi":true}]},{"group":"Orders","public":true,"pages":[{"title":"Order Calculated Object","mode":"frame","description":null,"href":"/api-reference/orders/order-calculated-object"},{"title":"List Orders","description":"Returns a list of orders.\n\n","deprecated":null,"version":null,"openapi":"/openapi/orders.json get /v1/orders","href":"/api-reference/orders/list-orders","autogeneratedByOpenApi":true},{"title":"Get Order","description":"Retrieve a specific order by passing its ID.","deprecated":null,"version":null,"openapi":"/openapi/orders.json get /v1/orders/{orderId}","href":"/api-reference/orders/get-order","autogeneratedByOpenApi":true},{"title":"Create Order","description":"Creates an order object and triggers an order creation event.\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Upsert Mode\u003c/Badge>\n\nIf you pass an `id` or a `source_id` that already exists in the order database, Voucherify will return a related order object with updated fields.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/orders.json post /v1/orders","href":"/api-reference/orders/create-order","autogeneratedByOpenApi":true},{"title":"Update Order","description":"Updates the specified order by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.","deprecated":null,"version":null,"openapi":"/openapi/orders.json put /v1/orders/{orderId}","href":"/api-reference/orders/update-order","autogeneratedByOpenApi":true},{"title":"Import Orders","description":"\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Historical orders\u003c/Badge>\n\nThis endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the [update order](/api-reference/orders/update-order) endpoint should be used. This is critical because this endpoint does not store events or launch distributions.\n\n\u003c/Warning>\nThe orders will also have a `created_at` date that's assigned when they've been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order.\n\n## Limitations\n\n### Import volume\n\nThere can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one. \n\n### Maximum count of orders in single import\n\nThere is a `2000` limit of orders per one request.\n\n## Notifications\n\nThere are no notifications on the Dashboard because this import is launched via the API.\n\n## Triggered actions\n \nIf you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segment's summary. Consequently, this update will trigger \n- Customers entering into segments\n- Distributions based on any rules tied to customer entering segment(s)\n- Earning rules based on the customer entering segment(s)\n\n## What is not triggered\n\n1. No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs. \n\n2. Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a `PAID` status, the distribution is not going to be triggered. \n\n3. No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you won't see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you won't see the Product created events listed, etc. \n\n4. Earning rules based on Order Paid won't be triggered.\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request with [GET Async Action](/api-reference/async-actions/get-async-action) endpoint.","deprecated":null,"version":null,"openapi":"/openapi/orders.json post /v1/orders/import","href":"/api-reference/orders/import-orders","autogeneratedByOpenApi":true},{"title":"Create Orders Export","description":"Creates a downloadable CSV file containing a list of orders.\n\nThe parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to the `parameters.fields` object in the request body.\n\nThe available filters are all [order object](/api-reference/orders/order-calculated-object) attributes. Additionally, any metadata defined in the metadata schema can be exported.\n\nPassing an empty JSON will generate a file containing three default fields: `id`, `source_id`, and `status`.\n\nThe fields array is an array of strings containing the data in the export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| `id` | Unique order ID. | ord_A69RIxEdRsPuC6i8gFGVHUft |\n| `source_id` | Unique order source ID. | 8638 |\n| `created_at` | Timestamp in ISO 8601 format representing the date and time when the order was created. | 2022-03-09T09:16:32.521Z |\n| `updated_at` | Timestamp in ISO 8601 format representing the date and time when the order was last updated. | 2022-03-09T09:16:33.331Z |\n| `status` | Order status. | `PAID`, `CREATED`, `FULFILLED`, `CANCELED` |\n| `amount` | Total amount of order items. | 7700 |\n| `discount_amount` | Represents total amount of the discount applied to whole cart. | 500 |\n| `items_discount_amount` | Represents total amount of the discount applied to order line items. | 100 |\n| `total_discount_amount` | All discounts applied to the order including discounts applied to particular order line items and discounts applied to the whole cart. | 600 |\n| `total_amount` | Total order amount after applying all discounts. | 7100 |\n| `customer_id` | Customer unique ID. | cust_2G4fUQdCXUqp35nXNleav7bO |\n| `referrer_id` | Referrer unique ID. | cust_IkrTR674vvQvr9a4rDMiqglY |\n| `metadata` | Returns all order metadata. | Response will include all order metadata. |\n| `metadata.X` | Where X is the name of a particular order metadata property. | The returned value will depend on the type of data defined in the Dashboard > Project Settings > Metdata Schemas > Order. |","deprecated":null,"version":null,"openapi":"/openapi/orders.json post /v1/orders/export","href":"/api-reference/orders/create-orders-export","autogeneratedByOpenApi":true}]},{"group":"Products","public":true,"pages":[{"title":"Product Object","mode":"frame","description":null,"href":"/api-reference/products/product-object"},{"title":"SKU Object","mode":"frame","description":null,"href":"/api-reference/products/sku-object"},{"title":"List Products","description":"Retrieve a list of products.","deprecated":null,"version":null,"openapi":"/openapi/products.json get /v1/products","href":"/api-reference/products/list-products","autogeneratedByOpenApi":true},{"title":"Get Product","description":"Retrieve details of a given product and its SKUs, if any.","deprecated":null,"version":null,"openapi":"/openapi/products.json get /v1/products/{productId}","href":"/api-reference/products/get-product","autogeneratedByOpenApi":true},{"title":"Create Product","description":"Creates a product object.\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Upsert Mode\u003c/Badge>\n\nIf you pass an `id` or a `source_id` that already exists in the product database, Voucherify will return a related product object with updated fields.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/products.json post /v1/products","href":"/api-reference/products/create-product","autogeneratedByOpenApi":true},{"title":"Import Products using CSV","description":"Import products into the repository using a CSV file.\n\nThe CSV file has to include headers in the first line.\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Standard product fields mapping\u003c/Badge>\n\n- Create a **comma separated value (CSV) file** or download our CSV import template. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b82ed68d51e779443f550/Import_products_template.csv).\n- Supported CSV file headers: `name,source_id,price,attributes,image_url,Metadata_property_name`\n- **Name** is a **required** field. The remaining fields in the CSV template are optional.\n- Override/Update products' **names** in Voucherify using this method. Data will be updated for each product included in the CSV file whose **source_id** matches a source ID in Voucherify. No other data can be updated other than the product name.\n- Note that dates and date-time attributes need to be provided in compliance with the **ISO 8601 standard**. For example, 2022-03-11T09:00:00.000Z or 2022-03-11\n - `YYYY-MM-DD`\n - `YYYY-MM-DDTHH`\n - `YYYY-MM-DDTHH:mm`\n - `YYYY-MM-DDTHH:mm:ss`\n - `YYYY-MM-DDTHH:mm:ssZ`\n - `YYYY-MM-DDTHH:mm:ssZ`\n - `YYYY-MM-DDTHH:mm:ss.SSSZ`\n- Columns that cannot be mapped to standard fields, will be mapped to **Custom attributes** and added as **products' metadata**. There is no limit on the number of custom attributes that you can import as metadata.\n- To provide the proper data type, you need to add all custom attributes to the metadata schema **before importing the file**. Read more [here](/prepare/metadata#add-metadata).\n- **Product attributes** (not custom attributes) need to be separated by a comma and enclosed in double quotes, i.e \"attribute1,attribute2\".\n- Headers with metadata names **can't contain white-space characters**.\n- If you import metadata defined in the schema as **arrays (multiple)**, you need to separate each value using a comma, for example:\n - array of strings: \"subscribed,premium\"\n - array of numbers: \"123,234\".\n - array of dates: \"2000-01-01,2000-01-02\"\n\n\u003c/Note>\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/products.json post /v1/products/importCSV","href":"/api-reference/products/import-products-using-csv","autogeneratedByOpenApi":true},{"title":"Update Product","description":"Updates the specified product by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.","deprecated":null,"version":null,"openapi":"/openapi/products.json put /v1/products/{productId}","href":"/api-reference/products/update-product","autogeneratedByOpenApi":true},{"title":"Update Products in Bulk","description":"Update products in one asynchronous operation.\n\nThe request can include up to **10 MB** of data.\n\nThe response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.:\n\n- The status of your request (in queue, in progress, done, or failed)\n\n- Resources that failed to be updated\n\n- The report file with details about the update\n\n\n\nIf a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value `false` in the `found` column and `true` in the `updated` column.\n\nThis API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.","deprecated":null,"version":null,"openapi":"/openapi/products.json post /v1/products/bulk/async","href":"/api-reference/products/update-products-in-bulk","autogeneratedByOpenApi":true},{"title":"Update Products' Metadata in Bulk","description":"Updates metadata parameters for a list of products. Every resource in the list will receive the metadata defined in the request.\n\nThe request can include up to **10 MB** of data.\n\nThe response returns a unique asynchronous action ID. Use this ID in the query paramater of the [GET Async Action](/api-reference/async-actions/get-async-action) endpoint to check, e.g.:\n\n- The status of your request (in queue, in progress, done, or failed)\n\n- Resources that failed to be updated\n\n- The report file with details about the update\n\n\nIf a product object is not found, it is **upserted**. This is shown in the report file in the **GET** Async Action endpoint. The upserted resources have value `false` in the `found` column and `true` in the `updated` column.\n\nThis API request starts a process that affects Voucherify data in bulk. In the case of small jobs (like bulk update), the request is put into a queue and processed when every other bulk request placed in the queue prior to this request is finished.","deprecated":null,"version":null,"openapi":"/openapi/products.json post /v1/products/metadata/async","href":"/api-reference/products/update-products-metadata-in-bulk","autogeneratedByOpenApi":true},{"title":"Delete Product","description":"Deletes a product and all related SKUs. This operation cannot be undone. \n\nIf the `force` parameter is set to `false` or not set at all, the product and all related SKUs will be moved to [the bin](/api-reference/bin/list-bin-entries).","deprecated":null,"version":null,"openapi":"/openapi/products.json delete /v1/products/{productId}","href":"/api-reference/products/delete-product","autogeneratedByOpenApi":true},{"title":"List SKUs in Product","description":"Retrieve all SKUs for a given product.","deprecated":null,"version":null,"openapi":"/openapi/products.json get /v1/products/{productId}/skus","href":"/api-reference/products/list-skus-in-product","autogeneratedByOpenApi":true},{"title":"Get SKU","description":"Retrieve details of a SKU.","deprecated":null,"version":null,"openapi":"/openapi/products.json get /v1/skus/{skuId}","href":"/api-reference/products/get-sku","autogeneratedByOpenApi":true},{"title":"Create SKU","description":"This method adds product variants to a [created product](/api-reference/products/create-product). \n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Upsert Mode\u003c/Badge>\n\nIf you pass an `id` or a `source_id` that already exists in the sku database, Voucherify will return a related sku object with updated fields.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/products.json post /v1/products/{productId}/skus","href":"/api-reference/products/create-sku","autogeneratedByOpenApi":true},{"title":"Import SKUs using CSV","description":"Import SKUs into the repository using a CSV file.\n\nThe CSV file has to include headers in the first line. All properties which cannot be mapped to standard SKU fields will be added to the metadata object. You can find an example template [here](https://s3.amazonaws.com/helpscout.net/docs/assets/5902f1c12c7d3a057f88a36d/attachments/627b98d08c9b585083488a4c/Import_SKUS_template.csv). \n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Import sequence\u003c/Badge>\n\nFirst import products using the [dedicated endpoint](/api-reference/products/import-products-using-csv), then import SKUs using this endpoint to properly match SKUs to products.\n\n\u003c/Warning>\n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Standard SKU fields mapping\u003c/Badge>\n\n- **Required** fields are `source_id` and `product_id`.\n- Supported CSV file headers: `product_id,sku,source_id,price,image_url,attributes`\n- SKU **source_id** must be unique in the entire product catalog, no duplicates are allowed.\n- SKU attributes need to be in the form of a stringy-fied json, i.e.`\"{'color':'blue'}\"`. These attributes must be defined in the **product** beforehand so you can import them to the SKU.\n- You can use this method to update the following parameters in bulk: **sku** and the sku **price**.\n- Columns that cannot be mapped to standard fields will be mapped to Custom attributes and added as product metadata. There is no limit on the number of custom attributes that you can import as metadata.\n\n\u003c/Note>\n\nThis API request starts a process that affects Voucherify data in bulk. \n\nIn case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the `IN_PROGRESS` status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window. \n\nThe result will return the async ID. You can verify the status of your request via this [API request](/api-reference/async-actions/get-async-action).","deprecated":null,"version":null,"openapi":"/openapi/products.json post /v1/skus/importCSV","href":"/api-reference/products/import-skus-using-csv","autogeneratedByOpenApi":true},{"title":"Update SKU","description":"Updates the specified SKU by setting the values of the parameters passed in the request body. Any parameters not provided in the payload will be left unchanged.\n\nFields other than the ones listed in the request body schema won't be modified. Even if provided, they will be silently skipped.","deprecated":null,"version":null,"openapi":"/openapi/products.json put /v1/products/{productId}/skus/{skuId}","href":"/api-reference/products/update-sku","autogeneratedByOpenApi":true},{"title":"Delete SKU","description":"Deletes a product SKU. This operation cannot be undone. \n\nIf the `force` parameter is set to `false` or not set at all, the SKU will be moved to [the bin](/api-reference/bin/list-bin-entries).","deprecated":null,"version":null,"openapi":"/openapi/products.json delete /v1/products/{productId}/skus/{skuId}","href":"/api-reference/products/delete-sku","autogeneratedByOpenApi":true}]},{"group":"Product Collections","public":true,"pages":[{"title":"Product Collection Object","mode":"frame","description":null,"href":"/api-reference/product-collections/product-collection-object"},{"title":"List Product Collections","description":"This method returns a list of product collections.","deprecated":null,"version":null,"openapi":"/openapi/product-collections.json get /v1/product-collections","href":"/api-reference/product-collections/list-product-collections","autogeneratedByOpenApi":true},{"title":"Get Product Collection","description":"Retrieves the product collection.","deprecated":null,"version":null,"openapi":"/openapi/product-collections.json get /v1/product-collections/{productCollectionId}","href":"/api-reference/product-collections/get-product-collection","autogeneratedByOpenApi":true},{"title":"List Products in Collection","description":"Retrieves list of products from a product collection; works for both dynamic and static product collections.","deprecated":null,"version":null,"openapi":"/openapi/product-collections.json get /v1/product-collections/{productCollectionId}/products","href":"/api-reference/product-collections/list-products-in-collection","autogeneratedByOpenApi":true},{"title":"Create Product Collection","description":"This method creates a new product collection.","deprecated":null,"version":null,"openapi":"/openapi/product-collections.json post /v1/product-collections","href":"/api-reference/product-collections/create-product-collection","autogeneratedByOpenApi":true},{"title":"Update Product Collection","description":"Updates the product collection.\n\nFor `STATIC` collections, you can update only the `name`.\n\nFor `AUTO_UPDATE` collections, you can update its `name` and `filters`.","deprecated":null,"version":null,"openapi":"/openapi/product-collections.json put /v1/product-collections/{productCollectionId}","href":"/api-reference/product-collections/update-product-collection","autogeneratedByOpenApi":true},{"title":"Delete Product Collection","description":"Deletes a product collection.\n\n\u003cWarning>This endpoint performs database-heavy operations. It is not designed for highly frequent use.\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/product-collections.json delete /v1/product-collections/{productCollectionId}","href":"/api-reference/product-collections/delete-product-collection","autogeneratedByOpenApi":true}]},{"group":"Validation Rules","public":true,"pages":[{"title":"Validation Rule Object","mode":"frame","description":null,"href":"/api-reference/validation-rules/validation-rule-object"},{"title":"Validation Rule Assignment Object","mode":"frame","description":null,"href":"/api-reference/validation-rules/validation-rule-assignment-object"},{"title":"List Validation Rules","description":"Retrieve validation rules.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json get /v1/validation-rules","href":"/api-reference/validation-rules/list-validation-rules","autogeneratedByOpenApi":true},{"title":"Get Validation Rule","description":"Retrieve the details of a validation rule.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json get /v1/validation-rules/{validationRuleId}","href":"/api-reference/validation-rules/get-validation-rule","autogeneratedByOpenApi":true},{"title":"Create Validation Rules","description":"Create a validation rule.\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Managing validation rules\u003c/Badge>\n\nIt is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json post /v1/validation-rules","href":"/api-reference/validation-rules/create-validation-rules","autogeneratedByOpenApi":true},{"title":"Update Validation Rule","description":"Update validation rule parameters.\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Managing validation rules\u003c/Badge>\n\nIt is recommended to [create or update validation rules](/personalize/create-validation-rules) in the Voucherify dashboard. The rule builder in the dashboard helps configuring the desired conditions in a convenient way. The API should not be used as a preferable way to create and manage validation rules.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json put /v1/validation-rules/{validationRuleId}","href":"/api-reference/validation-rules/update-validation-rule","autogeneratedByOpenApi":true},{"title":"Delete Validation Rule","description":"This method deletes a validation rule.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json delete /v1/validation-rules/{validationRuleId}","href":"/api-reference/validation-rules/delete-validation-rule","autogeneratedByOpenApi":true},{"title":"List Validation Rules' Assignment(s)","description":"List all validation rules' assignments or filter the results using the related object ID or the validation rule ID query parameters.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json get /v1/validation-rules-assignments","href":"/api-reference/validation-rules/list-validation-rules-assignments","autogeneratedByOpenApi":true},{"title":"List Validation Rule Assignments","description":"Retrieve validation rule assignments for a specific validation rule.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json get /v1/validation-rules/{validationRuleId}/assignments","href":"/api-reference/validation-rules/list-validation-rule-assignments","autogeneratedByOpenApi":true},{"title":"Create Validation Rules Assignments","description":"Assign validation rule to either one of the following objects: voucher, campaign, promotion tier, earning rule, reward, distribution.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json post /v1/validation-rules/{validationRuleId}/assignments","href":"/api-reference/validation-rules/create-validation-rules-assignments","autogeneratedByOpenApi":true},{"title":"Delete Validation Rule Assignment","description":"This method deletes a validation rule assignment.","deprecated":null,"version":null,"openapi":"/openapi/validation-rules.json delete /v1/validation-rules/{validationRuleId}/assignments/{assignmentId}","href":"/api-reference/validation-rules/delete-validation-rule-assignment","autogeneratedByOpenApi":true}]},{"group":"Segments","public":true,"pages":[{"title":"Segment Object","mode":"frame","description":null,"href":"/api-reference/segments/segment-object"},{"title":"List segments","description":"Retrieves a list of segments.\n\nThe list doesn't include the customers that belong to respective segments. To return a list of customers who belong to a segment, use [GET List customers](/api-reference/customers/list-customers) endpoint with the `segment_id` query parameter.\n\nTo return a list of different results, use the `filters[created_at][conditions][$before]` and `filters[created_at][conditions][$after]` query parameters as pagination.","deprecated":null,"version":null,"openapi":"/openapi/segments.json get /v1/segments","href":"/api-reference/segments/list-segments","autogeneratedByOpenApi":true},{"title":"Get Segment","description":"Retrieves the segment with a given segment ID.\n\nThis method doesn't return the customers that belong to the segment. To return a list of customers who belong to a segment, use [GET List customers](/api-reference/customers/list-customers) endpoint with the `segment_id` query parameter.","deprecated":null,"version":null,"openapi":"/openapi/segments.json get /v1/segments/{segmentId}","href":"/api-reference/segments/get-segment","autogeneratedByOpenApi":true},{"title":"Create Segment","description":"Create a customer segment.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Limit on static segments\u003c/Badge>\n\nThere is a cap on the number of customers that you can assign to a static segment: **20,000**. If you would like to create a bigger segment, then you can use the unlimited `auto-update` or `passive` segment instead and use some customer metadata to build this segment.\n\n\u003c/Warning>\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Limit on Active and Passive segments\u003c/Badge>\n\nYou can create a maximum of 100 passive and active segments.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/segments.json post /v1/segments","href":"/api-reference/segments/create-segment","autogeneratedByOpenApi":true},{"title":"Delete Segment","description":"This method deletes a customer segment.","deprecated":null,"version":null,"openapi":"/openapi/segments.json delete /v1/segments/{segmentId}","href":"/api-reference/segments/delete-segment","autogeneratedByOpenApi":true}]},{"group":"Events","public":true,"pages":[{"title":"Event Object","mode":"frame","description":null,"href":"/api-reference/events/event-object"},{"title":"Track Custom Event","description":"To track a custom event, you create an event object. \n\nThe event object must be linked to the customer who performs the action. If a customer doesn't exist in Voucherify, the customer will be created.","deprecated":null,"version":null,"openapi":"/openapi/events.json post /v1/events","href":"/api-reference/events/track-custom-event","autogeneratedByOpenApi":true}]},{"group":"Async Actions","public":true,"pages":[{"title":"Async Action Object","mode":"frame","description":null,"href":"/api-reference/async-actions/async-action-object"},{"title":"List Async Actions","description":"Track asynchronous operations scheduled in your project. \n\nThe table below lists the possible types of async actions. The types are different for each endpoint generating the async action.\n\n| **Types by Context** | **Endpoint** |\n|:---|:---|\n| **CAMPAIGN** | |\n| CAMPAIGN.VOUCHERS_IMPORT | **POST** [`/campaigns/{campaignId}/import`](/api-reference/campaigns/import-vouchers-to-campaign) |\n| CAMPAIGN.VOUCHERS_IMPORT_CSV | **POST** [`/campaigns/{campaignId}/importCSV`](/api-reference/campaigns/import-vouchers-to-campaign-by-csv) |\n| CAMPAIGN.VOUCHERS_UPDATE | **PUT** [`/campaigns/{campaignId}`](/api-reference/campaigns/update-campaign) |\n| CAMPAIGN.VOUCHERS_DELETE | **DELETE** [`/campaigns/{campaignId}`](/api-reference/campaigns/delete-campaign) |\n| CAMPAIGN.VOUCHERS_GENERATE | \u003cul>\u003cli>**POST** [`/campaigns`](/api-reference/campaigns/create-campaign): asynchronous for campaigns with more than 1 voucher, synchronous for campaign with 1 voucher\u003c/li>\u003cli>**POST** [`/campaigns/{campaignId}/vouchers`](/api-reference/campaigns/add-vouchers-to-campaign)\u003c/li>\u003c/ul> |\n| **CUSTOMERS** | |\n| CUSTOMERS.IMPORT_CSV | **POST** [`/customers/importCSV`](/api-reference/customers/import-and-update-customers-using-csv) |\n| CUSTOMERS.BULK_UPDATE | **POST** [`/customers/bulk/async`](/api-reference/customers/update-customers-in-bulk) |\n| CUSTOMERS.METADATA_UPDATE | **POST** [`/customers/metadata/async`](/api-reference/customers/update-customers-metadata-in-bulk) |\n| **PRODUCTS** | |\n| PRODUCTS.BULK_UPDATE | **POST** [`/products/bulk/async`](/api-reference/products/update-products-in-bulk)\u003cbr /> |\n| PRODUCTS.METADATA_UPDATE | **POST** [`/products/metadata/async`](/api-reference/products/update-products-metadata-in-bulk) |\n| PRODUCTS.IMPORT_CSV | **POST** [`/products/importCSV`](/api-reference/products/import-products-using-csv) |\n| SKUS.IMPORT_CSV | **POST** [`/skus/importCSV`](/api-reference/products/import-skus-using-csv) |\n| **VOUCHERS** | |\n| VOUCHERS.IMPORT | **POST** [`/vouchers/import`](/api-reference/vouchers/import-vouchers) |\n| VOUCHERS.IMPORT_CSV | **POST** [`/vouchers/importCSV`](/api-reference/vouchers/import-vouchers-using-csv) |\n| VOUCHERS.BULK_UPDATE | **POST** [`/vouchers/bulk/async`](/api-reference/vouchers/update-vouchers-in-bulk)\u003cbr /> |\n| VOUCHERS.METADATA_UPDATE | **POST** [`/vouchers/metadata/async`](/api-reference/vouchers/update-vouchers-metadata-in-bulk) | \n| **ORDERS** | |\n| ORDERS.IMPORT | **POST** [`/orders/import`](/api-reference/orders/import-orders) |\n| **METADATA KEY PURGE** | |\n| CAMPAIGNS.METADATA_KEY_PURGE\u003cbr />CUSTOMERS.METADATA_KEY_PURGE\u003cbr />PRODUCTS.METADATA_KEY_PURGE\u003cbr />VOUCHERS.METADATA_KEY_PURGE\u003cbr />ORDERS.METADATA_KEY_PURGE | No API endpoint equivalent. You can perform this action through the Dashboard. See Dashboard documentation: Dashboard > [Project Settings](/prepare/metadata#maintenance) |","deprecated":null,"version":null,"openapi":"/openapi/async-actions.json get /v1/async-actions","href":"/api-reference/async-actions/list-async-actions","autogeneratedByOpenApi":true},{"title":"Get Async Action","description":"Check the result of a scheduled asynchronous operation. \n\nThe table below lists the possible types of async actions. The types are different for each endpoint generating the async action. \n\n| **Types by Context** | **Endpoint** |\n|:---|:---|\n| **CAMPAIGN** | |\n| CAMPAIGN.VOUCHERS_IMPORT | **POST** [`/campaigns/{campaignId}/import`](/api-reference/campaigns/import-vouchers-to-campaign) |\n| CAMPAIGN.VOUCHERS_IMPORT_CSV | **POST** [`/campaigns/{campaignId}/importCSV`](/api-reference/campaigns/import-vouchers-to-campaign-by-csv) |\n| CAMPAIGN.VOUCHERS_UPDATE | **PUT** [`/campaigns/{campaignId}`](/api-reference/campaigns/update-campaign) |\n| CAMPAIGN.VOUCHERS_DELETE | **DELETE** [`/campaigns/{campaignId}`](/api-reference/campaigns/delete-campaign) |\n| CAMPAIGN.VOUCHERS_GENERATE | \u003cul>\u003cli>**POST** [`/campaigns`](/api-reference/campaigns/create-campaign): asynchronous for campaigns with more than 1 voucher, synchronous for campaign with 1 voucher\u003c/li>\u003cli>**POST** [`/campaigns/{campaignId}/vouchers`](/api-reference/campaigns/add-vouchers-to-campaign)\u003c/li>\u003c/ul> |\n| **CUSTOMERS** | |\n| CUSTOMERS.IMPORT_CSV | **POST** [`/customers/importCSV`](/api-reference/customers/import-and-update-customers-using-csv) |\n| CUSTOMERS.BULK_UPDATE | **POST** [`/customers/bulk/async`](/api-reference/customers/update-customers-in-bulk) |\n| CUSTOMERS.METADATA_UPDATE | **POST** [`/customers/metadata/async`](/api-reference/customers/update-customers-metadata-in-bulk) |\n| **PRODUCTS** | |\n| PRODUCTS.BULK_UPDATE | **POST** [`/products/bulk/async`](/api-reference/products/update-products-in-bulk)\u003cbr /> |\n| PRODUCTS.METADATA_UPDATE | **POST** [`/products/metadata/async`](/api-reference/products/update-products-metadata-in-bulk) |\n| PRODUCTS.IMPORT_CSV | **POST** [`/products/importCSV`](/api-reference/products/import-products-using-csv) |\n| SKUS.IMPORT_CSV | **POST** [`/skus/importCSV`](/api-reference/products/import-skus-using-csv) |\n| **VOUCHERS** | |\n| VOUCHERS.IMPORT | **POST** [`/vouchers/import`](/api-reference/vouchers/import-vouchers) |\n| VOUCHERS.IMPORT_CSV | **POST** [`/vouchers/importCSV`](/api-reference/vouchers/import-vouchers-using-csv) |\n| VOUCHERS.BULK_UPDATE | **POST** [`/vouchers/bulk/async`](/api-reference/vouchers/update-vouchers-in-bulk)\u003cbr /> |\n| VOUCHERS.METADATA_UPDATE | **POST** [`/vouchers/metadata/async`](/api-reference/vouchers/update-vouchers-metadata-in-bulk) | \n| **ORDERS** | |\n| ORDERS.IMPORT | **POST** [`/orders/import`](/api-reference/orders/import-orders) |\n| **METADATA KEY PURGE** | |\n| CAMPAIGNS.METADATA_KEY_PURGE\u003cbr />CUSTOMERS.METADATA_KEY_PURGE\u003cbr />PRODUCTS.METADATA_KEY_PURGE\u003cbr />VOUCHERS.METADATA_KEY_PURGE\u003cbr />ORDERS.METADATA_KEY_PURGE | No API endpoint equivalent. You can perform this action through the Dashboard. See Dashboard documentation: Dashboard > [Project Settings](/prepare/metadata#maintenance) |","deprecated":null,"version":null,"openapi":"/openapi/async-actions.json get /v1/async-actions/{asyncActionId}","href":"/api-reference/async-actions/get-async-action","autogeneratedByOpenApi":true}]},{"group":"Exports","public":true,"pages":[{"title":"Export Object","mode":"frame","description":null,"href":"/api-reference/exports/export-object"},{"title":"List Exports","description":"List all exports. ","deprecated":null,"version":null,"openapi":"/openapi/exports.json get /v1/exports","href":"/api-reference/exports/list-exports","autogeneratedByOpenApi":true},{"title":"Get Export","description":"Retrieves the URL of the downloadable file, which was generated via the [Create Export](/api-reference/exports/create-export) method.","deprecated":null,"version":null,"openapi":"/openapi/exports.json get /v1/exports/{exportId}","href":"/api-reference/exports/get-export","autogeneratedByOpenApi":true},{"title":"Create Export","description":"Create export object. The export can be any of the following types: `voucher`, `redemption`, `publication`, `customer`, `order`, `points_expiration`, `voucher_transactions`, `product`, or `sku`. \n\n## Defaults\n\nIf you only specify the object type in the request body without specifying the fields, the API will return the following fields per export object:\n\n| **Export Object** | **Default fields returned** |\n|:---|:---|\n| order | `id`, `source_id`, `status` |\n| voucher | `code`, `voucher_type`, `value`, `discount_type` |\n| publication | `code`, `customer_id`, `date`, `channel` |\n| redemption | `id`, `object`, `voucher_code`, `customer_id`, `date`, `result` |\n| customer | `name`, `source_id` |\n| points_expiration | `id`, `campaign_id`, `voucher_id`, `status`, `expires_at`, `points` |\n| voucher_transactions | `id`, `type`, `source_id`, `status`, `reason`, `source`, `balance`, `amount`, `created_at` |\n| product | `id`, `name`, `price`, `image_url`, `source_id`, `attributes`, `created_at`|\n| sku | `id`, `sku`, `product_id`, `currency`, `price`, `image_url`, `source_id`, `attributes`, `created_at`|\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Date and time in the export API\u003c/Badge>\n\nThe exported date and times are always provided in the UTC time zone.\n\n\u003c/Note>\n\n## Fetching particular data sets\n\nUsing the `parameters` body parameter, you can narrow down which fields to export and how to filter the results. The fields are an array of strings containing the data that you would like to export. These fields define the headers in the CSV file. The array can be a combination of any of the following available fields:\n\n## Orders \n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique order ID. | ord_A69RIxEdRsPuC6i8gFGVHUft |\n| source_id | Unique order source ID. | 8638 |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the order was created. | 2022-03-09T09:16:32.521Z |\n| updated_at | Timestamp in ISO 8601 format representing the date and time when the order was last updated. | 2022-03-09T09:16:33.331Z |\n| status | Order status. | `PAID`, `CREATED`, `FULFILLED`, `CANCELED` |\n| amount | Total amount of order items. | 7700 |\n| discount_amount | Represents total amount of the discount applied to whole cart. | 500 |\n| items_discount_amount | Represents total amount of the discount applied to order line items. | 100 |\n| total_discount_amount | All discounts applied to the order including discounts applied to particular order line items and discounts applied to the whole cart. | 600 |\n| total_amount | Total order amount after applying all discounts. | 7100 |\n| customer_id | Customer unique ID. | cust_2G4fUQdCXUqp35nXNleav7bO |\n| referrer_id | Referrer unique ID. | cust_IkrTR674vvQvr9a4rDMiqglY |\n| metadata | Order metadata; expressed as metadata.X, where X is the name of the custom metadata property. | 1 |\n\n## Vouchers \n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique voucher ID. | v_HSnGD2vNIHYighTQxwcB4dtVAv8VOmZD |\n| code | Unique voucher code. | WELCOME100 |\n| voucher_type | Type of voucher. | `DISCOUNT_VOUCHER`, `GIFT_VOUCHER`, `LOYALTY_CARD` |\n| value | Value of voucher. | `DISCOUNT_VOUCHER` : amount, percent, unit\u003cbr />`GIFT_VOUCHER`: amount left to spend\u003cbr />`LOYALTY_CARD`: available usable points |\n| discount_type | The type of discount for a `DISCOUNT_VOUCHER`. | `AMOUNT`, `PERCENT`, `UNIT`, `FIXED` |\n| campaign | Unique campaign name. | Summer Discounts 20% off |\n| category | Tag defining the category that this voucher belongs to. | |\n| start_date | Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is _inactive_ before this date. | 2020-12-10T23:00:00.000Z |\n| expiration_date | Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is _inactive_ after this date. | 2023-12-31T23:00:00.000Z |\n| gift_balance | Amount left to spend. | 1000 |\n| loyalty_balance | Available usable points. | 2000 |\n| redemption_quantity | Maximum number of times a voucher can be redeemed. | 2 |\n| redemption_count | Total redemptions. | 59 |\n| active | Boolean indicating whether the voucher is available for use. | `true`, `false` |\n| qr_code | URL to QR representation of encrypted code. | |\n| bar_code | URL to barcode representation of encrypted code. | |\n| metadata | Custom voucher metadata. | |\n| is_referral_code | Boolean indicating whether the voucher is a referral code. | `true`, `false` |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the voucher was created. | 2022-04-14T09:55:46.814Z |\n| updated_at | Timestamp in ISO 8601 format representing the date and time when the voucher was last updated. | 2022-04-14T10:02:18.036Z |\n| validity_timeframe_interval | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of `P2D` will be active every other day. | P2D |\n| validity_timeframe_duration | Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of `PT1H` will be valid for a duration of one hour. | PT1H |\n| validity_day_of_week | Array corresponding to the particular days of the week in which the voucher is valid. | \"1,2,3,4,5\" |\n| discount_amount_limit | For `PERCENT` discount type, this is the maximum threshold allowed to be deducted. | 50 |\n| campaign_id | Parent campaign ID. | camp_7s3uXI44aKfIk5IhmeOPr6ic |\n| additional_info | An optional field to keep any extra textual information about the code such as a code description and details. | |\n| customer_id | Unique customer ID of the assigned owner to whom the voucher was published. | cust_7iUa6ICKyU6gH40dBU25kQU1 |\n| discount_unit_type | For `UNIT` discount type, either a shipping or product ID for a `UNIT` discount with one product. | prod_5h1pp1ng, prod_0a9f9aeddb019a42db |\n| discount_unit_effect | `UNIT` discount effect. | `ADD_MANY_ITEMS`, `ADD_MISSING_ITEMS`,`ADD_NEW_ITEMS` |\n| customer_source_id | Unique customer source id of the assigned owner to whom the voucher was published. | name.lastname@email.com |\n\n\n## Publications\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| voucher_code | Unique voucher code. | WELCOME100 |\n| customer_id | Customer unique ID. | cust_7iUa6ICKyU6gH40dBU25kQU1 |\n| customer_source_id | Unique customer source id of the assigned owner to whom the voucher was published. | name.lastname@email.com |\n| date | Timestamp in ISO 8601 format representing the date and time when the voucher was published. | 2022-04-28T10:19:30.792Z |\n| channel | Publication channel. | voucherify-website |\n| campaign | Unique campaign name. | Summer Discounts 20% off |\n| is_winner | | |\n| metadata | Custom publication metadata. | |\n\n## Redemptions\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique redemption ID. | r_0acf3a6dae00e679c8, rf_0acf3a495740e679b8 |\n| object | Object being exported; by default `redemption`. | redemption |\n| date | Timestamp in ISO 8601 format representing the date and time when the voucher was redeemed. | 2022-03-23T08:52:24.867Z |\n| voucher_code | Unique voucher code redeemed. | WELCOME100 |\n| campaign | Parent campaign name of voucher if applicable. | Summer Discounts 20% off |\n| promotion_tier_id | | promo_Mwy9XpA0TLctSGriM5kum0qp |\n| customer_id | Unique customer ID of redeeming customer. | cust_nk0N1uNQ1YnupAoJGOgvsODC |\n| customer_source_id | Unique source ID of redeeming customer. | name.lastname@email.com |\n| customer_name | Customer name. | John Smith |\n| tracking_id | | track_Pw6r3ejnml43kIwNS4Zj09KZ67xOfLUy |\n| order_amount | Total order amount before applying all discounts. | 1000 |\n| gift_amount | Gift credits used for redemption. | 10 |\n| loyalty_points | | 12 |\n| result | Tells you whether the redemption succeeded. | `SUCCESS`, `FAILURE` |\n| failure_code | Internal Voucherify code for reason why redemption failed. | invalid_customer |\n| failure_message | A human-readable message providing a short description explaining why the redemption failed. | Customer must be a holder of a loyalty card. |\n| metadata | Custom redemption metadata. | |\n\n## Customers\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| name | Customer name. | John Smith |\n| id | Unique customer ID. | cust_J1CDUdbqn5Exva8ASWk1Fq0j |\n| description | An arbitrary string that you can attach to a customer object. | Customer requesting to be added to VIP tier. |\n| email | Customer's email. | name.lastname@email.com |\n| source_id | Unique custom customer identifier. | name.lastname@email.com |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the customer was created. | 2022-02-03T13:10:11.928Z |\n| address_city | City | Houston |\n| address_state | State | TX |\n| address_line_1 | First line of customer's address. | 72738 Main St |\n| address_line_2 | Second line of customer's address. | Bld 2, Apt 4 |\n| address_country | Country | United States of America |\n| address_postal_code | Postal code (ZIP code) | 77042-4143 |\n| redemptions_total_redeemed | Total customer redemptions. | 5 |\n| redemptions_total_failed | Total customer failed redemptions. | 2 |\n| redemptions_total_succeeded | Total customer succeeded redemptions. | 3 |\n| redemptions_total_rolled_back | Total customer redemptions that were rolled back. | 3 |\n| redemptions_total_rollback_failed | Total customer redemptions that were unsuccessfully rolled back. | 2 |\n| redemptions_total_rollback_succeeded | Total customer redemptions that were successfully rolled back. | 1 |\n| orders_total_amount | Total sum of order amounts over customer lifetime. Value is multiplied by 100 to precisely represent 2 decimal places. | 10000 (represents `$100`) |\n| orders_total_count | Total number of customer orders. | 2 |\n| orders_average_amount | Average amount spent on orders. Value is multiplied by 100 to precisely represent 2 decimal places. | 5000 (represents `$50`) |\n| orders_last_order_amount | How much did the customer spend on their last order. Value is multiplied by 100 to precisely represent 2 decimal places. | 5000 (represents `$50`) |\n| orders_last_order_date | When was the last customer order; timestamp in ISO 8601 format representing the date and time. | 2022-02-03T13:17:30.630Z |\n| loyalty_points | Sum of customer's loyalty points to go across all loyalty cards. | 2000 |\n| loyalty_referred_customers | How many customers were referred by this customer. | 3 |\n| updated_at | Timestamp in ISO 8601 format representing the date and time when the customer was updated. | 2022-02-14T14:10:14.305Z |\n| phone | Customer's phone number. | +1 (294) 752-1846 |\n| birthday | `Deprecated`. ~~Customer's birthday~~. | 2022-01-01 |\n| metadata | Customer metadata. | All metadata fields defined in Metadata Schema for the Customer object. |\n| birthdate | Customer's birthdate. | 2022-01-01 |\n\n## Points Expirations\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Loyalty points bucket ID. | lopb_Wl1o3EjJIHSNjvO5BDLy4z1n |\n| campaign_id | Campaign ID of the parent loyalty campaign. | camp_7s3uXI44aKfIk5IhmeOPr6ic |\n| voucher_id | Voucher ID of the parent loyalty card. | v_YLn0WVWXSXbUfDvxgrgUbtfJ3SQIY655 |\n| status | Status of the loyalty point bucket. | `ACTIVE` or `EXPIRED` |\n| expires_at | Timestamp in ISO 8601 format representing the date when the points expire. | 2022-06-30 |\n| points | Number of points. | 1000 |\n\n ## Gift Card Transactions\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique transaction ID. | vtx_0cb7811f1c07765800 |\n| type | Transaction type. | - `CREDITS_REMOVAL` \u003cbr /> - `CREDITS_ADDITION` \u003cbr /> - `CREDITS_REFUND` \u003cbr /> - `CREDITS_REDEMPTION` |\n| source_id | Unique transaction source ID. | 8638 |\n| reason | Contains the reason for the transaction if one was included originally. | |\n| balance | The gift card or loyalty card balance after the transaction. | |\n| amount | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |\n| voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |\n| campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |\n| source| Channel through which the transaction was initiated. | API |\n| details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |\n\n ## Loyalty Card Transactions\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 |\n| type | Transaction type. | - `POINTS_EXPIRATION` \u003cbr /> - `POINTS_ADDITION` \u003cbr /> - `POINTS_REMOVAL` \u003cbr /> - `POINTS_TRANSFER_OUT` \u003cbr /> - `POINTS_ACCRUAL` \u003cbr /> - `POINTS_REFUND` \u003cbr /> - `POINTS_REDEMPTION` |\n| source_id | Custom source ID of the transaction if one was included originally. | source_id_custom |\n| reason | Contains the reason for the transaction if one was included originally. | |\n| balance | The loyalty card balance after the transaction. | |\n| amount | The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |\n| voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |\n| campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |\n| source| Channel through which the transaction was initiated. | - `API` \u003cbr /> - `voucherify-web-ui` \u003cbr /> - `Automation` |\n| details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |\n| related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |\n\n## Products\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique product ID assigned by Voucherify. | prod_0bae32322150fd0546 |\n| name | Unique user-defined product name. | T-shirt |\n| price | Product price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$10.00` being expressed as `1000`. | 1000 |\n| image_url | URL to an image of the product. | `https://example.com/t-shirt.png` |\n| source_id | Unique product identifier from your inventory system. | sku_001 |\n| attributes | Array of product attributes that define SKU variants, stored as JSON. | `[\"color\",\"size\"]` |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the product was created. | 2022-03-09T09:16:32.521Z |\n| metadata | Custom product metadata; expressed as metadata.X, where X is the name of the custom metadata property. | All metadata fields defined in the Metadata Schema for the Product object. |\n\n## SKUs\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique SKU ID assigned by Voucherify. | sku_0b7d2095d7cfa6f80a |\n| sku | Unique user-defined SKU name. | T-shirt / Red / M |\n| product_id | Unique product ID of the parent product assigned by Voucherify. | prod_0bae32322150fd0546 |\n| currency | SKU price currency. | USD |\n| price | SKU price. It is represented by a value multiplied by 100 to accurately reflect 2 decimal places, such as `$12.00` being expressed as `1200`. | 1200 |\n| image_url | URL to an image of the SKU. | `https://example.com/t-shirt-red-m.png` |\n| source_id | Unique SKU identifier from your inventory system. | sku_001_red_m |\n| attributes | SKU-level variant attributes stored as JSON. | `{\"color\":\"Red\",\"size\":\"M\"}` |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the SKU was created. | 2022-03-09T09:16:32.521Z |\n| metadata | Custom SKU metadata; expressed as metadata.X, where X is the name of the custom metadata property. | All metadata fields defined in the Metadata Schema for the SKU object. |","deprecated":null,"version":null,"openapi":"/openapi/exports.json post /v1/exports","href":"/api-reference/exports/create-export","autogeneratedByOpenApi":true},{"title":"Download Export","description":"Download the contents of the exported CSV file. \n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Important notes\u003c/Badge>\n\n**Base URL:**\n\n- `https://download.voucherify.io` (Europe)\n- `https://us1.download.voucherify.io` (US)\n- `https://as1.download.voucherify.io` (Asia)\n\n**Token:** Can be found within the `result` parameter of the [Get Export](/api-reference/exports/get-export) method response.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/exports.json get /v1/exports/{export_Id}","href":"/api-reference/exports/download-export","autogeneratedByOpenApi":true},{"title":"Delete Export","description":"This method deletes a previously created export object.","deprecated":null,"version":null,"openapi":"/openapi/exports.json delete /v1/exports/{exportId}","href":"/api-reference/exports/delete-export","autogeneratedByOpenApi":true}]},{"group":"Categories","public":true,"pages":[{"title":"Category Object","mode":"frame","description":null,"href":"/api-reference/categories/category-object"},{"title":"List Categories","description":"List all categories.","deprecated":null,"version":null,"openapi":"/openapi/categories.json get /v1/categories","href":"/api-reference/categories/list-categories","autogeneratedByOpenApi":true},{"title":"Get Category","description":"Retrieve a category by the category ID.","deprecated":null,"version":null,"openapi":"/openapi/categories.json get /v1/categories/{categoryId}","href":"/api-reference/categories/get-category","autogeneratedByOpenApi":true},{"title":"Create Category","description":"Create category with a specific name and hierarchy.","deprecated":null,"version":null,"openapi":"/openapi/categories.json post /v1/categories","href":"/api-reference/categories/create-category","autogeneratedByOpenApi":true},{"title":"Update Category","description":"Update a category using the category ID.","deprecated":null,"version":null,"openapi":"/openapi/categories.json put /v1/categories/{categoryId}","href":"/api-reference/categories/update-category","autogeneratedByOpenApi":true},{"title":"Delete Category","description":"Delete a category by the category ID.","deprecated":null,"version":null,"openapi":"/openapi/categories.json delete /v1/categories/{categoryId}","href":"/api-reference/categories/delete-category","autogeneratedByOpenApi":true}]},{"group":"Metadata Schemas","public":true,"pages":[{"title":"Metadata Schema Object","mode":"frame","description":null,"href":"/api-reference/metadata-schemas/metadata-schema-object"},{"title":"List Metadata Schema Definitions","description":"Retrieve metadata schema definitions.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Management API\u003c/Badge>\n\nIf you have Management API enabled, you can also use the [List Metadata Schemas](/api-reference/management/list-metadata-schemas) endpoint to list all metadata schemas.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/metadata-schemas.json get /v1/metadata-schemas","href":"/api-reference/metadata-schemas/list-metadata-schema-definitions","autogeneratedByOpenApi":true},{"title":"Get Metadata Schema","description":"Retrieves a metadata schema per resource type.\n\n## Resource types\n\n### Standard\n\nYou can retrieve metadata schemas for the standard metadata schema definitions listed below. Add one of these types as the resource path parameter.\n\n- `campaign`\n- `customer`\n- `earning_rule`\n- `loyalty_tier`\n- `order`\n- `order_item`\n- `product`\n- `promotion_tier`\n- `publication`\n- `redemption`\n- `reward`\n- `voucher`\n\n### Custom\n\nIf you have defined a [custom metadata schema](/prepare/metadata#add-metadata), provide its name in the `\"resource\"` field to retrieve its details.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Management API\u003c/Badge>\n\nIf you have Management API enabled, you can also use the [Get Metadata Schemas](/api-reference/management/get-metadata-schema) endpoint to retrieve a metadata schema using its ID.\n\n\u003c/Note>\n\n`loyalty_tier` / Loyalty Tier and `earning_rule` / Earning rule metadata schemas apply to **legacy loyalty** campaigns. Loyalty hub resources use Loyalty v2 metadata where configured.","deprecated":null,"version":null,"openapi":"/openapi/metadata-schemas.json get /v1/metadata-schemas/{resource}","href":"/api-reference/metadata-schemas/get-metadata-schema","autogeneratedByOpenApi":true}]},{"group":"Locations","public":true,"pages":[{"title":"Location Object","mode":"frame","description":null,"href":"/api-reference/locations/location-object"},{"title":"List Locations","description":"Returns a list of your locations.","deprecated":null,"version":null,"openapi":"/openapi/locations.json get /v1/locations","href":"/api-reference/locations/list-locations","autogeneratedByOpenApi":true},{"title":"Get Location","description":"Returns a location object.","deprecated":null,"version":null,"openapi":"/openapi/locations.json get /v1/locations/{locationId}","href":"/api-reference/locations/get-location","autogeneratedByOpenApi":true}]},{"group":"Bin","public":true,"pages":[{"title":"List Bin Entries","description":"Retrieves a list of resources moved to the bin. The following resources can be moved to the bin:\n- campaigns\n- vouchers\n- products\n- SKUs\n\nTo use this endpoint, you must have the following permissions:\n- `vouchers.read`\n- `campaigns.read`\n- `products.read`","deprecated":null,"version":null,"openapi":"/openapi/bin.json get /v1/trash-bin","href":"/api-reference/bin/list-bin-entries","autogeneratedByOpenApi":true},{"title":"Delete Bin Entry","description":"Deletes permanently a bin entry with a given ID.The following resources can be moved to the bin and permanently deleted:\n- campaigns\n- vouchers\n- products\n- SKUs\n\n\n\nTo use this endpoint and delete a given resource type, you must have the following permissions:\n- `vouchers.delete` to delete a voucher,\n- `campaigns.delete` to delete a campaign,\n- `products.delete` to delete a product or SKU.","deprecated":null,"version":null,"openapi":"/openapi/bin.json delete /v1/trash-bin/{binEntryId}","href":"/api-reference/bin/delete-bin-entry","autogeneratedByOpenApi":true}]},{"group":"Management","public":true,"pages":[{"title":"Create Project","description":"Creates a new project. You can add users, specify the cluster, timezone, currency, and other details.\n\nAll owners are added to the project by default.","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects","href":"/api-reference/management/create-project","autogeneratedByOpenApi":true},{"title":"List Projects","description":"Lists all projects for the organization.\n\nThe endpoint does not require any query parameters.","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects","href":"/api-reference/management/list-projects","autogeneratedByOpenApi":true},{"title":"Get Project","description":"Retrieves an existing project.","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}","href":"/api-reference/management/get-project","autogeneratedByOpenApi":true},{"title":"Update Project","description":"Updates an existing project.\n\nYou can add or modify settings for timezone, currency, notifications, and other details.\n\nOnly the fields sent in the request will be updated.","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}","href":"/api-reference/management/update-project","autogeneratedByOpenApi":true},{"title":"Delete Project","description":"Deletes an existing project.\n\nThe users currently using the deleted project will be automatically logged out.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Sandbox Project\u003c/Badge>\n\nThe sandbox project cannot be deleted.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}","href":"/api-reference/management/delete-project","autogeneratedByOpenApi":true},{"title":"Invite a New User","description":"Sends an invitation to an email address that has not been used yet as a Voucherify user login.\n\nYou can specify the projects to which the invited user will be assigned and define their roles.","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/users/invite","href":"/api-reference/management/invite-a-new-user","autogeneratedByOpenApi":true},{"title":"Assign User","description":"Assigns a user to a given project. The user must be an existing user in Voucherify.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Correct Use of Data\u003c/Badge>\n\nTo avoid errors, use the `\"role\"` key with either `\"id\"` or `\"login\"` keys.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/users","href":"/api-reference/management/assign-user","autogeneratedByOpenApi":true},{"title":"List Users","description":"Lists all users assigned to the project.","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/users","href":"/api-reference/management/list-users","autogeneratedByOpenApi":true},{"title":"Get User","description":"Retrieves the project user's details.","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/users/{userId}","href":"/api-reference/management/get-user","autogeneratedByOpenApi":true},{"title":"Update User","description":"Updates the user's role.","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}/users/{userId}","href":"/api-reference/management/update-user","autogeneratedByOpenApi":true},{"title":"Unassign User","description":"Unassigns the user from the project.\nIf the user is currently logged in, they are automatically logged out. If the user is assigned to only one project, they cannot be unassigned from that project.","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}/users/{userId}","href":"/api-reference/management/unassign-user","autogeneratedByOpenApi":true},{"title":"Create Metadata Schema","description":"Creates a new metadata (custom attribute) schema for a given resource.\n\nThe schema consists of a set of key-value pairs to customize Voucherify resources. \n\nYou can nest your object within a standard metadata schema, e.g. within a campaign or customer schema. However, your nested object can't include another nested object. The standard metadata schemas are:\n- Campaign\n- Voucher\n- Publication\n- Redemption\n- Product\n- Customer\n- Order\n- Order line item\n- Loyalty Tier\n- Promotion Tier\n- Earning rule\n- Reward\n\nUse this endpoint to define a metadata schema of a given resource for the first time. Once you configure a metadata schema for a given `related_object`, use the PUT [Update metadata schema](/api-reference/management/update-metadata-schema) endpoint to either update or add new metadata key-value pairs. For example, use this endpoint to define a metadata schema for `related_object: campaign` for the first time. If you want define a new metadata property for `campaign`, use the [PUT Update metadata schema](/api-reference/management/update-metadata-schema) endpoint.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Metadata Documentation\u003c/Badge>\n\nRead [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.\n\n\u003c/Note>\n\n`loyalty_tier` / Loyalty Tier and `earning_rule` / Earning rule metadata schemas apply to **legacy loyalty** campaigns. Loyalty hub resources use Loyalty v2 metadata where configured.","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/metadata-schemas","href":"/api-reference/management/create-metadata-schema","autogeneratedByOpenApi":true},{"title":"List Metadata Schemas","description":"Lists all metadata schemas available in the project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Metadata Documentation\u003c/Badge>\n\nRead [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/metadata-schemas","href":"/api-reference/management/list-metadata-schemas","autogeneratedByOpenApi":true},{"title":"Get Metadata Schema","description":"Retrieves a metadata schema.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Metadata Documentation\u003c/Badge>\n\nRead [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}","href":"/api-reference/management/get-metadata-schema","autogeneratedByOpenApi":true},{"title":"Update Metadata Schema","description":"Updates a metadata schema.\n\nWith this request, you can:\n- Add a nonexistent attribute definition to the metadata schema.\n- Update an existing attribute definition by overwriting its current values.\n\nIn the request, you can provide only those definitions you want to add or update. Definitions omitted in the request remain unchanged.\n\nHowever, if you want to update a definition, you will have to add all its current key-value pairs as well. Only the pairs sent in the request are saved for this definition. This means that the key-value pairs that are not sent in a request are restored to default values. For example, if your definition has an array with values and it is not sent in an update request, the array values will be deleted.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Additional Notes\u003c/Badge>\n\n- You cannot change the type of an existing schema, e.g. from `\"string\"` to `\"number\"`.\n\n- You can remove a definition with this endpoint by providing `\"deleted\": true` in the request. It will be moved to the Removed definitions section in the user interface. However, you cannot permanently remove a definition with this endpoint.\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Metadata Documentation\u003c/Badge>\n\nRead [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}","href":"/api-reference/management/update-metadata-schema","autogeneratedByOpenApi":true},{"title":"Delete Metadata Schema","description":"Deletes permanently the metadata schema.\n\nIn standard metadata schemas, this endpoint removes permanently all definitions. The standard metadata schemas are:\n- Campaign\n- Voucher\n- Publication\n- Redemption\n- Product\n- Customer\n- Order\n- Order line item\n- Loyalty Tier\n- Promotion Tier\n- Earning rule\n- Reward\n\nIf you want to delete only one definition, use the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint. In the request, provide the `\"deleted\": true` pair in the definition object. This definition will be moved to Removed definitions.\n\nIf you want to create a new standard metadata schema, use the [Create Metadata Schema](/api-reference/management/create-metadata-schema) endpoint.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Metadata Purging\u003c/Badge>\n\nThis endpoint deletes permanently the metadata schemas only. However, it does not purge the metadata from associated entities, so the metadata added to those entities will remain.\n\nIf you want to purge metadata from the entities:\n\n1. Remove all the definitions you want to purge. You can do this either in Voucherify Project Settings > Metadata Schema tab or with the [Update Metadata Schema](/api-reference/management/update-metadata-schema) endpoint.\n2. In Voucherify Project Settings > Metadata Schema tab, go to the relevant metadata schema.\n3. In Removed definitions, click the bin button next to the definitions whose metadata you want to purge from entities.\n\nNote:\n\n- This is an asynchronous action. You will be notified when it has been completed.\n- You cannot purge metadata for the Redemption and Publication schemas.\n\n4. Use the Delete Metadata Schema request to delete the metadata schema from Voucherify.\n\n\u003c/Warning>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Metadata Documentation\u003c/Badge>\n\nRead [the Getting Started with Metadata](/prepare/metadata) and [Metadata Mapping](/guides/metadata-mapping) articles to learn how metadata work in Voucherify.\n\n\u003c/Note>\n\n`loyalty_tier` / Loyalty Tier and `earning_rule` / Earning rule metadata schemas apply to **legacy loyalty** campaigns. Loyalty hub resources use Loyalty v2 metadata where configured.","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId}","href":"/api-reference/management/delete-metadata-schema","autogeneratedByOpenApi":true},{"title":"Create Custom Event Schema","description":"Creates a custom event schema.\n\nThe `\"properties\"` object is required, but it can be empty, however. This object is for optional custom properties (metadata).\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Custom Event Documentation\u003c/Badge>\n\nRead [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify.\n\nRead also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/custom-event-schemas","href":"/api-reference/management/create-custom-event-schema","autogeneratedByOpenApi":true},{"title":"List Custom Event Schemas","description":"Lists all custom event schemas available in the project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Custom Event Documentation\u003c/Badge>\n\nRead [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify.\n\nRead also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/custom-event-schemas","href":"/api-reference/management/list-custom-event-schemas","autogeneratedByOpenApi":true},{"title":"Get Custom Event Schema","description":"Retrieves a custom event schema.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Custom Event Documentation\u003c/Badge>\n\nRead [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify.\n\nRead also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}","href":"/api-reference/management/get-custom-event-schema","autogeneratedByOpenApi":true},{"title":"Update Custom Event Schema","description":"Updates a custom event schema.\n\nWith this request, you can:\n- Add a nonexistent property to a custom event schema.\n- Update an existing property.\n\nIn the request, you can provide only those properties you want to add or update. Definitions omitted in the request remain unchanged.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Additional Notes\u003c/Badge>\n\n- You can change the type of an existing property, e.g. from `\"string\"` to `\"number\"`.\n\n- You can remove a custom property with this endpoint by providing `\"deleted\": true` in the request. However, you cannot permanently remove an event definition or its property with this endpoint.\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Custom Event Documentation\u003c/Badge>\n\nRead [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify.\n\nRead also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}","href":"/api-reference/management/update-custom-event-schema","autogeneratedByOpenApi":true},{"title":"Delete Custom Event Schema","description":"Deletes permanently the custom event schema with its custom properties (metadata).\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Custom Event Documentation\u003c/Badge>\n\nRead [Custom Events](/prepare/custom-events) article to learn how custom events work in Voucherify.\n\nRead also the details about the [Track Custom Event](/api-reference/events/track-custom-event) endpoint and the [Custom Event Object](/api-reference/events/event-object).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId}","href":"/api-reference/management/delete-custom-event-schema","autogeneratedByOpenApi":true},{"title":"Create Stacking Rules","description":"Overwrites the default stacking rules.\n\nIf new stacking rules have been created for the project earlier (e.g. in the user interface), it returns an error. Use [Update stacking rules](/api-reference/management/update-stacking-rules) endpoint to change the rules.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Stacking rules documentation\u003c/Badge>\n\nRead [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/stacking-rules","href":"/api-reference/management/create-stacking-rules","autogeneratedByOpenApi":true},{"title":"List Stacking Rules","description":"Lists all stacking rules.\n\nReturns always a list with one item.\n\nThis endpoint can be used to retrieve the default stacking rules. The default stacking rules do not have an ID that could be used with the [Get Stacking Rules](/api-reference/management/get-stacking-rules) or [Update Stacking Rules](/api-reference/management/update-stacking-rules) endpoints.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Stacking Rules Documentation\u003c/Badge>\n\nRead [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/stacking-rules","href":"/api-reference/management/list-stacking-rules","autogeneratedByOpenApi":true},{"title":"Get Stacking Rules","description":"Retrieves the stacking rules for the project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Stacking Rules Documentation\u003c/Badge>\n\nRead [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}","href":"/api-reference/management/get-stacking-rules","autogeneratedByOpenApi":true},{"title":"Update Stacking Rules","description":"Updates the stacking rules.\n\nOnly the provided fields will be updated. However, if you update an array, the content of the array is overwritten. This means that if you want to add new values to an array and retain existing ones, you need to provide both the existing and new values in the request.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Stacking Rules Documentation\u003c/Badge>\n\nRead [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}","href":"/api-reference/management/update-stacking-rules","autogeneratedByOpenApi":true},{"title":"Delete Stacking Rules","description":"Deletes permanently the current settings for the stacking rules.\n\nThe stacking rules are restored to default values.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Stacking Rules Documentation\u003c/Badge>\n\nRead [the Stacking rules article](/orchestrate/stacking-rules) to learn how they work.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId}","href":"/api-reference/management/delete-stacking-rules","autogeneratedByOpenApi":true},{"title":"Create Webhook","description":"Creates a new webhook configuration.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Webhook Documentation\u003c/Badge>\n\nRead [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/webhooks","href":"/api-reference/management/create-webhook","autogeneratedByOpenApi":true},{"title":"List Webhooks","description":"Lists all webhook configurations for the project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Webhook Documentation\u003c/Badge>\n\nRead [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/webhooks","href":"/api-reference/management/list-webhooks","autogeneratedByOpenApi":true},{"title":"Get Webhook","description":"Retrieves a webhook configuration.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Webhook Documentation\u003c/Badge>\n\nRead [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/webhooks/{webhookId}","href":"/api-reference/management/get-webhook","autogeneratedByOpenApi":true},{"title":"Update Webhook","description":"Updates a webhook configuration.\n\nThe `\"events\"` listed in the request are overwritten. If you want to add more events, provide also the events that are already in the webhook configuration.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Webhook Documentation\u003c/Badge>\n\nRead [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}/webhooks/{webhookId}","href":"/api-reference/management/update-webhook","autogeneratedByOpenApi":true},{"title":"Delete Webhook","description":"Deletes a webhook configuration.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Webhook Documentation\u003c/Badge>\n\nRead [Introduction to webhooks](/api-reference/introduction-to-webhooks) article to learn how webhooks work in Voucherify.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}/webhooks/{webhookId}","href":"/api-reference/management/delete-webhook","autogeneratedByOpenApi":true},{"title":"Create Brand","description":"Creates a new brand configuration.\n\nYou can have only one brand configured for a project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">White Labelling\u003c/Badge>\n\nThe white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/branding","href":"/api-reference/management/create-brand","autogeneratedByOpenApi":true},{"title":"List Brands","description":"Lists all brand configurations.\n\nBecause a project can have only one brand, it always returns a list with one item.\n\nThis endpoint can be used to retrieve the brand configuration created with the Voucherify Dashboard and the ID.","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/branding","href":"/api-reference/management/list-brands","autogeneratedByOpenApi":true},{"title":"Get Brand","description":"Retrieves a brand configuration.","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/branding/{brandingId}","href":"/api-reference/management/get-brand","autogeneratedByOpenApi":true},{"title":"Update Brand","description":"Updates a brand configuration.\n\nOnly the fields sent in the request will be updated. The fields omitted in the request will remain unchanged.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">White Labelling\u003c/Badge>\n\nThe white labelling settings which can be found in Project Settings > Brand Details and which are available only for Enterprise clients as a separate service can be configured only in the user interface.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json put /management/v1/projects/{projectId}/branding/{brandingId}","href":"/api-reference/management/update-brand","autogeneratedByOpenApi":true},{"title":"Delete Brand","description":"Deletes permanently a brand configuration.","deprecated":null,"version":null,"openapi":"/openapi/management.json delete /management/v1/projects/{projectId}/branding/{brandingId}","href":"/api-reference/management/delete-brand","autogeneratedByOpenApi":true},{"title":"List Campaign Templates","description":"Lists all campaign templates available in the project.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">List Campaign Templates\u003c/Badge>\n\nThis endpoint works in the same way as the [List Campaign Templates endpoint](/api-reference/templates/list-campaign-templates).\n\n\u003c/Tip>\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json get /management/v1/projects/{projectId}/templates/campaigns","href":"/api-reference/management/list-campaign-templates","autogeneratedByOpenApi":true},{"title":"Copy Campaign Template to a Project","description":"Copies a campaign template to another project.\n\nThe resources, like validation rules or products, will not be copied to the destination project yet. When the template is used to create a new campaign or add a new promotion tier, the resources will be created in the destination project.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Campaign Templates – Documentation\u003c/Badge>\n\nRead the [Campaign Templates documentation](/build/campaign-templates) to learn more about this feature.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/management.json post /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy","href":"/api-reference/management/copy-campaign-template-to-a-project","autogeneratedByOpenApi":true}]},{"group":"OAuth","public":true,"pages":[{"title":"Generate OAuth 2.0 Token","description":"Generate an OAuth 2.0 token for an API client. The token can be used to authorize access to the Voucherify API. The token inherits the permissions and IP whitelists of the API key that is used to generate the OAuth token. You can define the scope that limits its usage. You can generate up to 1000 OAuth tokens per project. The token expires in 900 seconds (15 minutes).\n\nIf the API key that is used to generate the OAuth token is deleted or blocked, you cannot generate new OAuth tokens and the existing ones will stop working within one minute.\n\nIf the API key used to generate an OAuth token is regenerated, the OAuth token can still be used.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Format of scope values\u003c/Badge>\n\nSeparate the values of the `scope` property with spaces.\n\n\u003c/Warning>","deprecated":null,"version":null,"openapi":"/openapi/oauth.json post /v1/oauth/token","href":"/api-reference/oauth/generate-oauth-20-token","autogeneratedByOpenApi":true},{"title":"Introspect OAuth 2.0 Token","description":"Introspect an OAuth 2.0 token for an API client.","deprecated":null,"version":null,"openapi":"/openapi/oauth.json post /v1/oauth/introspect","href":"/api-reference/oauth/introspect-oauth-20-token","autogeneratedByOpenApi":true},{"title":"Revoke OAuth 2.0 Token","description":"Revoke an OAuth 2.0 token for an API client. Once revoked, the token cannot be used anymore.","deprecated":null,"version":null,"openapi":"/openapi/oauth.json post /v1/oauth/token/revoke","href":"/api-reference/oauth/revoke-oauth-20-token","autogeneratedByOpenApi":true}]},{"group":"Client-side","public":true,"pages":[{"title":"Create Publication (client-side)","description":"This method selects vouchers that are suitable for publication, adds a publish entry and returns the publication.\n\nA voucher is suitable for publication when it's active and hasn't been published yet. \n\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Clearly define the source of the voucher\u003c/Badge>\n\nYou must clearly define which source you want to publish the voucher code from. It can either be a code from a campaign or a specific voucher identified by a code.\n\n\u003c/Warning>\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Publish multiple vouchers\u003c/Badge>\n\nIn case you want to publish multiple vouchers within a single publication, you need to specify the campaign name and number of vouchers you want to publish.\n\n\u003c/Warning>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Auto-update campaign\u003c/Badge>\n\nIn case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use an **auto-update** campaign.\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/client-side.json post /client/v1/publish","href":"/api-reference/client-side/create-publication-client-side","autogeneratedByOpenApi":true},{"title":"Check Eligibility (client-side)","description":"Generate a list of redeemables that are applicable in the context of the customer and order.\n\nThe new qualifications method is an improved version of [Campaign Qualifications](/api-reference/campaigns/examine-campaign-qualification), [Voucher Qualifications](/api-reference/vouchers/examine-voucher-qualification) API requests. The new qualification method introduces the following improvements:\n\n- Qualification results are returned faster\n- No limit on the number of returned redeemables\n- Introduces new qualification scenarios, not available in the previous version\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Scenario Guide\u003c/Badge>\n\nRead our dedicated guide to learn about some use cases this endpoint can cover [here](/guides/checking-eligibility).\n\n\u003c/Tip>\n\n## Paging \n\nThe Voucherify Qualifications API request will return to you all of the redeemables available for the customer in batches of up to 50 redeemables per page. To get the next batch of redeemables, you need to use the `starting_after` cursor.\n\nTo process of paging the redeemables works in the following manner:\n\n- You send the first API request for Qualifications without the `starting_after` parameter.\n- The response will contain a parameter named `has_more`. If the parameter's value is set to `true`, then more redeemables are available.\n- Get the value of the `created_at` parameter of the last returned redeemable. The value of this parameter will be used as a cursor to retrieve the next page of redeemables.\n- Send another API request for Qualification with the `starting_after` parameter set to the value taken from the `created_at` parameter from the last returned redeemable.\n- Voucherify will return the next page of redeemables.\n- If the `has_more` parameter is set to `true`, apply steps 3-5 to get the next page of redeemables.\n\n## Caching\n\nQualification has a 5-minute cache for the returned results. If you change your campaign settings or validation rules, the changes will apply to qualification results after the cache refreshes.","deprecated":null,"version":null,"openapi":"/openapi/client-side.json post /client/v1/qualifications","href":"/api-reference/client-side/check-eligibility-client-side","autogeneratedByOpenApi":true},{"title":"Validate Stackable Discounts (client-side)","description":"Verify redeemables provided in the request. This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications.","deprecated":null,"version":null,"openapi":"/openapi/client-side.json post /client/v1/validations","href":"/api-reference/client-side/validate-stackable-discounts-client-side","autogeneratedByOpenApi":true},{"title":"Redeem Stackable Discounts (client-side)","description":"This method is accessible through public keys which you can use in client side requests coming from mobile and web browser applications.\n\n## How API returns calculated discounts and order amounts in the response\n\nIn the table below, you can see the logic the API follows to calculate discounts and amounts:\n\n| **Field** | **Calculation** | **Description** |\n|:---|:---|:---|\n| amount | N/A | This field shows the order amount before applying any discount |\n| total_amount | `total_amount` = `amount` - `total_discount_amount` | This field shows the order amount after applying all the discounts |\n| discount_amount | `discount_amount` = `previous_discount_amount` + `applied_discount_amount` | This field sums up all order-level discounts up to and including the specific discount being calculated for the stacked redemption. |\n| items_discount_amount | sum(items, i => i.discount_amount) | This field sums up all product-specific discounts |\n| total_discount_amount | `total_discount_amount` = `discount_amount` + `items_discount_amount` | This field sums up all order-level and all product-specific discounts |\n| applied_discount_amount | N/A | This field shows the order-level discount applied in a particular request |\n| items_applied_discount_amount | sum(items, i => i.applied_discount_amount) | This field sums up all product-specific discounts applied in a particular request |\n| total_applied_discount_amount | `total_applied_discount_amount` = `applied_discount_amount` + `items_applied_discount_amount` | This field sums up all order-level and all product-specific discounts applied in a particular request |\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Rollbacks\u003c/Badge>\n\nYou can't roll back a child redemption. When you call rollback on a stacked redemption, all child redemptions will be rolled back. You need to refer to a parent redemption ID in your [rollback request](/api-reference/redemptions/rollback-stackable-redemptions).\n\n\u003c/Note>","deprecated":null,"version":null,"openapi":"/openapi/client-side.json post /client/v1/redemptions","href":"/api-reference/client-side/redeem-stackable-discounts-client-side","autogeneratedByOpenApi":true},{"title":"List Promotion Tiers (client-side)","description":"This method enables you to list promotion tiers.","deprecated":null,"version":null,"openapi":"/openapi/client-side.json get /client/v1/promotions/tiers","href":"/api-reference/client-side/list-promotion-tiers-client-side","autogeneratedByOpenApi":true},{"title":"Track Custom Event (client-side)","description":"To track a custom event, you create an event object. \n\nThe event object must be linked to the customer who performs the action. If a customer doesn't exist in Voucherify, the customer will be created.","deprecated":null,"version":null,"openapi":"/openapi/client-side.json post /client/v1/events","href":"/api-reference/client-side/track-custom-event-client-side","autogeneratedByOpenApi":true},{"title":"Validate Voucher (client-side)","description":"\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for voucher validation, and we do not recommend using it. The new [Stackable Discounts API](/api-reference/client-side/validate-stackable-discounts-client-side) introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nTo verify a voucher code given by customer, you can use this method. It is designed for client side integration which means that is accessible only through public keys. This method is designed to be run directly either in web browsers or mobile apps.\n\n\u003cDanger>\n\n\u003cBadge color=\"red\">Specifying gift credits and loyalty points\u003c/Badge>\n\nThis endpoint does not support specifying the specific amount of gift credits to apply to an order nor the specific amount of loyalty points to an order. It calculates the amount that is available on the card and applies as much credits or points as possible to cover the total amount.\n\n\u003c/Danger>\n\n### Set customer identity (optional)\n\nVoucherify can help you track anonymous customers. Once you integrate Voucherify into your web app and call the validate method, Voucherify will return a tracking ID and the script will store it in a cookie. Each subsequent validate call will use the same tracking ID.\n\nVoucherify tracks a user using a tracking ID to see if the user who is validating vouchers is the same as the one who consuming them. Voucherify does this by setting up an identity for the user. A `tracking_id` will be generated on the server side, unless you specify your own `tracking_id`. In both cases, you will receive the `tracking_id` in the validation response.\n\nThe returned `tracking_id` field should be used as the customer `source_id` in subsequent redemption requests. Moreover, the `tracking_id` returned from Validation API is encoded. Voucherify will recognize both values for identifying customer - the one before encryption sent as a query parameter to the **GET** `v1/validate` request, and the version encrypted and returned as part of the validation request.\n\n### Sample workflow\n\nCustomer tracking workflow in a nutshell:\n\n**Client-side:**\n * A customer visits your website.\n * A customer validates a voucher code. That triggers a validate request to be sent to Voucherify. In the request, you pass the tracking_id or customer.source_id. As a result, the API call to this endpoint returns an **encoded** `tracking_id`.\n\n**Backend:**\n * Once the customer finishes the checkout process, your website passes the `tracking_id` to your backend during a redemption call. The `tracking_id` is sent as a value assigned to the property *source_id* in a customer object.\n * A customer object is created and within the redemption response, you get a customer `id`.\n * You can use the customer `id` or the customer `source_id` to fetch or modify the customer details.\n \nA customer is created (upserted) automatically with a redemption call. Alternatively, you can create a new profile by creating a customer via a dedicated API method. Take a look at the customer object to understand the [entity's structure](/api-reference/customers/customer-object). \n\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Customer identifier\u003c/Badge>\n\nThe source id of the customer may either be an already hashed version of the `tracking_id`, which you received in a response from a validation request or a custom ID you predefined (i.e. an email address). Nevertheless, we recommend using identifiers delivered by Voucherify API.\n\n\u003c/Note>\n\n\n\n\n### Examples with Query Parameters\n\n| **Query Parameters** | **Example URL** |\n|:---|:---|\n| Shortcut - `customer` query param instead of `customer[source_id]` | `https://api.voucherify.io/client/v1/validate?code=sKKFCKLZ\u0026amount=10100\u0026customer=customer_id` |\n| Pass `customer`'s and `redemption`'s context `metadata` in query parameters | `https://api.voucherify.io/client/v1/validate?code=sKKFCKLZ\u0026amount=10100\u0026customer=sure_he_is_new\u0026metadata[shop]=1\u0026customer[metadata][propsy]=2\u0026metadata[test]=true` |\n| Use `tracking_id` instead of `source_id` | `https://api.voucherify.io/client/v1/validate?code=IKU-mvS-JOG\u0026amount=10100\u0026tracking_id=sure_he_is_new_5\u0026metadata[shop]=1\u0026metadata[test]=true` |\n\n### Reasons why a validation might fail\n\nVoucher validation might fail because of one of these reasons:\n\n* `voucher not found` - voucher doesn't exist or was [deleted](/api-reference/vouchers/delete-voucher)\n* `voucher expired` - voucher is out of [start date - expiration date] timeframe\n* `voucher is disabled` - learn more about [disabled vouchers](/api-reference/vouchers/disable-voucher)\n* `customer does not match segment rules` - learn more about [customer tracking](/api-reference/customers/customer-object)\n* `order does not match validation rules` - learn more about [validation rules](/api-reference/validations/validation-object)","deprecated":true,"version":null,"openapi":"/openapi/client-side.json get /client/v1/validate","href":"/api-reference/client-side/validate-voucher-client-side","autogeneratedByOpenApi":true},{"title":"Redeem Voucher (client-side)","description":"\n\u003cDanger>\n\n\u003cBadge color=\"red\">Deprecated\u003c/Badge>\n\nThis endpoint represents the deprecated version of the API responsible for voucher redemption, and we do not recommend using it. The new [Stackable Discounts API](/api-reference/client-side/redeem-stackable-discounts-client-side) introduces additional features and improvements while maintaining backward compatibility, including applying a combination of coupon codes and promotion tiers. Developers are encouraged to migrate to the latest version to take advantage of the latest enhancements and bug fixes. No updates will be provided to the deprecated endpoint.\n\n\u003c/Danger>\n\nTo redeem a voucher, you need to create a redemption object. It increments the redemption counter and updates the history of the voucher. This method is accessible through public keys, which you can use in client-side apps (mobile and web browser apps). \n\nThe client-side redemption works similar to the server-side [voucher redemption](/api-reference/redemptions/redeem-voucher) endpoint. The difference lies in the authorization. For the client-side, you can use client-side keys.\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Opt-in\u003c/Badge>\n\nBy default this feature is disabled. If you want to use it, you will need to enable the function explicitly in **Project Settings**.\n\n\u003c/Note>\n\n\n\u003cDanger>\n\n\u003cBadge color=\"red\">Security Threat\u003c/Badge>\n\nBe careful if you want to include the voucher redemption functionality directly on your client side (website or mobile app). In this configuration, there is a chance that discounts can be modified before being sent to the server.\n\n\u003c/Danger>\n\n### Expand Response\nYou may expand the response by adding the following object to your request body. The expanded response will include the category details of the voucher.\n\n```json\n{\n \"options\": {\n \"expand\": [\n \"category\"\n ]\n }\n}\n```","deprecated":true,"version":null,"openapi":"/openapi/client-side.json post /client/v1/redeem","href":"/api-reference/client-side/redeem-voucher-client-side","autogeneratedByOpenApi":true}]},{"group":"Legacy loyalties","public":true,"root":{"title":"Legacy loyalty API","description":"Legacy loyalty API endpoints for managing loyalty campaigns, members, points, tiers, and rewards.","diataxis":"explanation","href":"/api-reference/loyalties/introduction-to-legacy-loyalty"},"pages":[{"title":"Loyalty Campaign Object","mode":"frame","description":null,"href":"/api-reference/loyalties/loyalty-campaign-object"},{"title":"Loyalty Card Object","mode":"frame","description":null,"href":"/api-reference/loyalties/loyalty-card-object"},{"title":"Loyalty Tier Object","mode":"frame","description":null,"href":"/api-reference/loyalties/loyalty-tier-object"},{"title":"Earning Rule Object","mode":"frame","description":null,"href":"/api-reference/loyalties/earning-rule-object"},{"title":"List Loyalty Campaigns","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nReturns a list of your loyalty campaigns.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties","href":"/api-reference/loyalties/list-loyalty-campaigns","autogeneratedByOpenApi":true},{"title":"Get Loyalty Campaign","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve a specific loyalty campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}","href":"/api-reference/loyalties/get-loyalty-campaign","autogeneratedByOpenApi":true},{"title":"Create Loyalty Campaign","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nCreates a batch of [loyalty cards](/api-reference/loyalties/get-member) aggregated in a single loyalty campaign. It also allows you to define a custom codes pattern. \n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Global uniqueness\u003c/Badge>\n\nAll codes are unique across the whole project. Voucherify won't allow to generate the same codes in any of your campaigns.\n\n\u003c/Note>\n\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Asynchronous action!\u003c/Badge>\n\nThis is an asynchronous action, you can't read or modify a newly created campaign until the code generation is completed. See `creation_status` field in the [loyalty campaign object](/api-reference/loyalties/loyalty-campaign-object) description.\n\n\u003c/Warning>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties","href":"/api-reference/loyalties/create-loyalty-campaign","autogeneratedByOpenApi":true},{"title":"Update Loyalty Campaign","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nUpdates a loyalty campaign. \n\nFields other than those specified in the allowed request body payload won't be modified (even if provided they are silently skipped). Any parameters not provided will be left unchanged. \n\nThis method will update the [loyalty cards](/api-reference/loyalties/get-member) which have not been published or redeemed yet.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json put /v1/loyalties/{campaignId}","href":"/api-reference/loyalties/update-loyalty-campaign","autogeneratedByOpenApi":true},{"title":"Delete Loyalty Campaign","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nDeletes a loyalty campaign and all related loyalty cards. This action cannot be undone. Also, it immediately removes any redemptions on loyalty cards.\n\nIf the `force` parameter is set to `false` or not set at all, the loyalty campaign and all related loyalty cards will be moved to [the bin](/api-reference/bin/list-bin-entries).","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json delete /v1/loyalties/{campaignId}","href":"/api-reference/loyalties/delete-loyalty-campaign","autogeneratedByOpenApi":true},{"title":"List Members","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nReturns a list of your loyalty cards. The loyalty cards are sorted by creation date, with the most recent loyalty cards appearing first.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/members","href":"/api-reference/loyalties/list-members","autogeneratedByOpenApi":true},{"title":"List Member Activity with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/members/{memberId}/activity","href":"/api-reference/loyalties/list-member-activity-with-campaign-id","autogeneratedByOpenApi":true},{"title":"List Member Activity","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-activity-with-campaign-id). The URL was re-designed to allow you to get member activities without having to provide the `campaignId` as a path parameter.\n\n\u003c/Note>\n\nRetrieves the list of activities for the given member ID related to a voucher and customer who is the holder of the voucher.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/members/{memberId}/activity","href":"/api-reference/loyalties/list-member-activity","autogeneratedByOpenApi":true},{"title":"Get Member","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve loyalty card with the given member ID (i.e. voucher code). \n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-member-with-campaign-id). The URL was re-designed to allow you to retrieve loyalty card details without having to provide the `campaignId` as a path parameter.\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/members/{memberId}","href":"/api-reference/loyalties/get-member","autogeneratedByOpenApi":true},{"title":"Get Member with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieves the loyalty card with the given member ID (i.e. voucher code).","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/members/{memberId}","href":"/api-reference/loyalties/get-member-with-campaign-id","autogeneratedByOpenApi":true},{"title":"Add Member","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nThis method assigns a loyalty card to a customer. It selects a [loyalty card](/api-reference/vouchers/get-voucher) suitable for publication, adds a publish entry, and returns the published voucher. \n\nA voucher is suitable for publication when it's active and hasn't been published yet. \n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Auto-update campaign\u003c/Badge>\n\nIn case you want to ensure the number of publishable codes increases automatically with the number of customers, you should use **auto-update** campaign.\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/members","href":"/api-reference/loyalties/add-member","autogeneratedByOpenApi":true},{"title":"Adjust Loyalty Card Balance with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nThis method adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. \n\n \u003cWarning>\n\n\u003cBadge color=\"yellow\">Async Action\u003c/Badge>\n\nThis is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.\n\n\u003c/Warning>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/members/{memberId}/balance","href":"/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id","autogeneratedByOpenApi":true},{"title":"Adjust Loyalty Card Balance","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nThis method gives adds or removes balance to an existing loyalty card that is assigned to a holder. The removal of points will consume the points that expire the soonest. \n\n\n\n \u003cWarning>\n\n\u003cBadge color=\"yellow\">Async Action\u003c/Badge>\n\nThis is an async action. If you want to perform several add or remove loyalty card balance actions in a short time and their order matters, set up sufficient time-out between the calls.\n\n\u003c/Warning>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/adjust-loyalty-card-balance-with-campaign-id). The URL was re-designed to allow you to add or remove loyalty card balance without having to provide the `campaignId` as a path parameter.\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/members/{memberId}/balance","href":"/api-reference/loyalties/adjust-loyalty-card-balance","autogeneratedByOpenApi":true},{"title":"Transfer Loyalty Points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nTransfer points between different loyalty cards which have holders.\n\nProvide the campaign ID and the loyalty card ID you want the points to be transferred to as path parameters. In the request body, provide the loyalty cards you want the points to be transferred from and the number of points to transfer from each card.\n\nTransfer works only for loyalty cards that have holders, meaning the cards were published to customers.\n\nThe transferred points expire according to the target program expiration rules.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/members/{memberId}/transfers","href":"/api-reference/loyalties/transfer-loyalty-points","autogeneratedByOpenApi":true},{"title":"List Campaign Pending Points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nLists all pending points that are currently assigned to all loyalty cards in a campaign. Once the points are added to the card, the entry is no longer returned.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Configuring pending points\u003c/Badge>\n\nPending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/pending-points","href":"/api-reference/loyalties/list-campaign-pending-points","autogeneratedByOpenApi":true},{"title":"List Member Pending Points with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nLists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Configuring pending points\u003c/Badge>\n\nPending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/members/{memberId}/pending-points","href":"/api-reference/loyalties/list-member-pending-points-with-campaign-id","autogeneratedByOpenApi":true},{"title":"List Member Pending Points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-member-pending-points-with-campaign-id). The URL was re-designed to list member pending points without having to provide the `campaignId` as a path parameter.\n\n\u003c/Note>\n\nLists all pending points that are currently assigned to the loyalty card. Once the points are added to the card, the entry is no longer returned.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Configuring pending points\u003c/Badge>\n\nPending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/members/{memberId}/pending-points","href":"/api-reference/loyalties/list-member-pending-points","autogeneratedByOpenApi":true},{"title":"Activate Member Pending Points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nActivate manually the pending points and add them to the loyalty card. The pending points are determined by the pending point ID.\n\nOnce activated, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points).\n\nThis **POST** method does not require a request body.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Configuring pending points\u003c/Badge>\n\nPending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/activate","href":"/api-reference/loyalties/activate-member-pending-points","autogeneratedByOpenApi":true},{"title":"Adjust Member Pending Points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nAdjusts the pending points with a given ID. You can add or subtract the number of points.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Configuring pending points\u003c/Badge>\n\nPending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/balance","href":"/api-reference/loyalties/adjust-member-pending-points","autogeneratedByOpenApi":true},{"title":"Cancel Member Pending Points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nCancel manually the pending points for the loyalty card. The pending points are determined by the pending point ID.\n\nOnce canceled, the pending point entry with that ID is not listed by the endpoints: List member ([with campaign ID](/api-reference/loyalties/list-member-pending-points-with-campaign-id), [without campaign ID](/api-reference/loyalties/list-member-pending-points)), [List campaign pending points](/api-reference/loyalties/list-campaign-pending-points).\n\nThis **POST** method does not require a request body and it returns an empty, 204, response.\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Configuring pending points\u003c/Badge>\n\nPending points are configured as part of an earning rule with [POST Create earning rule](/api-reference/loyalties/create-earning-rule) or [PUT Update earning rule](/api-reference/loyalties/update-earning-rule).\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/members/{memberId}/pending-points/{pendingPointsId}/cancel","href":"/api-reference/loyalties/cancel-member-pending-points","autogeneratedByOpenApi":true},{"title":"List Loyalty Campaign Transactions","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieves all transactions for the campaign with the given campaign ID or campaign name.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/transactions","href":"/api-reference/loyalties/list-loyalty-campaign-transactions","autogeneratedByOpenApi":true},{"title":"Export Loyalty Campaign Transactions","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nExport transactions is an asynchronous process that generates a CSV file with the data about or point movements on all loyalty cards in a given campaign.\n\nTo export transactions:\n1. In the export request, use parameters to select which fields will be exported, in what order, and which data will be filtered.\n2. Use the returned `id` to track the export status with the [GET Export](/api-reference/exports/get-export) method.\n3. In the GET Export method, when the returned `status` field has the `DONE` value, the export file has been generated.\n4. Use the URL in the `result` property to download the file. You must be logged to your Voucherify account on a given cluster in the browser to be able to download the file.\n\nAn export request will almost always result in a single file being generated by the system. However, when the data volume is large, the system may split the results into multiple files.\n\nAn example export file can look as follows:\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| `id` | Unique transaction ID. | `vtx_0cb7811f1c07765800` |\n| `type` | Transaction type. | - `POINTS_ACCRUAL`\u003cbr />- `POINTS_REDEMPTION`\u003cbr />- `POINTS_REFUND`\u003cbr />- `POINTS_ADDITION`\u003cbr />- `POINTS_REMOVAL`\u003cbr />- `POINTS_EXPIRATION`\u003cbr />- `POINTS_TRANSFER_IN`\u003cbr />- `POINTS_TRANSFER_OUT` |\n| `source_id` | Unique transaction source ID. Optional and only in manual operations: `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_TRANSFER_OUT`. | 8638 |\n| `reason` | Contains the reason for the transaction if one was included originally. Optional and only in the following manual operations: `POINTS_ADDITION`, `POINTS_REMOVAL`, `POINTS_TRANSFER_OUT`, `POINTS_TRANSFER_IN`. | `Apology for sending a broken item` |\n| `balance` | The gift card or loyalty card balance after the transaction. | |\n| `amount` | The amount of gift card or loyalty card credits being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| `created_at` | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | `2024-10-09T09:16:32.521Z` |\n| `voucher_id` | Unique voucher ID. | `v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp` |\n| `source`| Channel through which the transaction was initiated. | `API` |\n| `details` | More detailed information stored in the form of JSON. | Provides more details related to the transaction in the form of an object. |\n| `related_transaction_id` | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | `vtx_0c9afe802593b34b80` |\n\n\u003cTip>\n\n\u003cBadge color=\"green\">Export Campaign Transactions\u003c/Badge>\n\nThis method works in the same way the [POST Export Campaign Transactions](/api-reference/campaigns/export-campaign-transactions) does, but it is limited to loyalty campaigns only. The POST Export Campaign Transactions method can also export gift card campaign transactions.\n\n\u003c/Tip>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/transactions/export","href":"/api-reference/loyalties/export-loyalty-campaign-transactions","autogeneratedByOpenApi":true},{"title":"List Loyalty Card Transactions with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve transaction data related to point movements for a specific loyalty card.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/members/{memberId}/transactions","href":"/api-reference/loyalties/list-loyalty-card-transactions-with-campaign-id","autogeneratedByOpenApi":true},{"title":"List Loyalty Card Transactions","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve transaction data related to point movements for a specific loyalty card.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/members/{memberId}/transactions","href":"/api-reference/loyalties/list-loyalty-card-transactions","autogeneratedByOpenApi":true},{"title":"Export Loyalty Card Transactions","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nExport transactions that are associated with point movements on a loyalty card.\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 |\n| type | Transaction type. | - `POINTS_EXPIRATION` \u003cbr /> - `POINTS_ADDITION` \u003cbr /> - `POINTS_REMOVAL` \u003cbr /> - `POINTS_TRANSFER_OUT` \u003cbr /> - `POINTS_ACCRUAL` \u003cbr /> - `POINTS_REFUND` \u003cbr /> - `POINTS_REDEMPTION` |\n| source_id | Custom source ID of the transaction if one was included originally. | source_id_custom |\n| reason | Contains the reason for the transaction if one was included originally. | |\n| balance | The loyalty card balance after the transaction. | |\n| amount | The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |\n| voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |\n| campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |\n| source| Channel through which the transaction was initiated. | - `API` \u003cbr /> - `voucherify-web-ui` \u003cbr /> - `Automation` |\n| details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |\n| related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/members/{memberId}/transactions/export","href":"/api-reference/loyalties/export-loyalty-card-transactions","autogeneratedByOpenApi":true},{"title":"Export Loyalty Card Transactions with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nExport transactions that are associated with point movements on a loyalty card.\n\n| **Field** | **Definition** | **Example Export** |\n|:---|:---|:---|\n| id | Unique transaction ID assigned by Voucherify. | vtx_0cb7811f1c07765800 |\n| type | Transaction type. | - `POINTS_EXPIRATION` \u003cbr /> - `POINTS_ADDITION` \u003cbr /> - `POINTS_REMOVAL` \u003cbr /> - `POINTS_TRANSFER_OUT` \u003cbr /> - `POINTS_ACCRUAL` \u003cbr /> - `POINTS_REFUND` \u003cbr /> - `POINTS_REDEMPTION` |\n| source_id | Custom source ID of the transaction if one was included originally. | source_id_custom |\n| reason | Contains the reason for the transaction if one was included originally. | |\n| balance | The loyalty card balance after the transaction. | |\n| amount | The amount of loyalty points being allocated during the transaction. This value can either be negative or positive depending on the nature of the transaction. | |\n| created_at | Timestamp in ISO 8601 format representing the date and time when the transaction was created. | 2022-03-09T09:16:32.521Z |\n| voucher_id | Unique Voucher ID. | v_dky7ksKfPX50Wb2Bxvcoeb1xT20b6tcp |\n| campaign_id | Parent campaign ID. | camp_FNYR4jhqZBM9xTptxDGgeNBV |\n| source| Channel through which the transaction was initiated. | - `API` \u003cbr /> - `voucherify-web-ui` \u003cbr /> - `Automation` |\n| details | More detailed information stored in the form of a JSON. | Provides more details related to the transaction in the form of an object. |\n| related_transaction_id | Unique transaction ID related to a receiver/donor card in the case of a points transfer from/to another card. | vtx_0c9afe802593b34b80 |","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/members/{memberId}/transactions/export","href":"/api-reference/loyalties/export-loyalty-card-transactions-with-campaign-id","autogeneratedByOpenApi":true},{"title":"List Loyalty Card Point Expiration","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve loyalty point expiration buckets for a given loyalty card. Expired point buckets are not returned in this endpoint. You can use the [Exports API](/api-reference/exports/create-export) to retrieve a list of both `ACTIVE` and `EXPIRED` point buckets.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/members/{memberId}/points-expiration","href":"/api-reference/loyalties/list-loyalty-card-point-expiration","autogeneratedByOpenApi":true},{"title":"Export Loyalty Campaign Point Expiration","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nSchedule the generation of a point expiration CSV file for a particular campaign. It can list point buckets, which can have an `ACTIVE` or `EXPIRED` status.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/points-expiration/export","href":"/api-reference/loyalties/export-loyalty-campaign-point-expiration","autogeneratedByOpenApi":true},{"title":"List Earning Rules","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nReturns a list of all earning rules within a given campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/earning-rules","href":"/api-reference/loyalties/list-earning-rules","autogeneratedByOpenApi":true},{"title":"Get Earning Rule","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieves an earning rule assigned to a campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}","href":"/api-reference/loyalties/get-earning-rule","autogeneratedByOpenApi":true},{"title":"Create Earning Rule","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nCreate earning rules for a loyalty campaign.\n\n\u003cWarning>\n\n\u003cBadge color=\"yellow\">Maximum number of earning rules\u003c/Badge>\n\nYou can create up to 100 earning rules per project. The limit can be customized for clients with a single-tenant setup.\n\n\u003c/Warning>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/earning-rules","href":"/api-reference/loyalties/create-earning-rule","autogeneratedByOpenApi":true},{"title":"Update Earning Rule","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nUpdate an earning rule definition.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json put /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}","href":"/api-reference/loyalties/update-earning-rule","autogeneratedByOpenApi":true},{"title":"Delete Earning Rule","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nThis method deletes an earning rule for a specific loyalty campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json delete /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}","href":"/api-reference/loyalties/delete-earning-rule","autogeneratedByOpenApi":true},{"title":"Enable Earning Rule","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nEnable an earning rule.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable","href":"/api-reference/loyalties/enable-earning-rule","autogeneratedByOpenApi":true},{"title":"Disable Earning Rule","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nDisable an earning rule.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable","href":"/api-reference/loyalties/disable-earning-rule","autogeneratedByOpenApi":true},{"title":"List Member Rewards","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieves the list of rewards that the given customer (identified by `member_id`, which is a loyalty card assigned to a particular customer) **can get in exchange for loyalty points**. \n\nYou can use the `affordable_only` parameter to limit the results to rewards that the customer can actually afford (only rewards whose price in points is not higher than the loyalty points balance on a loyalty card). \n\nPlease note that rewards that are disabled (i.e. set to `Not Available` in the Dashboard) for a given loyalty tier reward mapping will not be returned in this endpoint.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/members/{memberId}/rewards","href":"/api-reference/loyalties/list-member-rewards","autogeneratedByOpenApi":true},{"title":"Get Reward Details","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nGet reward details in the context of a loyalty campaign and reward assignment ID.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward","href":"/api-reference/loyalties/get-reward-details","autogeneratedByOpenApi":true},{"title":"Redeem Reward","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/redeem-reward-with-campaign-id). The URL was re-designed to allow you to redeem a reward without having to provide the `campaignId` as a path parameter.\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/members/{memberId}/redemption","href":"/api-reference/loyalties/redeem-reward","autogeneratedByOpenApi":true},{"title":"Redeem Reward with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nExchange points from a loyalty card for a specified reward. This API method returns an assigned award in the response. It means that if a requesting customer gets a coupon code with a discount for the next order, that discount code will be visible in response as part of the reward object definition.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/members/{memberId}/redemption","href":"/api-reference/loyalties/redeem-reward-with-campaign-id","autogeneratedByOpenApi":true},{"title":"Estimate loyalty points","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nEstimates the number of points a customer will receive for a given order in the loyalty campaign under its earning rules. This endpoint also returns point estimation for created transactions (orders with status `PAID`)\n\nThis endpoint returns only an estimation, not a precise point value.\n\nAlso, this estimation works only for the Order paid earning rules. If a campaign includes tiers, mappings, and multiple earning rules, the calculation becomes more complex. During final calculation, a customer may change tiers and earn more or fewer points depending on other factors.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/qualifications","href":"/api-reference/loyalties/estimate-loyalty-points","autogeneratedByOpenApi":true},{"title":"List Reward Assignments with campaign ID","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nReturns reward assignments from a given loyalty campaign.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/list-campaign-rewards). The URL was re-designed to be more contextual to the type of data returned in the response.\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/reward-assignments","href":"/api-reference/loyalties/list-reward-assignments-with-campaign-id","autogeneratedByOpenApi":true},{"title":"List Campaign Rewards","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nReturns active rewards from a given loyalty campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/rewards","href":"/api-reference/loyalties/list-campaign-rewards","autogeneratedByOpenApi":true},{"title":"Get Campaign Reward Assignments","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve specific reward assignment.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}","href":"/api-reference/loyalties/get-campaign-reward-assignments","autogeneratedByOpenApi":true},{"title":"Get Campaign Reward Assignment","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve specific reward assignment.\n\n\u003cNote>\n\n\u003cBadge color=\"blue\">Alternative endpoint\u003c/Badge>\n\nThis endpoint is an alternative to this [endpoint](/api-reference/loyalties/get-campaign-reward-assignments).\n\n\u003c/Note>","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/rewards/{assignmentId}","href":"/api-reference/loyalties/get-campaign-reward-assignment","autogeneratedByOpenApi":true},{"title":"Create Loyalty Campaign Reward Assignment","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nAdd rewards to a loyalty campaign.\n\nA `LOYALTY_POINTS` reward cannot be assigned to a campaign. Use **POST** `v1/rewards/{rewardId}/assignments` with `related_object_type` `referral_tier` instead.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/rewards","href":"/api-reference/loyalties/create-loyalty-campaign-reward-assignment","autogeneratedByOpenApi":true},{"title":"Update Campaign Reward Assignment","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nUpdates rewards parameters, i.e. the points cost for the specific reward.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json put /v1/loyalties/{campaignId}/rewards/{assignmentId}","href":"/api-reference/loyalties/update-campaign-reward-assignment","autogeneratedByOpenApi":true},{"title":"Delete Campaign Reward Assignment","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nThis method deletes a reward assignment for a particular loyalty campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json delete /v1/loyalties/{campaignId}/rewards/{assignmentId}","href":"/api-reference/loyalties/delete-campaign-reward-assignment","autogeneratedByOpenApi":true},{"title":"List Loyalty Tiers","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve a list of loyalty tiers which were added to the loyalty program.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/tiers","href":"/api-reference/loyalties/list-loyalty-tiers","autogeneratedByOpenApi":true},{"title":"Get Loyalty Tier","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve a loyalty tier from a loyalty campaign by the loyalty tier ID.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}","href":"/api-reference/loyalties/get-loyalty-tier","autogeneratedByOpenApi":true},{"title":"Create loyalty tiers","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nCreates loyalty tiers for desired campaign.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json post /v1/loyalties/{campaignId}/tiers","href":"/api-reference/loyalties/create-loyalty-tiers","autogeneratedByOpenApi":true},{"title":"List Member's Loyalty Tiers","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve member tiers using the loyalty card ID.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/members/{memberId}/tiers","href":"/api-reference/loyalties/list-members-loyalty-tiers","autogeneratedByOpenApi":true},{"title":"List Loyalty Tier Earning Rules","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nRetrieve available earning rules for a given tier and the calculation method for earning points.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules","href":"/api-reference/loyalties/list-loyalty-tier-earning-rules","autogeneratedByOpenApi":true},{"title":"List Loyalty Tier Rewards","description":"\u003cWarning>\n\n\u003cBadge color=\"yellow\">Legacy loyalty API\u003c/Badge>\n\nThis endpoint belongs to the legacy loyalty API (`/v1/loyalties`).\n\nVoucherify will not develop new features for this API. However, critical issues may still receive fixes.\n\nFor new integrations, use [Loyalty v2](/build/loyalty-overview).\n\nIf you have questions, contact [Voucherify support](https://www.voucherify.io/contact-support \"Contact Voucherify support\").\n\n\u003c/Warning>\n\nGet available rewards for a given tier.","deprecated":true,"version":null,"openapi":"/openapi/loyalties.json get /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards","href":"/api-reference/loyalties/list-loyalty-tier-rewards","autogeneratedByOpenApi":true}]}]},{"group":"Events","public":true,"pages":[{"group":"Webhooks","public":true,"root":{"title":"Introduction to Voucherify webhooks","description":"Use webhooks to get notified about project, distribution, and Workflows events in Voucherify","keywords":["project","distribution","workflows","webhook","structure","callback","tracking","monitoring","notification","event"],"diataxis":"explanation","href":"/api-reference/introduction-to-webhooks"},"pages":[{"title":"Project settings webhooks","description":"Use webhooks to get notified about project events in Voucherify","keywords":["project","configure","re-enable","webhook","event","webhook payload"],"diataxis":"reference","href":"/api-reference/project-settings-webhooks"},{"title":"Distribution webhooks","description":"Use webhooks to get notified about distribution events in Voucherify","keywords":["webhook","payload","configure","distribution","event","webhook payload"],"diataxis":"reference","href":"/api-reference/distribution-webhooks"},{"title":"Workflows webhooks","description":"Receive Loyalty v2 transaction and activity events from Workflows webhook callouts","keywords":["workflows","webhook","loyalty v2","loyalty transaction","loyalty activity","webhook callout"],"diataxis":"reference","href":"/api-reference/workflows-webhooks"}]},{"group":"Loyalty transactions","public":true,"pages":[{"group":"Card transactions","public":true,"pages":[{"title":"Admin credit","description":"Event data sent for a Loyalty v2 ADMIN_CREDIT transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook ADMIN_CREDIT","keywords":["loyalty v2","workflow","webhook","admin credit","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/admin-credit"},{"title":"Admin debit","description":"Event data sent for a Loyalty v2 ADMIN_DEBIT transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook ADMIN_DEBIT","keywords":["loyalty v2","workflow","webhook","admin debit","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/admin-debit"},{"title":"Admin points expiration","description":"Event data sent for a Loyalty v2 ADMIN_POINTS_EXPIRATION transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook ADMIN_POINTS_EXPIRATION","keywords":["loyalty v2","workflow","webhook","admin points expiration","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/admin-points-expiration"},{"title":"Points earned","description":"Event data sent for a Loyalty v2 POINTS_EARNED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_EARNED","keywords":["loyalty v2","workflow","webhook","points earned","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-earned"},{"title":"Points spent on reward","description":"Event data sent for a Loyalty v2 POINTS_SPENT_ON_REWARD transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_SPENT_ON_REWARD","keywords":["loyalty v2","workflow","webhook","points spent on reward","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-spent-on-reward"},{"title":"Points purchased","description":"Event data sent for a Loyalty v2 POINTS_PURCHASED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_PURCHASED","keywords":["loyalty v2","workflow","webhook","points purchased","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-purchased"},{"title":"Points purchase reversed","description":"Event data sent for a Loyalty v2 POINTS_PURCHASE_REVERSED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_PURCHASE_REVERSED","keywords":["loyalty v2","workflow","webhook","points purchase reversed","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-purchase-reversed"},{"title":"Points spent on order","description":"Event data sent for a Loyalty v2 POINTS_SPENT_ON_ORDER transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_SPENT_ON_ORDER","keywords":["loyalty v2","workflow","webhook","points spent on order","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-spent-on-order"},{"title":"Points refunded","description":"Event data sent for a Loyalty v2 POINTS_REFUNDED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_REFUNDED","keywords":["loyalty v2","workflow","webhook","points refunded","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-refunded"},{"title":"Points returned","description":"Event data sent for a Loyalty v2 POINTS_RETURNED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_RETURNED","keywords":["loyalty v2","workflow","webhook","points returned","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-returned"},{"title":"Points expired","description":"Event data sent for a Loyalty v2 POINTS_EXPIRED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook POINTS_EXPIRED","keywords":["loyalty v2","workflow","webhook","points expired","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/points-expired"},{"title":"Pending points added","description":"Event data sent for a Loyalty v2 PENDING_POINTS_ADDED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook PENDING_POINTS_ADDED","keywords":["loyalty v2","workflow","webhook","pending points added","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/pending-points-added"},{"title":"Pending points activated","description":"Event data sent for a Loyalty v2 PENDING_POINTS_ACTIVATED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook PENDING_POINTS_ACTIVATED","keywords":["loyalty v2","workflow","webhook","pending points activated","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/pending-points-activated"},{"title":"Pending points canceled","description":"Event data sent for a Loyalty v2 PENDING_POINTS_CANCELED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook PENDING_POINTS_CANCELED","keywords":["loyalty v2","workflow","webhook","pending points canceled","card transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/card/pending-points-canceled"}]},{"group":"Order transactions","public":true,"pages":[{"title":"Pay with points","description":"Event data sent for a Loyalty v2 PAY_WITH_POINTS transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook PAY_WITH_POINTS","keywords":["loyalty v2","workflow","webhook","pay with points","order transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/order/pay-with-points"}]},{"group":"Tier transactions","public":true,"pages":[{"title":"Upgraded","description":"Event data sent for a Loyalty v2 UPGRADED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook UPGRADED","keywords":["loyalty v2","workflow","webhook","tier upgraded","tier transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/tier/upgraded"},{"title":"Downgraded","description":"Event data sent for a Loyalty v2 DOWNGRADED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook DOWNGRADED","keywords":["loyalty v2","workflow","webhook","tier downgraded","tier transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/tier/downgraded"},{"title":"Joined","description":"Event data sent for a Loyalty v2 JOINED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook JOINED","keywords":["loyalty v2","workflow","webhook","tier joined","tier transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/tier/joined"},{"title":"Left","description":"Event data sent for a Loyalty v2 LEFT transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook LEFT","keywords":["loyalty v2","workflow","webhook","tier left","tier transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/tier/left"},{"title":"Expiration changed","description":"Event data sent for a Loyalty v2 EXPIRATION_CHANGED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook EXPIRATION_CHANGED","keywords":["loyalty v2","workflow","webhook","tier expiration changed","tier transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/tier/expiration-changed"},{"title":"Evaluation refreshed","description":"Event data sent for a Loyalty v2 EVALUATION_REFRESHED transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook EVALUATION_REFRESHED","keywords":["loyalty v2","workflow","webhook","tier evaluation refreshed","tier transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/tier/evaluation-refreshed"}]},{"group":"Reward transactions","public":true,"pages":[{"title":"Purchase","description":"Event data sent for a Loyalty v2 PURCHASE transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook PURCHASE","keywords":["loyalty v2","workflow","webhook","reward purchase","reward transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/reward/purchase"},{"title":"Refund","description":"Event data sent for a Loyalty v2 REFUND transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook REFUND","keywords":["loyalty v2","workflow","webhook","reward refund","reward transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/reward/refund"}]},{"group":"Benefit transactions","public":true,"pages":[{"title":"Fulfillment","description":"Event data sent for a Loyalty v2 FULFILLMENT transaction handled by Workflows","openapi":"openapi-events/events-loyalty-transaction.json webhook FULFILLMENT","keywords":["loyalty v2","workflow","webhook","benefit fulfillment","benefit transaction"],"diataxis":"reference","href":"/api-reference/loyalty-transactions/benefit/fulfillment"}]}]},{"group":"Loyalty activity","public":true,"pages":[{"group":"Programs","public":true,"root":{"title":"Programs activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 program or its assignments change","keywords":["loyalty v2","loyalty activity","program events","workflows"],"diataxis":"explanation","href":"/api-reference/programs-activity-overview"},"pages":[{"title":"Program created","description":"Event data sent for a Loyalty v2 vl.program.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.created","keywords":["loyalty v2","workflow","webhook","program created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/created"},{"title":"Program updated","description":"Event data sent for a Loyalty v2 vl.program.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.updated","keywords":["loyalty v2","workflow","webhook","program updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/updated"},{"title":"Program deleted","description":"Event data sent for a Loyalty v2 vl.program.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.deleted","keywords":["loyalty v2","workflow","webhook","program deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/deleted"},{"title":"Program activated","description":"Event data sent for a Loyalty v2 vl.program.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.activated","keywords":["loyalty v2","workflow","webhook","program activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/activated"},{"title":"Program deactivated","description":"Event data sent for a Loyalty v2 vl.program.deactivated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.deactivated","keywords":["loyalty v2","workflow","webhook","program deactivated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/deactivated"},{"title":"Program card definition assigned","description":"Event data sent for a Loyalty v2 vl.program.card_definition.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.card_definition.assigned","keywords":["loyalty v2","workflow","webhook","program card definition assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/card-definition-assigned"},{"title":"Program card definition unassigned","description":"Event data sent for a Loyalty v2 vl.program.card_definition.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.card_definition.unassigned","keywords":["loyalty v2","workflow","webhook","program card definition unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/card-definition-unassigned"},{"title":"Program earning rule assigned","description":"Event data sent for a Loyalty v2 vl.program.earning_rule.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.earning_rule.assigned","keywords":["loyalty v2","workflow","webhook","program earning rule assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/earning-rule-assigned"},{"title":"Program earning rule unassigned","description":"Event data sent for a Loyalty v2 vl.program.earning_rule.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.earning_rule.unassigned","keywords":["loyalty v2","workflow","webhook","program earning rule unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/earning-rule-unassigned"},{"title":"Program reward assigned","description":"Event data sent for a Loyalty v2 vl.program.reward.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.reward.assigned","keywords":["loyalty v2","workflow","webhook","program reward assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/reward-assigned"},{"title":"Program reward unassigned","description":"Event data sent for a Loyalty v2 vl.program.reward.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.reward.unassigned","keywords":["loyalty v2","workflow","webhook","program reward unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/reward-unassigned"},{"title":"Program reward updated","description":"Event data sent for a Loyalty v2 vl.program.reward.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.reward.updated","keywords":["loyalty v2","workflow","webhook","program reward updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/reward-updated"},{"title":"Program tier structure assigned","description":"Event data sent for a Loyalty v2 vl.program.tier_structure.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.tier_structure.assigned","keywords":["loyalty v2","workflow","webhook","program tier structure assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/tier-structure-assigned"},{"title":"Program tier structure unassigned","description":"Event data sent for a Loyalty v2 vl.program.tier_structure.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.program.tier_structure.unassigned","keywords":["loyalty v2","workflow","webhook","program tier structure unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/programs/tier-structure-unassigned"}]},{"group":"Card definitions","public":true,"root":{"title":"Card definitions activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 card definition changes or is assigned to a program","keywords":["loyalty v2","loyalty activity","card definition events","point wallets","workflows"],"diataxis":"explanation","href":"/api-reference/card-definitions-activity-overview"},"pages":[{"title":"Card definition created","description":"Event data sent for a Loyalty v2 vl.card_definition.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.created","keywords":["loyalty v2","workflow","webhook","card definition created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/created"},{"title":"Card definition updated","description":"Event data sent for a Loyalty v2 vl.card_definition.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.updated","keywords":["loyalty v2","workflow","webhook","card definition updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/updated"},{"title":"Card definition deleted","description":"Event data sent for a Loyalty v2 vl.card_definition.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.deleted","keywords":["loyalty v2","workflow","webhook","card definition deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/deleted"},{"title":"Card definition activated","description":"Event data sent for a Loyalty v2 vl.card_definition.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.activated","keywords":["loyalty v2","workflow","webhook","card definition activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/activated"},{"title":"Card definition drafted","description":"Event data sent for a Loyalty v2 vl.card_definition.drafted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.drafted","keywords":["loyalty v2","workflow","webhook","card definition drafted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/drafted"},{"title":"Card definition assigned","description":"Event data sent for a Loyalty v2 vl.card_definition.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.assigned","keywords":["loyalty v2","workflow","webhook","card definition assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/assigned"},{"title":"Card definition unassigned","description":"Event data sent for a Loyalty v2 vl.card_definition.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card_definition.unassigned","keywords":["loyalty v2","workflow","webhook","card definition unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/card-definitions/unassigned"}]},{"group":"Earning rules","public":true,"root":{"title":"Earning rules activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 earning rule changes or is assigned to a program","keywords":["loyalty v2","loyalty activity","earning rule events","workflows"],"diataxis":"explanation","href":"/api-reference/earning-rules-activity-overview"},"pages":[{"title":"Earning rule created","description":"Event data sent for a Loyalty v2 vl.earning_rule.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.created","keywords":["loyalty v2","workflow","webhook","earning rule created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/created"},{"title":"Earning rule updated","description":"Event data sent for a Loyalty v2 vl.earning_rule.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.updated","keywords":["loyalty v2","workflow","webhook","earning rule updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/updated"},{"title":"Earning rule deleted","description":"Event data sent for a Loyalty v2 vl.earning_rule.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.deleted","keywords":["loyalty v2","workflow","webhook","earning rule deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/deleted"},{"title":"Earning rule activated","description":"Event data sent for a Loyalty v2 vl.earning_rule.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.activated","keywords":["loyalty v2","workflow","webhook","earning rule activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/activated"},{"title":"Earning rule deactivated","description":"Event data sent for a Loyalty v2 vl.earning_rule.deactivated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.deactivated","keywords":["loyalty v2","workflow","webhook","earning rule deactivated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/deactivated"},{"title":"Earning rule drafted","description":"Event data sent for a Loyalty v2 vl.earning_rule.drafted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.drafted","keywords":["loyalty v2","workflow","webhook","earning rule drafted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/drafted"},{"title":"Earning rule assigned","description":"Event data sent for a Loyalty v2 vl.earning_rule.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.assigned","keywords":["loyalty v2","workflow","webhook","earning rule assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/assigned"},{"title":"Earning rule unassigned","description":"Event data sent for a Loyalty v2 vl.earning_rule.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.earning_rule.unassigned","keywords":["loyalty v2","workflow","webhook","earning rule unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/earning-rules/unassigned"}]},{"group":"Rewards","public":true,"root":{"title":"Rewards activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 reward changes or is assigned to a program","keywords":["loyalty v2","loyalty activity","reward events","workflows"],"diataxis":"explanation","href":"/api-reference/rewards-activity-overview"},"pages":[{"title":"Reward created","description":"Event data sent for a Loyalty v2 vl.reward.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.created","keywords":["loyalty v2","workflow","webhook","reward created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/created"},{"title":"Reward updated","description":"Event data sent for a Loyalty v2 vl.reward.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.updated","keywords":["loyalty v2","workflow","webhook","reward updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/updated"},{"title":"Reward deleted","description":"Event data sent for a Loyalty v2 vl.reward.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.deleted","keywords":["loyalty v2","workflow","webhook","reward deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/deleted"},{"title":"Reward assigned","description":"Event data sent for a Loyalty v2 vl.reward.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.assigned","keywords":["loyalty v2","workflow","webhook","reward assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/assigned"},{"title":"Reward unassigned","description":"Event data sent for a Loyalty v2 vl.reward.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.unassigned","keywords":["loyalty v2","workflow","webhook","reward unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/unassigned"},{"title":"Reward activated","description":"Event data sent for a Loyalty v2 vl.reward.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.activated","keywords":["loyalty v2","workflow","webhook","reward activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/activated"},{"title":"Reward deactivated","description":"Event data sent for a Loyalty v2 vl.reward.deactivated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.deactivated","keywords":["loyalty v2","workflow","webhook","reward deactivated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/deactivated"},{"title":"Reward drafted","description":"Event data sent for a Loyalty v2 vl.reward.drafted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.reward.drafted","keywords":["loyalty v2","workflow","webhook","reward drafted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/rewards/drafted"}]},{"group":"Benefits","public":true,"root":{"title":"Benefits activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 benefit is created, changed, or activated","keywords":["loyalty v2","loyalty activity","benefit events","workflows"],"diataxis":"explanation","href":"/api-reference/benefits-activity-overview"},"pages":[{"title":"Benefit created","description":"Event data sent for a Loyalty v2 vl.benefit.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.benefit.created","keywords":["loyalty v2","workflow","webhook","benefit created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/benefits/created"},{"title":"Benefit updated","description":"Event data sent for a Loyalty v2 vl.benefit.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.benefit.updated","keywords":["loyalty v2","workflow","webhook","benefit updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/benefits/updated"},{"title":"Benefit deleted","description":"Event data sent for a Loyalty v2 vl.benefit.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.benefit.deleted","keywords":["loyalty v2","workflow","webhook","benefit deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/benefits/deleted"},{"title":"Benefit activated","description":"Event data sent for a Loyalty v2 vl.benefit.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.benefit.activated","keywords":["loyalty v2","workflow","webhook","benefit activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/benefits/activated"},{"title":"Benefit drafted","description":"Event data sent for a Loyalty v2 vl.benefit.drafted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.benefit.drafted","keywords":["loyalty v2","workflow","webhook","benefit drafted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/benefits/drafted"}]},{"group":"Tier structures","public":true,"root":{"title":"Tier structures activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 tier structure or its tiers change","keywords":["loyalty v2","loyalty activity","tier structure events","tier events","workflows"],"diataxis":"explanation","href":"/api-reference/tier-structures-activity-overview"},"pages":[{"title":"Tier structure created","description":"Event data sent for a Loyalty v2 vl.tier_structure.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.created","keywords":["loyalty v2","workflow","webhook","tier structure created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/created"},{"title":"Tier structure updated","description":"Event data sent for a Loyalty v2 vl.tier_structure.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.updated","keywords":["loyalty v2","workflow","webhook","tier structure updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/updated"},{"title":"Tier structure deleted","description":"Event data sent for a Loyalty v2 vl.tier_structure.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.deleted","keywords":["loyalty v2","workflow","webhook","tier structure deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/deleted"},{"title":"Tier structure activated","description":"Event data sent for a Loyalty v2 vl.tier_structure.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.activated","keywords":["loyalty v2","workflow","webhook","tier structure activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/activated"},{"title":"Tier structure deactivated","description":"Event data sent for a Loyalty v2 vl.tier_structure.deactivated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.deactivated","keywords":["loyalty v2","workflow","webhook","tier structure deactivated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/deactivated"},{"title":"Tier structure drafted","description":"Event data sent for a Loyalty v2 vl.tier_structure.drafted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.drafted","keywords":["loyalty v2","workflow","webhook","tier structure drafted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/drafted"},{"title":"Tier structure assigned","description":"Event data sent for a Loyalty v2 vl.tier_structure.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.assigned","keywords":["loyalty v2","workflow","webhook","tier structure assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/assigned"},{"title":"Tier structure unassigned","description":"Event data sent for a Loyalty v2 vl.tier_structure.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.unassigned","keywords":["loyalty v2","workflow","webhook","tier structure unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/unassigned"},{"title":"Tier created","description":"Event data sent for a Loyalty v2 vl.tier_structure.tier.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.tier.created","keywords":["loyalty v2","workflow","webhook","tier created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/tier-created"},{"title":"Tier updated","description":"Event data sent for a Loyalty v2 vl.tier_structure.tier.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.tier.updated","keywords":["loyalty v2","workflow","webhook","tier updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/tier-updated"},{"title":"Tier deleted","description":"Event data sent for a Loyalty v2 vl.tier_structure.tier.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.tier_structure.tier.deleted","keywords":["loyalty v2","workflow","webhook","tier deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/tier-structures/tier-deleted"}]},{"group":"Members","public":true,"root":{"title":"Members activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 member is enrolled, changed, or assigned a loyalty card","keywords":["loyalty v2","loyalty activity","member events","workflows"],"diataxis":"explanation","href":"/api-reference/members-activity-overview"},"pages":[{"title":"Member created","description":"Event data sent for a Loyalty v2 vl.member.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.created","keywords":["loyalty v2","workflow","webhook","member created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/created"},{"title":"Member updated","description":"Event data sent for a Loyalty v2 vl.member.updated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.updated","keywords":["loyalty v2","workflow","webhook","member updated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/updated"},{"title":"Member deleted","description":"Event data sent for a Loyalty v2 vl.member.deleted activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.deleted","keywords":["loyalty v2","workflow","webhook","member deleted","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/deleted"},{"title":"Member activated","description":"Event data sent for a Loyalty v2 vl.member.activated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.activated","keywords":["loyalty v2","workflow","webhook","member activated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/activated"},{"title":"Member deactivated","description":"Event data sent for a Loyalty v2 vl.member.deactivated activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.deactivated","keywords":["loyalty v2","workflow","webhook","member deactivated","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/deactivated"},{"title":"Member card assigned","description":"Event data sent for a Loyalty v2 vl.member.card.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.card.assigned","keywords":["loyalty v2","workflow","webhook","member card assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/card-assigned"},{"title":"Member card unassigned","description":"Event data sent for a Loyalty v2 vl.member.card.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.member.card.unassigned","keywords":["loyalty v2","workflow","webhook","member card unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/members/card-unassigned"}]},{"group":"Cards","public":true,"root":{"title":"Cards activity: Overview","description":"Understand the Loyalty activity events recorded when a Loyalty v2 loyalty card is created, assigned, or gets its code","keywords":["loyalty v2","loyalty activity","card events","loyalty cards","workflows"],"diataxis":"explanation","href":"/api-reference/cards-activity-overview"},"pages":[{"title":"Card created","description":"Event data sent for a Loyalty v2 vl.card.created activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card.created","keywords":["loyalty v2","workflow","webhook","card created","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/cards/created"},{"title":"Card assigned","description":"Event data sent for a Loyalty v2 vl.card.assigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card.assigned","keywords":["loyalty v2","workflow","webhook","card assigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/cards/assigned"},{"title":"Card unassigned","description":"Event data sent for a Loyalty v2 vl.card.unassigned activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card.unassigned","keywords":["loyalty v2","workflow","webhook","card unassigned","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/cards/unassigned"},{"title":"Card code generation succeeded","description":"Event data sent for a Loyalty v2 vl.card.code_generation.succeeded activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card.code_generation.succeeded","keywords":["loyalty v2","workflow","webhook","card code generation succeeded","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/cards/code-generation-succeeded"},{"title":"Card code generation failed","description":"Event data sent for a Loyalty v2 vl.card.code_generation.failed activity handled by Workflows","openapi":"openapi-events/events-loyalty-activity.json webhook vl.card.code_generation.failed","keywords":["loyalty v2","workflow","webhook","card code generation failed","loyalty activity"],"diataxis":"reference","href":"/api-reference/loyalty-activity/cards/code-generation-failed"}]}]},{"group":"Redemption","public":true,"pages":[{"title":"Succeeded","description":"","openapi":"openapi-events/events-redemption.json webhook EVENTS.REDEMPTION.SUCCEEDED","diataxis":"reference","href":"/api-reference/redemption/succeeded"},{"title":"Failed","description":"","openapi":"openapi-events/events-redemption.json webhook EVENTS.REDEMPTION.FAILED","diataxis":"reference","href":"/api-reference/redemption/failed"},{"title":"Rollback Succeeded","description":"","openapi":"openapi-events/events-redemption.json webhook EVENTS.REDEMPTION.ROLLBACK.SUCCEEDED","diataxis":"reference","href":"/api-reference/redemption/rollback-succeeded"},{"title":"Rollback Failed","description":"","openapi":"openapi-events/events-redemption.json webhook EVENTS.REDEMPTION.ROLLBACK.FAILED","diataxis":"reference","href":"/api-reference/redemption/rollback-failed"}]},{"group":"Customer","public":true,"pages":[{"title":"Created","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.CREATED","keywords":["customer","create"],"diataxis":"reference","href":"/api-reference/customer/created"},{"title":"Updated","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.UPDATED","keywords":["customer","update"],"diataxis":"reference","href":"/api-reference/customer/updated"},{"title":"Deleted","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.DELETED","keywords":["customer","delete"],"diataxis":"reference","href":"/api-reference/customer/deleted"},{"title":"Redemption Succeeded","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REDEMPTION.SUCCEEDED","keywords":["redemption","success"],"diataxis":"reference","href":"/api-reference/customer/redemption-succeeded"},{"title":"Redemption Rollback Succeeded","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REDEMPTION.ROLLBACK.SUCCEEDED","keywords":["redemption","rollback","success"],"diataxis":"reference","href":"/api-reference/customer/redemption-rollback-succeeded"},{"title":"Rewarded","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REWARDED","keywords":["customer","reward"],"diataxis":"reference","href":"/api-reference/customer/rewarded"},{"title":"Rewarded Loyalty Points","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REWARDED.LOYALTY_POINTS","keywords":["reward","loyalty","points"],"diataxis":"reference","href":"/api-reference/customer/rewarded-loyalty-points"},{"title":"Reward Redemptions Created","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REWARD_REDEMPTIONS.CREATED","keywords":["reward","redemption","create"],"diataxis":"reference","href":"/api-reference/customer/reward-redemptions-created"},{"title":"Reward Redemptions Pending","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REWARD_REDEMPTIONS.PENDING","keywords":["reward","redemption","pending"],"diataxis":"reference","href":"/api-reference/customer/reward-redemptions-pending"},{"title":"Reward Redemptions Completed","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.REWARD_REDEMPTIONS.COMPLETED","keywords":["reward","redemption","complete"],"diataxis":"reference","href":"/api-reference/customer/reward-redemptions-completed"},{"title":"Voucher Loyalty Card Pending Points Activated","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ACTIVATED","keywords":["loyalty","card","pending points","active"],"diataxis":"reference","href":"/api-reference/customer/voucher-loyalty-card-pending-points-activated"},{"title":"Voucher Loyalty Card Pending Points Added","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ADDED","keywords":["loyalty","card","pending points","add"],"diataxis":"reference","href":"/api-reference/customer/voucher-loyalty-card-pending-points-added"},{"title":"Voucher Loyalty Card Pending Points Canceled","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.CANCELED","keywords":["loyalty","card","pending points","cancel"],"diataxis":"reference","href":"/api-reference/customer/voucher-loyalty-card-pending-points-canceled"},{"title":"Voucher Loyalty Card Pending Points Updated","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.PENDING_POINTS.UPDATED","keywords":["loyalty","card","pending points","update"],"diataxis":"reference","href":"/api-reference/customer/voucher-loyalty-card-pending-points-updated"},{"title":"Voucher Loyalty Card Points Added","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.POINTS_ADDED","keywords":["loyalty","card","points","add"],"diataxis":"reference","href":"/api-reference/customer/voucher-loyalty-card-points-added"},{"title":"Voucher Loyalty Card Points Expired","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.POINTS_EXPIRED","keywords":["loyalty","card","points","expire"],"diataxis":"reference","href":"/api-reference/customer/voucher-loyalty-card-points-expired"},{"title":"Voucher Gift Balance Added","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.VOUCHER.GIFT.BALANCE_ADDED","keywords":["gift","balance","add"],"diataxis":"reference","href":"/api-reference/customer/voucher-gift-balance-added"},{"title":"Segment Entered","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.SEGMENT.ENTERED","keywords":["segment","enter"],"diataxis":"reference","href":"/api-reference/customer/segment-entered"},{"title":"Segment Left","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.SEGMENT.LEFT","keywords":["segment","leave"],"diataxis":"reference","href":"/api-reference/customer/segment-left"},{"title":"Loyalty Tier Joined","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.LOYALTY.TIER.JOINED","keywords":["loyalty","tier","join"],"diataxis":"reference","href":"/api-reference/customer/loyalty-tier-joined"},{"title":"Loyalty Tier Upgraded","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.LOYALTY.TIER.UPGRADED","keywords":["loyalty","tier","upgrade"],"diataxis":"reference","href":"/api-reference/customer/loyalty-tier-upgraded"},{"title":"Loyalty Tier Downgraded","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.LOYALTY.TIER.DOWNGRADED","keywords":["loyalty","tier","downgrade"],"diataxis":"reference","href":"/api-reference/customer/loyalty-tier-downgraded"},{"title":"Loyalty Tier Prolonged","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.LOYALTY.TIER.PROLONGED","keywords":["loyalty","tier","prolong"],"diataxis":"reference","href":"/api-reference/customer/loyalty-tier-prolonged"},{"title":"Loyalty Tier Left","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.LOYALTY.TIER.LEFT","keywords":["loyalty","tier","leave"],"diataxis":"reference","href":"/api-reference/customer/loyalty-tier-left"},{"title":"Holder Assignment Created","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.HOLDER.ASSIGNMENT.CREATED","keywords":["holder","assignment","create"],"diataxis":"reference","href":"/api-reference/customer/holder-assignment-created"},{"title":"Holder Assignment Deleted","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.HOLDER.ASSIGNMENT.DELETED","keywords":["holder","assignment","delete"],"diataxis":"reference","href":"/api-reference/customer/holder-assignment-deleted"},{"title":"Order Created","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.ORDER.CREATED","keywords":["order","create"],"diataxis":"reference","href":"/api-reference/customer/order-created"},{"title":"Order Paid","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.ORDER.PAID","keywords":["order","pay"],"diataxis":"reference","href":"/api-reference/customer/order-paid"},{"title":"Order Updated","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.ORDER.UPDATED","keywords":["order","update"],"diataxis":"reference","href":"/api-reference/customer/order-updated"},{"title":"Order Canceled","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.ORDER.CANCELED","keywords":["order","cancel"],"diataxis":"reference","href":"/api-reference/customer/order-canceled"},{"title":"Publication Succeeded","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED","keywords":["publication","success"],"diataxis":"reference","href":"/api-reference/customer/publication-succeeded"},{"title":"Custom Event","description":"","openapi":"openapi-events/events-customer.json webhook EVENTS.CUSTOMER.CUSTOM_EVENT","keywords":["customer","custom event"],"diataxis":"reference","href":"/api-reference/customer/custom-event"}]},{"group":"Publication","public":true,"pages":[{"title":"Succeeded","description":"","openapi":"openapi-events/events-publication.json webhook EVENTS.PUBLICATION.SUCCEEDED","diataxis":"reference","href":"/api-reference/publication/succeeded"}]},{"group":"Voucher","public":true,"pages":[{"title":"Created","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.CREATED","diataxis":"reference","href":"/api-reference/voucher/created"},{"title":"Disabled","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.DISABLED","diataxis":"reference","href":"/api-reference/voucher/disabled"},{"title":"Enabled","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.ENABLED","diataxis":"reference","href":"/api-reference/voucher/enabled"},{"title":"Updated","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.UPDATED","diataxis":"reference","href":"/api-reference/voucher/updated"},{"title":"Published","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.PUBLISHED","diataxis":"reference","href":"/api-reference/voucher/published"},{"title":"Loyalty Card Transaction Created","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.TRANSACTION.CREATED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-transaction-created"},{"title":"Loyalty Card Pending Points Activated","description":"","openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ACTIVATED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-pending-points-activated"},{"title":"Loyalty Card Pending Points Added","description":"","openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.ADDED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-pending-points-added"},{"title":"Loyalty Card Pending Points Canceled","description":"","openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.CANCELED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-pending-points-canceled"},{"title":"Loyalty Card Pending Points Updated","description":"","openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.PENDING_POINTS.UPDATED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-pending-points-updated"},{"title":"Loyalty Card Points Added","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.POINTS_ADDED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-points-added"},{"title":"Loyalty Card Points Expired","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.LOYALTY_CARD.POINTS_EXPIRED","diataxis":"reference","href":"/api-reference/voucher/loyalty-card-points-expired"},{"title":"Gift Transaction Created","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.GIFT.TRANSACTION.CREATED","diataxis":"reference","href":"/api-reference/voucher/gift-transaction-created"},{"title":"Gift Balance Added","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.GIFT.BALANCE_ADDED","diataxis":"reference","href":"/api-reference/voucher/gift-balance-added"},{"title":"Deleted","description":null,"openapi":"openapi-events/events-voucher.json webhook EVENTS.VOUCHER.DELETED","diataxis":"reference","href":"/api-reference/voucher/deleted"}]},{"group":"Campaign","public":true,"pages":[{"title":"Created","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.CREATED","keywords":["campaign","create"],"diataxis":"reference","href":"/api-reference/campaign/created"},{"title":"Vouchers Generation Completed","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.VOUCHERS.GENERATION.COMPLETED","keywords":["voucher","generation","complete"],"diataxis":"reference","href":"/api-reference/campaign/vouchers-generation-completed"},{"title":"Disabled","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.DISABLED","keywords":["campaign","disable"],"diataxis":"reference","href":"/api-reference/campaign/disabled"},{"title":"Enabled","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.ENABLED","keywords":["campaign","enable"],"diataxis":"reference","href":"/api-reference/campaign/enabled"},{"title":"Updated","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.UPDATED","keywords":["campaign","update"],"diataxis":"reference","href":"/api-reference/campaign/updated"},{"title":"Deleted","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.DELETED","keywords":["campaign","delete"],"diataxis":"reference","href":"/api-reference/campaign/deleted"},{"title":"Loyalty Tier Created","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.LOYALTY_TIER.CREATED","keywords":["loyalty","tier","create"],"diataxis":"reference","href":"/api-reference/campaign/loyalty-tier-created"},{"title":"Loyalty Tier Deleted","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.LOYALTY_TIER.DELETED","keywords":["loyalty","tier","delete"],"diataxis":"reference","href":"/api-reference/campaign/loyalty-tier-deleted"},{"title":"Loyalty Tier Updated","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.LOYALTY_TIER.UPDATED","keywords":["loyalty","tier","update"],"diataxis":"reference","href":"/api-reference/campaign/loyalty-tier-updated"},{"title":"Promotion Tier Created","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.PROMOTION_TIER.CREATED","keywords":["promotion","tier","create"],"diataxis":"reference","href":"/api-reference/campaign/promotion-tier-created"},{"title":"Promotion Tier Disabled","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.PROMOTION_TIER.DISABLED","keywords":["promotion","tier","disable"],"diataxis":"reference","href":"/api-reference/campaign/promotion-tier-disabled"},{"title":"Promotion Tier Enabled","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.PROMOTION_TIER.ENABLED","keywords":["promotion","tier","enable"],"diataxis":"reference","href":"/api-reference/campaign/promotion-tier-enabled"},{"title":"Promotion Tier Updated","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.PROMOTION_TIER.UPDATED","keywords":["promotion","tier","update"],"diataxis":"reference","href":"/api-reference/campaign/promotion-tier-updated"},{"title":"Promotion Tier Deleted","description":null,"openapi":"openapi-events/events-campaign.json webhook EVENTS.CAMPAIGN.PROMOTION_TIER.DELETED","keywords":["promotion","tier","delete"],"diataxis":"reference","href":"/api-reference/campaign/promotion-tier-deleted"}]},{"group":"Validation Rules","public":true,"pages":[{"title":"Created","description":null,"openapi":"openapi-events/events-bus_val_rule.json webhook EVENTS.BUS_VAL_RULE.CREATED","diataxis":"reference","href":"/api-reference/validation-rules/created"},{"title":"Updated","description":null,"openapi":"openapi-events/events-bus_val_rule.json webhook EVENTS.BUS_VAL_RULE.UPDATED","diataxis":"reference","href":"/api-reference/validation-rules/updated"},{"title":"Assignment Created","description":null,"openapi":"openapi-events/events-bus_val_rule.json webhook EVENTS.BUS_VAL_RULE.ASSIGNMENT.CREATED","diataxis":"reference","href":"/api-reference/validation-rules/assignment-created"},{"title":"Assignment Deleted","description":null,"openapi":"openapi-events/events-bus_val_rule.json webhook EVENTS.BUS_VAL_RULE.ASSIGNMENT.DELETED","diataxis":"reference","href":"/api-reference/validation-rules/assignment-deleted"},{"title":"Deleted","description":null,"openapi":"openapi-events/events-bus_val_rule.json webhook EVENTS.BUS_VAL_RULE.DELETED","diataxis":"reference","href":"/api-reference/validation-rules/deleted"}]},{"group":"Distribution","public":true,"pages":[{"title":"Manual Distribution Schedule","description":"","openapi":"openapi-events/events-distribution.json webhook EVENTS.DISTRIBUTION.MANUAL_DISTRIBUTION_SCHEDULE","keywords":["schedule","manual","distribution"],"diataxis":"reference","href":"/api-reference/distribution/manual-distribution-schedule"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","description":"Product updates and announcements","rss":true,"public":true,"diataxis":"reference","href":"/changelog/changelog"}]}]},"basePath":"","title":"Get program membership - Voucherify","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-5hDu1xuu.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","AssistantPageLink-KcneGfMY.js"]}