Skip to content

Latest commit

 

History

History
868 lines (866 loc) · 46.9 KB

ENDPOINTS-COVERAGE.md

File metadata and controls

868 lines (866 loc) · 46.9 KB

Endpoints Coverage

Table of Contents

Endpoints

Publications

/v1/publications/create

Create Publication (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/publications

List Publications (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Publication (post)

  • RequestSupported: link
  • ResponseSupported: link

Qualifications

/v1/qualifications

Check Eligibility (post)

  • RequestSupported: link
  • ResponseSupported: link

Validations

/v1/validations

Validate Stackable Discounts (post)

  • RequestSupported: link
  • ResponseSupported:

❗/v1/vouchers/{code}/validate [Deprecated]❗

❗Validate Voucher [Deprecated] (post)❗

❗/v1/promotions/validation [Deprecated]❗

❗Validate Promotions [Deprecated] (post)❗

❗/v1/promotions/tiers/{tierId}/validation [Deprecated]❗

❗Validate Promotion Tier [Deprecated] (post)❗

Redemptions

/v1/redemptions

List Redemptions (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Redeem Stackable Discounts (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/redemptions/{redemptionId}

Get Redemption (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/vouchers/{code}/redemption

Get Voucher's Redemptions (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

❗Redeem Voucher [Deprecated] (post)❗

/v1/redemptions/{redemptionId}/rollback

Rollback Redemption (post)

  • RequestSupported: link
  • ResponseSupported: link

❗/v1/promotions/tiers/{promotionTierId}/redemption [Deprecated]❗

❗Redeem Promotion [Deprecated] (post)❗

/v1/redemptions/{parentRedemptionId}/rollbacks

Rollback Stackable Redemptions (post)

  • RequestSupported: link
  • ResponseSupported: link

Vouchers

/v1/vouchers

List Vouchers (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Generate Random Code (post)

  • RequestSupported:
  • ResponseSupported:

/v1/vouchers/{code}

Get Voucher (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Voucher (put)

  • RequestSupported:
  • ResponseSupported:

Delete Voucher (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Create Voucher (post)

  • RequestSupported:
  • ResponseSupported:

/v1/vouchers/{code}/enable

Enable Voucher (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/vouchers/{code}/disable

Disable Voucher (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/vouchers/{code}/balance

Add or Remove Voucher Balance (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/vouchers/{code}/transactions

List Voucher Transactions (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/vouchers/{code}/transactions/export

Export Voucher Transactions (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/vouchers/import

Import Vouchers (post)

  • RequestSupported:
  • ResponseSupported:

/v1/vouchers/importCSV

Import Vouchers using CSV (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/vouchers/bulk/async

Update Vouchers in bulk (post)

  • RequestSupported:
  • ResponseSupported:

/v1/vouchers/metadata/async

Update Vouchers' metadata in bulk (post)

  • RequestSupported:
  • ResponseSupported:

/v1/vouchers/{code}/sessions/{sessionKey}

Release Validation Session (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

❗/v1/vouchers/qualification [Deprecated]❗

❗Examine Qualification [Deprecated] (post)❗

Campaigns

/v1/campaigns

Create Campaign (post)

  • RequestSupported: link
  • ResponseSupported: link

List Campaigns (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/campaigns/{campaignId}

Get Campaign (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Campaign (put)

  • RequestSupported: link
  • ResponseSupported: link

Delete Campaign (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/campaigns/{campaignId}/vouchers

Add Vouchers to Campaign (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/campaigns/{campaignId}/vouchers/{code}

Add Voucher with Specific Code to Campaign (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/campaigns/{campaignId}/import

Import Vouchers to Campaign (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/campaigns/{campaignId}/importCSV

Import Vouchers to Campaign by CSV (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

❗/v1/campaigns/qualification [Deprecated]❗

❗Examine Qualification [Deprecated] (post)❗

/v1/campaigns/{campaignId}/enable

Enable Campaign (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/campaigns/{campaignId}/disable

Disable Campaign (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Promotions

/v1/promotions/tiers

List Promotion Tiers (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/promotions/{campaignId}/tiers

List Promotion Tiers from Campaign (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Add Promotion Tier to Campaign (post)

  • RequestSupported:
  • ResponseSupported:

/v1/promotions/tiers/{promotionTierId}

Get Promotion Tier (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Promotion Tier (put)

  • RequestSupported:
  • ResponseSupported:

Delete Promotion Tier (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/promotions/tiers/{promotionTierId}/enable

Enable Promotion Tier (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/promotions/tiers/{promotionTierId}/disable

Disable Promotion Tier (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/promotions/stacks

List Promotion Stacks (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/promotions/{campaignId}/stacks

List Promotion Stacks in Campaign (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Promotion Stack (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/promotions/{campaignId}/stacks/{stackId}

Get Promotion Stack (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Promotion Stack (put)

  • RequestSupported: link
  • ResponseSupported: link

Delete Promotion Stack (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Rewards

/v1/rewards

List Rewards (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Create Reward (post)

  • RequestSupported:
  • ResponseSupported:

/v1/rewards/{rewardId}

Get Reward (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Update Reward (put)

  • RequestSupported:
  • ResponseSupported:

Delete Reward (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/rewards/{rewardId}/assignments

List Reward Assignments (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Reward Assignment (post)

  • RequestSupported: link
  • ResponseSupported:

/v1/rewards/{rewardId}/assignments/{assignmentId}

Update Reward Assignment (put)

  • RequestSupported: link
  • ResponseSupported: link

Delete Reward Assignment (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Get Reward Assignment (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Loyalties

/v1/loyalties

List Loyalty Campaigns (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Create Loyalty Campaign (post)

  • RequestSupported:
  • ResponseSupported:

/v1/loyalties/{campaignId}

Get Loyalty Campaign (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Update Loyalty Campaign (put)

  • RequestSupported:
  • ResponseSupported:

Delete Loyalty Campaign (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/members

List Members (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Add Member (post)

  • RequestSupported:
  • ResponseSupported:

/v1/loyalties/{campaignId}/members/{memberId}

Get Member (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/loyalties/members/{memberId}

Get Member (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/loyalties/{campaignId}/members/{memberId}/activities

Get Member Activities (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/loyalties/members/{memberId}/activities

Get Member Activities (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/loyalties/{campaignId}/members/{memberId}/balance

Add or Remove Loyalty Card Balance (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/members/{memberId}/balance

Add or Remove Loyalty Card Balance (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/{campaignId}/members/{memberId}/transfers

Transfer Loyalty Points (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/{campaignId}/members/{memberId}/transactions

List Loyalty Card Transactions (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/members/{memberId}/transactions

List Loyalty Card Transactions (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/members/{memberId}/transactions/export

Export Loyalty Card Transactions (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/{campaignId}/members/{memberId}/transactions/export

Export Loyalty Card Transactions (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/{campaignId}/members/{memberId}/points-expiration

Get Points Expiration (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/points-expiration/export

Create Points Expiration Export (post)

  • RequestSupported:
  • ResponseSupported:

/v1/loyalties/{campaignId}/earning-rules

List Earning Rules (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Create Earning Rule (post)

  • RequestSupported:
  • ResponseSupported: Not applicable

/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}

Get Earning Rule (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Earning Rule (put)

  • RequestSupported:
  • ResponseSupported:

Delete Earning Rule (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/enable

Enable Earning Rule (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/earning-rules/{earningRuleId}/disable

Disable Earning Rule (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/members/{memberId}/rewards

List Member Rewards (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}/reward

Get Reward Details (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/reward-assignments

List Reward Assignments (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/loyalties/{campaignId}/rewards

List Reward Assignments (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Create Reward Assignment (post)

  • RequestSupported:
  • ResponseSupported:

/v1/loyalties/{campaignId}/reward-assignments/{assignmentId}

Get Reward Assignment (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/rewards/{assignmentId}

Get Reward Assignment (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Reward Assignment (put)

  • RequestSupported: link
  • ResponseSupported:

Delete Reward Assignment (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/loyalties/{campaignId}/members/{memberId}/redemption

Redeem Reward (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/members/{memberId}/redemption

Redeem Reward (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/{campaignId}/tiers

List Loyalty Tiers (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create loyalty tiers (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}

Get Loyalty Tier (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/members/{memberId}/tiers

List Member's Loyalty Tiers (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/earning-rules

List Loyalty Tier Earning Rules (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/loyalties/{campaignId}/tiers/{loyaltyTierId}/rewards

List Loyalty Tier Rewards (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Customers

/v1/customers

List Customers (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Customer (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/customers/{customerId}

Get Customer (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Delete Customer (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Update Customer (put)

  • RequestSupported: link
  • ResponseSupported: link

/v1/customers/{customerId}/permanent-deletion

Delete Customer Permanently (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/customers/importCSV

Import and Update Customers using CSV (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/customers/bulk/async

Update Customers in bulk (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/customers/metadata/async

Update Customers' Metadata in bulk (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/customers/{customerId}/consents

Update Customer's consents (put)

  • RequestSupported: link
  • ResponseSupported: Not applicable

/v1/customers/{customerId}/activities

List Customer Activities (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/customers/{customerId}/segments

List Customer's Segments (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Orders

/v1/orders

List Orders (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Order (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/orders/{orderId}

Get Order (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Order (put)

  • RequestSupported: link
  • ResponseSupported: link

/v1/orders/import

Import Orders (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/orders/export

Create Orders Export (post)

  • RequestSupported: link
  • ResponseSupported: link

Products

/v1/products

List Products (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Product (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/products/{productId}

Get Product (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Product (put)

  • RequestSupported: link
  • ResponseSupported: link

Delete Product (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/products/bulk/async

Update Products in bulk (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/products/metadata/async

Update Products' Metadata in bulk (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/skus/{skuId}

Get SKU (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/products/{productId}/skus

List SKUs in Product (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create SKU (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/products/{productId}/skus/{skuId}

Update SKU (put)

  • RequestSupported: link
  • ResponseSupported: link

Delete SKU (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/products/importCSV

Import Products using CSV (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/skus/importCSV

Import SKUs using CSV (post)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Product Collections

/v1/product-collections

List Product Collections (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Product Collection (post)

  • RequestSupported: link
  • ResponseSupported: link

/v1/product-collections/{productCollectionId}

Get Product Collection (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Delete Product Collection (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/product-collections/{productCollectionId}/products

List Products in Collection (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Validation Rules

/v1/validation-rules

List Validation Rules (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Validation Rules (post)

  • RequestSupported: link
  • ResponseSupported:

/v1/validation-rules/{validationRuleId}

Get Validation Rule (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Update Validation Rule (put)

  • RequestSupported: link
  • ResponseSupported: link

Delete Validation Rule (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/validation-rules-assignments

List Validation Rules' Assignment(s) (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/validation-rules/{validationRuleId}/assignments

List Validation Rule Assignments (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Validation Rules Assignments (post)

  • RequestSupported:
  • ResponseSupported:

/v1/validation-rules/{validationRuleId}/assignments/{assignmentId}

Delete Validation Rule Assignment (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Segments

/v1/segments/{segmentId}

Get Segment (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Delete Segment (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/segments

Create Segment (post)

  • RequestSupported:
  • ResponseSupported:

Events

/v1/events

Track Custom Event (post)

  • RequestSupported: link
  • ResponseSupported: link

Consents

/v1/consents

List Consents (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Async Actions

/v1/async-actions

List Async Actions (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/async-actions/{asyncActionId}

Get Async Action (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Exports

/v1/exports

Create Export (post)

  • RequestSupported: link
  • ResponseSupported: link

List Exports (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

/v1/exports/{exportId}

Get Export (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Delete Export (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

/v1/exports/{export_Id}

Download Export (get)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Categories

/v1/categories

List Categories (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Create Category (post)

  • RequestSupported: link
  • ResponseSupported:

/v1/categories/{categoryId}

Get Category (get)

  • RequestSupported: Not applicable
  • ResponseSupported: link

Delete Category (delete)

  • RequestSupported: Not applicable
  • ResponseSupported: Not applicable

Update Category (put)

  • RequestSupported: link
  • ResponseSupported:

Metadata Schemas

/v1/metadata-schemas

List Metadata Schemas (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/metadata-schemas/{resource}

Get Metadata Schema (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Locations

/v1/locations

List Locations (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/v1/locations/{locationId}

Get Location (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

Client-side

/client/v1/qualifications

Check Eligibility (client-side) (post)

  • RequestSupported: link
  • ResponseSupported: link

/client/v1/promotions/tiers

List Promotion Tiers (client-side) (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

/client/v1/redemptions

Redeem Stackable Discounts (client-side) (post)

  • RequestSupported: link
  • ResponseSupported: link

/client/v1/validations

Validate Stackable Discounts (client-side) (post)

  • RequestSupported: link
  • ResponseSupported:

/client/v1/customers/{customerId}/consents

Update Customer's consents (client-side) (put)

  • RequestSupported: link
  • ResponseSupported: Not applicable

/client/v1/events

Track Custom Event (client-side) (post)

  • RequestSupported: link
  • ResponseSupported: link

/client/v1/consents

List Consents (client-side) (get)

  • RequestSupported: Not applicable
  • ResponseSupported:

❗/client/v1/validate [Deprecated]❗

❗Validate Voucher (client-side) [Deprecated] (get)❗

❗/client/v1/redeem [Deprecated]❗

❗Redeem Voucher (client-side) [Deprecated] (post)❗