- Publications
- Qualifications
- Validations
- Redemptions
- Vouchers
- Campaigns
- Promotions
- Rewards
- Loyalties
- Customers
- Orders
- Products
- Product Collections
- Validation Rules
- Segments
- Events
- Async Actions
- Exports
- Categories
- Metadata Schemas
- Locations
- Referrals
- Bin
- Templates
- Management
- Client-side
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/publications/create | get | Create Publication | supported | |
| /v1/publications | get | List Publications | supported | |
| /v1/publications | post | Create Publication | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/qualifications | post | Check Eligibility | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/validations | post | Validate Stackable Discounts | supported | |
| /v1/vouchers/{code}/validate | post | Validate Voucher [Deprecated] | deprecated | |
| /v1/promotions/validation | post | Validate Promotions [Deprecated] | deprecated | |
| /v1/promotions/tiers/{tierId}/validation | post | Validate Promotion Tier [Deprecated] | deprecated |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/redemptions | get | List Redemptions | supported | |
| /v1/redemptions | post | Redeem Stackable Discounts | supported | |
| /v1/redemptions/{redemptionId} | get | Get Redemption | supported | |
| /v1/vouchers/{code}/redemption | get | Get Voucher's Redemptions | supported | |
| /v1/vouchers/{code}/redemption | post | Redeem Voucher [Deprecated] | deprecated | |
| /v1/redemptions/{redemptionId}/rollback | post | Rollback Redemption | supported | |
| /v1/promotions/tiers/{promotionTierId}/redemption | post | Redeem Promotion [Deprecated] | deprecated | |
| /v1/redemptions/{parentRedemptionId}/rollbacks | post | Rollback Stackable Redemptions | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/vouchers | get | List Vouchers | supported | |
| /v1/vouchers | post | Generate Random Code | supported | |
| /v1/vouchers/{code} | get | Get Voucher | supported | |
| /v1/vouchers/{code} | put | Update Voucher | supported | |
| /v1/vouchers/{code} | delete | Delete Voucher | supported | |
| /v1/vouchers/{code} | post | Create Voucher | supported | |
| /v1/vouchers/{code}/enable | post | Enable Voucher | supported | |
| /v1/vouchers/{code}/disable | post | Disable Voucher | supported | |
| /v1/vouchers/{code}/balance | post | Add or Remove Voucher Balance | supported | |
| /v1/vouchers/{code}/transactions | get | List Voucher Transactions | supported | |
| /v1/vouchers/{code}/transactions/export | post | Export Voucher Transactions | supported | |
| /v1/vouchers/import | post | Import Vouchers | supported | |
| /v1/vouchers/importCSV | post | Import Vouchers using CSV | supported | |
| /v1/vouchers/bulk/async | post | Update Vouchers in Bulk | supported | |
| /v1/vouchers/metadata/async | post | Update Vouchers' Metadata in Bulk | supported | |
| /v1/vouchers/{code}/sessions/{sessionKey} | delete | Release Validation Session | supported | |
| /v1/vouchers/qualification | post | Examine Qualification [Deprecated] | deprecated |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/campaigns | post | Create Campaign | supported | |
| /v1/campaigns | get | List Campaigns | supported | |
| /v1/campaigns/{campaignId} | get | Get Campaign | supported | |
| /v1/campaigns/{campaignId} | put | Update Campaign | supported | |
| /v1/campaigns/{campaignId} | delete | Delete Campaign | supported | |
| /v1/campaigns/{campaignId}/vouchers | post | Add Vouchers to Campaign | supported | |
| /v1/campaigns/{campaignId}/vouchers/{code} | post | Add Voucher with Specific Code to Campaign | supported | |
| /v1/campaigns/{campaignId}/import | post | Import Vouchers to Campaign | supported | |
| /v1/campaigns/{campaignId}/importCSV | post | Import Vouchers to Campaign by CSV | supported | |
| /v1/campaigns/qualification | post | Examine Qualification [Deprecated] | deprecated | |
| /v1/campaigns/{campaignId}/enable | post | Enable Campaign | supported | |
| /v1/campaigns/{campaignId}/disable | post | Disable Campaign | supported | |
| /v1/campaigns/{campaignId}/transactions | get | List Campaign Transactions | ||
| /v1/campaigns/{campaignId}/transactions/export | post | Export Campaign Transactions |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/promotions/tiers | get | List Promotion Tiers | supported | |
| /v1/promotions/{campaignId}/tiers | get | List Promotion Tiers from Campaign | supported | |
| /v1/promotions/{campaignId}/tiers | post | Add Promotion Tier to Campaign | supported | |
| /v1/promotions/tiers/{promotionTierId} | get | Get Promotion Tier | supported | |
| /v1/promotions/tiers/{promotionTierId} | put | Update Promotion Tier | supported | |
| /v1/promotions/tiers/{promotionTierId} | delete | Delete Promotion Tier | supported | |
| /v1/promotions/tiers/{promotionTierId}/enable | post | Enable Promotion Tier | supported | |
| /v1/promotions/tiers/{promotionTierId}/disable | post | Disable Promotion Tier | supported | |
| /v1/promotions/stacks | get | List Promotion Stacks | supported | |
| /v1/promotions/{campaignId}/stacks | get | List Promotion Stacks in Campaign | supported | |
| /v1/promotions/{campaignId}/stacks | post | Create Promotion Stack | supported | |
| /v1/promotions/{campaignId}/stacks/{stackId} | get | Get Promotion Stack | supported | |
| /v1/promotions/{campaignId}/stacks/{stackId} | put | Update Promotion Stack | supported | |
| /v1/promotions/{campaignId}/stacks/{stackId} | delete | Delete Promotion Stack | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/rewards | get | List Rewards | supported | |
| /v1/rewards | post | Create Reward | supported | |
| /v1/rewards/{rewardId} | get | Get Reward | supported | |
| /v1/rewards/{rewardId} | put | Update Reward | supported | |
| /v1/rewards/{rewardId} | delete | Delete Reward | supported | |
| /v1/rewards/{rewardId}/assignments | get | List Reward Assignments | supported | |
| /v1/rewards/{rewardId}/assignments | post | Create Reward Assignment | supported | |
| /v1/rewards/{rewardId}/assignments/{assignmentId} | put | Update Reward Assignment | supported | |
| /v1/rewards/{rewardId}/assignments/{assignmentId} | delete | Delete Reward Assignment | supported | |
| /v1/rewards/{rewardId}/assignments/{assignmentId} | get | Get Reward Assignment | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/loyalties | get | List Loyalty Campaigns | supported | |
| /v1/loyalties | post | Create Loyalty Campaign | supported | |
| /v1/loyalties/{campaignId} | get | Get Loyalty Campaign | supported | |
| /v1/loyalties/{campaignId} | put | Update Loyalty Campaign | supported | |
| /v1/loyalties/{campaignId} | delete | Delete Loyalty Campaign | supported | |
| /v1/loyalties/{campaignId}/members | get | List Members | supported | |
| /v1/loyalties/{campaignId}/members | post | Add Member | supported | |
| /v1/loyalties/{campaignId}/members/{memberId} | get | Get Member | supported | |
| /v1/loyalties/members/{memberId} | get | Get Member | supported | |
| /v1/loyalties/{campaignId}/members/{memberId}/activity | get | List Member Activity | supported | |
| /v1/loyalties/members/{memberId}/activity | get | List Member Activity | supported | |
| /v1/loyalties/{campaignId}/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance | supported | |
| /v1/loyalties/members/{memberId}/balance | post | Add or Remove Loyalty Card Balance | supported | |
| /v1/loyalties/{campaignId}/members/{memberId}/transfers | post | Transfer Loyalty Points | supported | |
| /v1/loyalties/{campaignId}/transactions | get | List Loyalty Campaign Transactions | ||
| /v1/loyalties/{campaignId}/transactions/export | post | Export Loyalty Campaign Transactions | ||
| /v1/loyalties/{campaignId}/members/{memberId}/transactions | get | List Loyalty Card Transactions | supported | |
| /v1/loyalties/members/{memberId}/transactions | get | List Loyalty Card Transactions | supported | |
| /v1/loyalties/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | supported | |
| /v1/loyalties/{campaignId}/members/{memberId}/transactions/export | post | Export Loyalty Card Transactions | supported | |
| /v1/loyalties/{campaignId}/members/{memberId}/points-expiration | get | Get Points Expiration | supported | |
| /v1/loyalties/{campaignId}/points-expiration/export | post | Create Points Expiration Export | supported | |
| /v1/loyalties/{campaignId}/earning-rules | get | List Earning Rules | supported | |
| /v1/loyalties/{campaignId}/earning-rules | post | Create Earning Rule | supported | |
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | get | Get Earning Rule | supported | |
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | put | Update Earning Rule | supported | |
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId} | delete | Delete Earning Rule | supported | |
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable | post | Enable Earning Rule | supported | |
| /v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable | post | Disable Earning Rule | supported | |
| /v1/loyalties/members/{memberId}/rewards | get | List Member Rewards | supported | |
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward | get | Get Reward Details | supported | |
| /v1/loyalties/{campaignId}/reward-assignments | get | List Reward Assignments | supported | |
| /v1/loyalties/{campaignId}/rewards | get | List Reward Assignments | supported | |
| /v1/loyalties/{campaignId}/rewards | post | Create Reward Assignment | supported | |
| /v1/loyalties/{campaignId}/reward-assignments/{assignmentId} | get | Get Reward Assignment | supported | |
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | get | Get Reward Assignment | supported | |
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | put | Update Reward Assignment | supported | |
| /v1/loyalties/{campaignId}/rewards/{assignmentId} | delete | Delete Reward Assignment | supported | |
| /v1/loyalties/{campaignId}/members/{memberId}/redemption | post | Redeem Reward | supported | |
| /v1/loyalties/members/{memberId}/redemption | post | Redeem Reward | supported | |
| /v1/loyalties/{campaignId}/tiers | get | List Loyalty Tiers | supported | |
| /v1/loyalties/{campaignId}/tiers | post | Create loyalty tiers | supported | |
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId} | get | Get Loyalty Tier | supported | |
| /v1/loyalties/members/{memberId}/tiers | get | List Member's Loyalty Tiers | supported | |
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules | get | List Loyalty Tier Earning Rules | supported | |
| /v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards | get | List Loyalty Tier Rewards | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/customers | get | List Customers | supported | |
| /v1/customers | post | Create Customer | supported | |
| /v1/customers/{customerId} | get | Get Customer | supported | |
| /v1/customers/{customerId} | delete | Delete Customer | supported | |
| /v1/customers/{customerId} | put | Update Customer | supported | |
| /v1/customers/{customerId}/permanent-deletion | post | Delete Customer Permanently | supported | |
| /v1/customers/importCSV | post | Import and Update Customers using CSV | supported | |
| /v1/customers/bulk/async | post | Update Customers in Bulk | supported | |
| /v1/customers/metadata/async | post | Update Customers' Metadata in Bulk | supported | |
| /v1/customers/{customerId}/activity | get | List Customer Activity | supported | |
| /v1/customers/{customerId}/activities | get | List Customer Activities [Deprecated] | deprecated | |
| /v1/customers/{customerId}/segments | get | List Customer's Segments | supported | |
| /v1/customers/{customerId}/redeemables | get | List Customer's Redeemables | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/orders | get | List Orders | supported | |
| /v1/orders | post | Create Order | supported | |
| /v1/orders/{orderId} | get | Get Order | supported | |
| /v1/orders/{orderId} | put | Update Order | supported | |
| /v1/orders/import | post | Import Orders | supported | |
| /v1/orders/export | post | Create Orders Export | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/products | get | List Products | supported | |
| /v1/products | post | Create Product | supported | |
| /v1/products/{productId} | get | Get Product | supported | |
| /v1/products/{productId} | put | Update Product | supported | |
| /v1/products/{productId} | delete | Delete Product | supported | |
| /v1/products/bulk/async | post | Update Products in Bulk | supported | |
| /v1/products/metadata/async | post | Update Products' Metadata in Bulk | supported | |
| /v1/skus/{skuId} | get | Get SKU | supported | |
| /v1/products/{productId}/skus | get | List SKUs in Product | supported | |
| /v1/products/{productId}/skus | post | Create SKU | supported | |
| /v1/products/{productId}/skus/{skuId} | put | Update SKU | supported | |
| /v1/products/{productId}/skus/{skuId} | delete | Delete SKU | supported | |
| /v1/products/importCSV | post | Import Products using CSV | supported | |
| /v1/skus/importCSV | post | Import SKUs using CSV | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/product-collections | get | List Product Collections | supported | |
| /v1/product-collections | post | Create Product Collection | supported | |
| /v1/product-collections/{productCollectionId} | get | Get Product Collection | supported | |
| /v1/product-collections/{productCollectionId} | delete | Delete Product Collection | supported | |
| /v1/product-collections/{productCollectionId}/products | get | List Products in Collection | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/validation-rules | get | List Validation Rules | supported | |
| /v1/validation-rules | post | Create Validation Rules | supported | |
| /v1/validation-rules/{validationRuleId} | get | Get Validation Rule | supported | |
| /v1/validation-rules/{validationRuleId} | put | Update Validation Rule | supported | |
| /v1/validation-rules/{validationRuleId} | delete | Delete Validation Rule | supported | |
| /v1/validation-rules-assignments | get | List Validation Rules' Assignment(s) | supported | |
| /v1/validation-rules/{validationRuleId}/assignments | get | List Validation Rule Assignments | supported | |
| /v1/validation-rules/{validationRuleId}/assignments | post | Create Validation Rules Assignments | supported | |
| /v1/validation-rules/{validationRuleId}/assignments/{assignmentId} | delete | Delete Validation Rule Assignment | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/segments/{segmentId} | get | Get Segment | supported | |
| /v1/segments/{segmentId} | delete | Delete Segment | supported | |
| /v1/segments | post | Create Segment | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/events | post | Track Custom Event | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/async-actions | get | List Async Actions | supported | |
| /v1/async-actions/{asyncActionId} | get | Get Async Action | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/exports | post | Create Export | supported | |
| /v1/exports | get | List Exports | supported | |
| /v1/exports/{exportId} | get | Get Export | supported | |
| /v1/exports/{exportId} | delete | Delete Export | supported | |
| /v1/exports/{export_Id} | get | Download Export | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/categories | get | List Categories | supported | |
| /v1/categories | post | Create Category | supported | |
| /v1/categories/{categoryId} | get | Get Category | supported | |
| /v1/categories/{categoryId} | delete | Delete Category | supported | |
| /v1/categories/{categoryId} | put | Update Category | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/metadata-schemas | get | List Metadata Schemas | supported | |
| /v1/metadata-schemas/{resource} | get | Get Metadata Schema | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/locations | get | List Locations | supported | |
| /v1/locations/{locationId} | get | Get Location | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/referrals/{campaignId}/members/{memberId}/holders | post | Add Referral Code Holders | supported | |
| /v1/referrals/{campaignId}/members/{memberId}/holders | get | List Referral Code Holders | supported | |
| /v1/referrals/{campaignId}/members/{memberId}/holders/{holderId} | delete | Remove Referral Card Holder | supported | |
| /v1/referrals/members/{memberId}/holders | post | Add Referral Code Holders | supported | |
| /v1/referrals/members/{memberId}/holders | get | List Referral Code Holders | supported | |
| /v1/referrals/members/{memberId}/holders/{holderId} | delete | Remove Referral Card Holder | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/trash-bin | get | List Bin Entries | supported | |
| /v1/trash-bin/{binEntryId} | delete | Delete Bin Entry | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /v1/templates/campaigns | get | List Campaign Templates | supported | |
| /v1/templates/campaigns | post | Create Campaign Template | supported | |
| /v1/templates/campaigns/{campaignTemplateId} | get | Get Campaign Template | supported | |
| /v1/templates/campaigns/{campaignTemplateId} | put | Update Campaign Template | supported | |
| /v1/templates/campaigns/{campaignTemplateId} | delete | Delete Campaign Template | supported | |
| /v1/templates/campaigns/{campaignTemplateId}/campaign-setup | post | Create Campaign From Template | supported | |
| /v1/templates/campaigns/{campaignTemplateId}/tier-setup | post | Add Promotion Tier From Template | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /management/v1/projects | post | Create Project | supported | |
| /management/v1/projects | get | List Projects | supported | |
| /management/v1/projects/{projectId} | get | Get Project | supported | |
| /management/v1/projects/{projectId} | put | Update Project | supported | |
| /management/v1/projects/{projectId} | delete | Delete Project | supported | |
| /management/v1/projects/{projectId}/users | post | Assign User | supported | |
| /management/v1/projects/{projectId}/users | get | List Users | supported | |
| /management/v1/projects/{projectId}/users/{userId} | get | Get User | supported | |
| /management/v1/projects/{projectId}/users/{userId} | put | Update User | supported | |
| /management/v1/projects/{projectId}/users/{userId} | delete | Unassign User | supported | |
| /management/v1/projects/users/invite | post | Invite a New User | supported | |
| /management/v1/projects/{projectId}/templates/campaigns | get | List Campaign Templates | supported | |
| /management/v1/projects/{projectId}/templates/campaigns/{campaignTemplateId}/copy | post | Copy Campaign Template to a Project | supported | |
| /management/v1/projects/{projectId}/stacking-rules | post | Create Stacking Rules | supported | |
| /management/v1/projects/{projectId}/stacking-rules | get | List Stacking Rules | supported | |
| /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | get | Get Stacking Rules | supported | |
| /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | put | Update Stacking Rules | supported | |
| /management/v1/projects/{projectId}/stacking-rules/{stackingRulesId} | delete | Delete Stacking Rules | supported | |
| /management/v1/projects/{projectId}/metadata-schemas | post | Create Metadata Schema | supported | |
| /management/v1/projects/{projectId}/metadata-schemas | get | List Metadata Schemas | supported | |
| /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | get | Get Metadata Schema | supported | |
| /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | put | Update Metadata Schema | supported | |
| /management/v1/projects/{projectId}/metadata-schemas/{metadataSchemaId} | delete | Delete Metadata Schema | supported | |
| /management/v1/projects/{projectId}/custom-event-schemas | post | Create Custom Event Schema | supported | |
| /management/v1/projects/{projectId}/custom-event-schemas | get | List Custom Event Schemas | supported | |
| /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | get | Get Custom Event Schema | supported | |
| /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | put | Update Custom Event Schema | supported | |
| /management/v1/projects/{projectId}/custom-event-schemas/{customEventSchemaId} | delete | Delete Custom Event Schema | supported | |
| /management/v1/projects/{projectId}/webhooks | post | Create Webhook | supported | |
| /management/v1/projects/{projectId}/webhooks | get | List Webhooks | supported | |
| /management/v1/projects/{projectId}/webhooks/{webhookId} | get | Get Webhook | supported | |
| /management/v1/projects/{projectId}/webhooks/{webhookId} | put | Update Webhook | supported | |
| /management/v1/projects/{projectId}/webhooks/{webhookId} | delete | Delete Webhook | supported | |
| /management/v1/projects/{projectId}/branding | post | Create Brand | supported | |
| /management/v1/projects/{projectId}/branding | get | List Brands | supported | |
| /management/v1/projects/{projectId}/branding/{brandingId} | get | Get Brand | supported | |
| /management/v1/projects/{projectId}/branding/{brandingId} | put | Update Brand | supported | |
| /management/v1/projects/{projectId}/branding/{brandingId} | delete | Delete Brand | supported |
| endpoint | method | summary | is supported | is deprecated |
|---|---|---|---|---|
| /client/v1/qualifications | post | Check Eligibility (client-side) | supported | |
| /client/v1/promotions/tiers | get | List Promotion Tiers (client-side) | supported | |
| /client/v1/redemptions | post | Redeem Stackable Discounts (client-side) | supported | |
| /client/v1/validations | post | Validate Stackable Discounts (client-side) | supported | |
| /client/v1/events | post | Track Custom Event (client-side) | supported | |
| /client/v1/validate | get | Validate Voucher (client-side) [Deprecated] | deprecated | |
| /client/v1/redeem | post | Redeem Voucher (client-side) [Deprecated] | deprecated | |
| /client/v1/publish | post | Create Publication (client-side) |