This is an object representing an asynchronous action.
+ | Attributes | Description | |:-----|:--------| @@ -25,7 +26,8 @@ order: 1 | object`string` |The type of object represented by JSON. This object stores information about the async_action.
Result schema for a CAMPAIGN.VOUCHERS_IMPORT async action type.
+ | Attributes | Description | |:-----|:--------| @@ -35,7 +37,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## CAMPAIGN.VOUCHERS_IMPORT_CSV -#### Result schema for a CAMPAIGN.VOUCHERS_IMPORT_CSV async action type. +Result schema for a CAMPAIGN.VOUCHERS_IMPORT_CSV async action type.
+ | Attributes | Description | |:-----|:--------| @@ -45,7 +48,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## CAMPAIGN.VOUCHERS_UPDATE -#### Result schema for a CAMPAIGN.VOUCHERS_UPDATE async action type. +Result schema for a CAMPAIGN.VOUCHERS_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -53,7 +57,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## CAMPAIGN.VOUCHERS_DELETE -#### Result schema for a CAMPAIGN.VOUCHERS_DELETE async action type. +Result schema for a CAMPAIGN.VOUCHERS_DELETE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -61,7 +66,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## CAMPAIGN.VOUCHERS_GENERATE -#### Result schema for a CAMPAIGN.VOUCHERS_GENERATE async action type. +Result schema for a CAMPAIGN.VOUCHERS_GENERATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -69,7 +75,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## CAMPAIGNS.METADATA_KEY_PURGE -#### Result schema for a CAMPAIGNS.METADATA_KEY_PURGE async action type. +Result schema for a CAMPAIGNS.METADATA_KEY_PURGE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -77,7 +84,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## CUSTOMERS.IMPORT_CSV -#### Result schema for a CUSTOMERS.IMPORT_CSV async action type. +Result schema for a CUSTOMERS.IMPORT_CSV async action type.
+ | Attributes | Description | |:-----|:--------| @@ -87,7 +95,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## CUSTOMERS.BULK_UPDATE -#### Result schema for a CUSTOMERS.BULK_UPDATE async action type. +Result schema for a CUSTOMERS.BULK_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -95,7 +104,8 @@ order: 1 | done_count`integer` |Number or resources processed successfully.
| ## CUSTOMERS.METADATA_UPDATE -#### Result schema for a CUSTOMERS.METADATA_UPDATE async action type. +Result schema for a CUSTOMERS.METADATA_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -103,7 +113,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## CUSTOMERS.METADATA_KEY_PURGE -#### Result schema for a CUSTOMERS.METADATA_KEY_PURGE async action type. +Result schema for a CUSTOMERS.METADATA_KEY_PURGE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -111,7 +122,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## PRODUCTS.BULK_UPDATE -#### Result schema for a PRODUCTS.BULK_UPDATE async action type. +Result schema for a PRODUCTS.BULK_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -119,7 +131,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## PRODUCTS.METADATA_UPDATE -#### Result schema for a PRODUCTS.METADATA_UPDATE async action type. +Result schema for a PRODUCTS.METADATA_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -127,7 +140,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## PRODUCTS.IMPORT_CSV -#### Result schema for a PRODUCTS.IMPORT_CSV async action type. +Result schema for a PRODUCTS.IMPORT_CSV async action type.
+ | Attributes | Description | |:-----|:--------| @@ -137,7 +151,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## SKUS.IMPORT_CSV -#### Result schema for a SKUS.IMPORT_CSV async action type. +Result schema for a SKUS.IMPORT_CSV async action type.
+ | Attributes | Description | |:-----|:--------| @@ -147,7 +162,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## PRODUCTS.METADATA_KEY_PURGE -#### Result schema for a PRODUCTS.METADATA_KEY_PURGE async action type. +Result schema for a PRODUCTS.METADATA_KEY_PURGE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -155,7 +171,8 @@ order: 1 | done_count`integer` |Number of resources updated successfully.
| ## VOUCHERS.IMPORT -#### Result schema for a VOUCHERS.IMPORT async action type. +Result schema for a VOUCHERS.IMPORT async action type.
+ | Attributes | Description | |:-----|:--------| @@ -165,7 +182,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## VOUCHERS.IMPORT_CSV -#### Result schema for a VOUCHERS.IMPORT_CSV async action type. +Result schema for a VOUCHERS.IMPORT_CSV async action type.
+ | Attributes | Description | |:-----|:--------| @@ -175,7 +193,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## VOUCHERS.BULK_UPDATE -#### Result schema for a VOUCHERS.BULK_UPDATE async action type. +Result schema for a VOUCHERS.BULK_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -183,7 +202,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## VOUCHERS.METADATA_UPDATE -#### Result schema for a VOUCHERS.METADATA_UPDATE async action type. +Result schema for a VOUCHERS.METADATA_UPDATE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -191,7 +211,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## VOUCHERS.METADATA_KEY_PURGE -#### Result schema for a VOUCHERS.METADATA_KEY_PURGE async action type. +Result schema for a VOUCHERS.METADATA_KEY_PURGE async action type.
+ | Attributes | Description | |:-----|:--------| @@ -199,7 +220,8 @@ order: 1 | done_count`integer` |Number of resources processed successfully.
| ## ORDERS.IMPORT -#### Result schema for a ORDERS.IMPORT async action type. +Result schema for a ORDERS.IMPORT async action type.
+ | Attributes | Description | |:-----|:--------| @@ -209,7 +231,8 @@ order: 1 | failed_count`integer` |Number of resources failed to process.
| ## ORDERS.METADATA_KEY_PURGE -#### Result schema for a ORDERS.METADATA_KEY_PURGE async action type. +Result schema for a ORDERS.METADATA_KEY_PURGE async action type.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md b/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md index 143bd0c5d..d990e9ce5 100644 --- a/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md +++ b/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md @@ -15,7 +15,8 @@ All of: 2.| Attributes | Description |
|---|---|
| promotion | See: Promotion Tiers |
| validation_rules_assignments | See: Validation Rules Assignments List |
This is an object representing a campaign.
+ | Attributes | Description | |:-----|:--------| @@ -49,7 +50,8 @@ All of: | loyalty_tiers_expiration | See: [Loyalty Tiers Expiration](#loyalty-tiers-expiration) | ## Promotion Tiers -#### Promotion Tiers +Promotion Tiers
+ | Attributes | Description | |:-----|:--------| @@ -60,7 +62,8 @@ All of: | has_more`boolean` |As query results are always limited (by the limit parameter), the has_more flag indicates whether there are more records for given filter parameters. This let's you know if you are able to run another request (with a different page or a different start date filter) to get more records returned in the results.
List of Validation Rules Assignments
+ | Attributes | Description | |:-----|:--------| @@ -70,7 +73,8 @@ All of: | total`integer` |Total number of validation rules assignments.
| ## Campaign Discount Voucher -#### Schema model for a campaign voucher. +Schema model for a campaign voucher.
+ | Attributes | Description | |:-----|:--------| @@ -86,7 +90,8 @@ All of: | validity_timeframe`object` |Set recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.
| Attributes | Description |
|---|---|
intervalstring | Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a campaign with an |
durationstring | Defines the amount of time the campaign will be active in ISO 8601 format. For example, a campaign with a |
This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -99,7 +104,8 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Referral Program -#### Defines the referee reward and the way a referral is triggered. Context: `REFERRAL_PROGRAM`. +Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.
Defines the referee reward.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
related_object_parentobject | Details of the resource from which the reward originates.
| ||||||||
typestring | Type of reward. Available values:DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER, LUCKY_DRAW_CODE | ||||||||
amountstring | Define the number of |
Defines the Loyalty Tiers Expiration.
+ | Attributes | Description | |:-----|:--------| @@ -118,7 +125,8 @@ All of: | expiration_date`object` |Defines the conditions for the expiration date of a tier.
| Attributes | Description |
|---|---|
typestring | What triggers the tier to expire for a customer. END_OF_PERIOD, END_OF_NEXT_PERIOD, BALANCE_DROP, CUSTOM |
extendstring | Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of |
| rounding | Defines the rounding mechanism for tier expiration. |
This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -145,7 +153,8 @@ All of: | categories`array` | Array of [Category](#category) | ## Business Validation Rule Assignment -#### Assignments of business validation rule +Assignments of business validation rule
+ | Attributes | Description | |:-----|:--------| @@ -160,8 +169,6 @@ All of: | validation_omitted_rules`array` |The list of omitted rules
| ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -169,7 +176,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Gift -#### Contains current gift card balance information. +Contains current gift card balance information.
+ | Attributes | Description | |:-----|:--------| @@ -178,7 +186,8 @@ Any of: | effect`string` |Defines how the credits are applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | ## Campaign Loyalty Card -#### Schema model for a campaign loyalty card. +Schema model for a campaign loyalty card.
+ | Attributes | Description | |:-----|:--------| @@ -191,7 +200,8 @@ All of: 1. [Code Config](#code-config) ## Validation Rule Assignments -#### Validation Rule Assignments +Validation Rule Assignments
+ | Attributes | Description | |:-----|:--------| @@ -250,7 +260,8 @@ All of: | is_dynamic`boolean` |Flag indicating whether the discount was calculated using a formula.
| ## Code Config -#### Schema containing information about config used for voucher. Defines code's pattern (prefix, suffix, length, charset, etc). +Schema containing information about config used for voucher. Defines code's pattern (prefix, suffix, length, charset, etc).
+ | Attributes | Description | |:-----|:--------| @@ -262,7 +273,8 @@ All of: | initial_count`integer` |The initial count
| ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/CATEGORIES-API-Category-Object.md b/docs/reference-docs/CATEGORIES-API-Category-Object.md index 2c6007b6c..e4a7b898d 100644 --- a/docs/reference-docs/CATEGORIES-API-Category-Object.md +++ b/docs/reference-docs/CATEGORIES-API-Category-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/CONSENTS-API-Consents-Object.md b/docs/reference-docs/CONSENTS-API-Consents-Object.md index 70c4b312c..35ba49407 100644 --- a/docs/reference-docs/CONSENTS-API-Consents-Object.md +++ b/docs/reference-docs/CONSENTS-API-Consents-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## List Consents Response Body -#### Response body schema for listing consents. +Response body schema for listing consents.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md b/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md index 8fe121311..7e1c17c75 100644 --- a/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md +++ b/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md @@ -9,11 +9,8 @@ order: 2 --- ## Customer Activity -#### This is an object representing customer activity. +This is an object representing customer activity.
This is a general object which presents moments from customers' activity. There are all types of different events that customers perform during their journey once they participate in Promotions. Events describe moments when customers redeem coupons and earn points or rewards. The list of all types of activities is listed below.
The details describing the activity are collected in a property named data. In this object, software integrators will find all further information explaining the event context.
Timestamp representing the date and time when the customer activity occurred in ISO 8601 format.
**Example:**2022-08-30T09:14:07.660Z
| ## Customer Activity Data -#### Event data object schema. -Event data object schema.
Any of: @@ -32,7 +27,8 @@ Any of: [Event Customer Confirmed](#event-customer-confirmed), [Event Customer Created](#event-customer-created), [Event Customer Updated](#event-customer-updated), [Event Customer Deleted](#event-customer-deleted), [Event Customer Referred](#event-customer-referred), [Event Customer Custom Event](#event-customer-custom-event), [Event Customer Segment Entered](#event-customer-segment-entered), [Event Customer Segment Left](#event-customer-segment-left), [Event Customer SMS Sent](#event-customer-sms-sent), [Event Customer SMS Recovered](#event-customer-sms-recovered), [Event Customer SMS Failed](#event-customer-sms-failed), [Event Customer Email Sent](#event-customer-email-sent), [Event Customer Email Recovered](#event-customer-email-recovered), [Event Customer Email Failed](#event-customer-email-failed), [Event Customer ActiveCampaign Sent](#event-customer-activecampaign-sent), [Event Customer ActiveCampaign Recovered](#event-customer-activecampaign-recovered), [Event Customer ActiveCampaign Failed](#event-customer-activecampaign-failed), [Event Customer Braze Sent](#event-customer-braze-sent), [Event Customer Braze Recovered](#event-customer-braze-recovered), [Event Customer Braze Failed](#event-customer-braze-failed), [Event Customer Mailchimp Sent](#event-customer-mailchimp-sent), [Event Customer Mailchimp Recovered](#event-customer-mailchimp-recovered), [Event Customer Mailchimp Failed](#event-customer-mailchimp-failed), [Event Customer Intercom Sent](#event-customer-intercom-sent), [Event Customer Intercom Recovered](#event-customer-intercom-recovered), [Event Customer Intercom Failed](#event-customer-intercom-failed), [Event Customer Shopify Sent](#event-customer-shopify-sent), [Event Customer Shopify Recovered](#event-customer-shopify-recovered), [Event Customer Shopify Failed](#event-customer-shopify-failed), [Event Customer Klaviyo Sent](#event-customer-klaviyo-sent), [Event Customer Klaviyo Recovered](#event-customer-klaviyo-recovered), [Event Customer Klaviyo Failed](#event-customer-klaviyo-failed), [Event Customer Batch Sent](#event-customer-batch-sent), [Event Customer Batch Recovered](#event-customer-batch-recovered), [Event Customer Batch Failed](#event-customer-batch-failed), [Event Customer Rewarded](#event-customer-rewarded), [Event Customer Rewarded Loyalty Points](#event-customer-rewarded-loyalty-points), [Event Customer Gift Voucher Balance Added](#event-customer-gift-voucher-balance-added), [Event Customer Loyalty Card Points Added](#event-customer-loyalty-card-points-added), [Event Customer Loyalty Card Points Transferred](#event-customer-loyalty-card-points-transferred), [Event Customer Loyalty Card Points Expired](#event-customer-loyalty-card-points-expired), [Event Customer Voucher Deleted](#event-customer-voucher-deleted), [Event Customer Publication Succeeded](#event-customer-publication-succeeded), [Event Customer Publication Failed](#event-customer-publication-failed), [Event Customer Validation Succeeded](#event-customer-validation-succeeded), [Event Customer Validation Failed](#event-customer-validation-failed), [Event Customer Redemption Succeeded](#event-customer-redemption-succeeded), [Event Customer Redemption Failed](#event-customer-redemption-failed), [Event Customer Redemption Rollback Succeeded](#event-customer-redemption-rollback-succeeded), [Event Customer Redemption Rollback Failed](#event-customer-redemption-rollback-failed), [Event Customer Consents Given](#event-customer-consents-given), [Event Customer Consents Revoked](#event-customer-consents-revoked), [Event Customer Order Canceled](#event-customer-order-canceled), [Event Customer Order Created](#event-customer-order-created), [Event Customer Order Fulfilled](#event-customer-order-fulfilled), [Event Customer Order Paid](#event-customer-order-paid), [Event Customer Order Processing](#event-customer-order-processing), [Event Customer Order Updated](#event-customer-order-updated), [Event Customer Reward Redemptions Created](#event-customer-reward-redemptions-created), [Event Customer Reward Redemptions Pending](#event-customer-reward-redemptions-pending), [Event Customer Reward Redemptions Completed](#event-customer-reward-redemptions-completed), [Event Customer Reward Redemptions Rolled Back](#event-customer-reward-redemptions-rolled-back), [Event Customer Loyalty Updated](#event-customer-loyalty-updated), [Event Customer Loyalty Tier Upgraded](#event-customer-loyalty-tier-upgraded), [Event Customer Loyalty Tier Downgraded](#event-customer-loyalty-tier-downgraded), [Event Customer Loyalty Tier Prolonged](#event-customer-loyalty-tier-prolonged), [Event Customer Loyalty Tier Expiration Changed](#event-customer-loyalty-tier-expiration-changed), [Event Customer Loyalty Tier Joined](#event-customer-loyalty-tier-joined), [Event Customer Loyalty Tier Left](#event-customer-loyalty-tier-left) ## Event Customer Confirmed -#### Event data object schema for `customer.confirmed`. +Event data object schema for customer.confirmed.
| Attributes | Description |
|---|---|
idstring | Example: ucust_1qa70mVfYkl11Ab0ZxDPdWNa |
Event data object schema for customer.created.
Event data object schema for customer.updated.
Event data object schema for customer.deleted.
Event data object schema for customer.referred.
Event data object schema for customer.custom_event.
Event data object schema for customer.segment.entered.
Event data object schema for customer.segment.left.
Event data object schema for customer.sms.sent.
Event data object schema for customer.sms.recovered.
Event data object schema for customer.sms.failed.
Event data object schema for customer.email.sent.
Event data object schema for customer.email.recovered.
Event data object schema for customer.email.failed.
Event data object schema for customer.activecampaign.sent.
Event data object schema for customer.activecampaign.recovered.
Event data object schema for customer.activecampaign.failed.
Event data object schema for customer.braze.sent.
Event data object schema for customer.braze.recovered.
Event data object schema for customer.braze.failed.
Event data object schema for customer.mailchimp.sent.
Event data object schema for customer.mailchimp.recovered.
Event data object schema for customer.mailchimp.failed.
Event data object schema for customer.intercom.sent.
Event data object schema for customer.intercom.recovered.
Event data object schema for customer.intercom.failed.
Event data object schema for customer.shopify.sent.
Event data object schema for customer.shopify.recovered.
Event data object schema for customer.shopify.failed.
Event data object schema for customer.klaviyo.sent.
Event data object schema for customer.klaviyo.recovered.
Event data object schema for customer.klaviyo.failed.
Event data object schema for customer.batch.sent.
Event data object schema for customer.batch.recovered.
Event data object schema for customer.batch.failed.
Event data object schema for customer.rewarded.
Event data object schema for customer.rewarded.loyalty_points.
Event data object schema for customer.voucher.gift.balance_added.
Event data object schema for customer.voucher.loyalty_card.points_added.
Event data object schema for customer.voucher.loyalty_card.points_transferred.
Event data object schema for customer.voucher.loyalty_card.points_expired.
Event data object schema for customer.voucher.deleted.
Event data object schema for customer.publication.succeeded.
Event data object schema for customer.publication.failed.
Event data object schema for customer.validation.succeeded.
Event data object schema for customer.validation.failed.
Event data object schema for customer.redemption.succeeded.
Event data object schema for customer.redemption.failed.
Event data object schema for customer.redemption.rollback.succeeded.
| Attributes | Description |
|---|---|
| redemption_rollback | See: Simple Redemption |
Event data object schema for customer.redemption.rollback.failed.
| Attributes | Description |
|---|---|
| redemption_rollback | See: Simple Redemption |
Event data object schema for customer.consents.given.
Event data object schema for customer.consents.revoked.
Event data object schema for customer.order.canceled.
Event data object schema for customer.order.created.
Event data object schema for customer.order.fulfilled.
Event data object schema for customer.order.paid.
Event data object schema for customer.order.processing.
Event data object schema for customer.order.updated.
Event data object schema for customer.reward_redemptions.created.
Event data object schema for customer.reward_redemptions.pending.
Event data object schema for customer.reward_redemptions.completed.
Event data object schema for customer.reward_redemptions.rolledback.
Event data object schema for customer.loyalty.updated.
2022-02-25T13:32:08.734Z
| ## Event Customer Loyalty Tier Upgraded -#### Event data object schema for `customer.loyalty.tier.upgraded`. -Event data object schema for customer.loyalty.tier.upgraded.
| Attributes | Description |
|---|---|
| loyalty_tier_from | See: Loyalty Tier |
| loyalty_tier_to | See: Loyalty Tier |
created_atstring | Example: 2022-02-25T13:32:08.734Z |
Event data object schema for customer.loyalty.tier.downgraded.
| Attributes | Description |
|---|---|
| loyalty_tier_from | See: Loyalty Tier |
| loyalty_tier_to | See: Loyalty Tier |
created_atstring | Example: 2022-02-25T13:32:08.734Z |
Event data object schema for customer.loyalty.tier.prolonged.
| Attributes | Description |
|---|---|
| loyalty_tier | See: Loyalty Tier |
created_atstring | Example: 2022-02-25T13:32:08.734Z |
Event data object schema for customer.loyalty.tier.expiration.changed.
| Attributes | Description |
|---|---|
| loyalty_tier | See: Loyalty Tier |
created_atstring | Example: 2022-02-25T13:32:08.734Z |
expiration_datestring | Example: 2022-02-25T13:32:08.734Z |
Event data object schema for customer.loyalty.tier.joined.
| Attributes | Description |
|---|---|
| loyalty_tier | See: Loyalty Tier |
created_atstring | Example: 2022-02-25T13:32:08.734Z |
Event data object schema for customer.loyalty.tier.left.
The type of object represented by JSON.
Available values: `customer` | ## Simple Campaign -#### Request body schema for creating a discount voucher campaign using **POST** `/campaigns`. +Request body schema for creating a discount voucher campaign using POST /campaigns.
Timestamp representing the date and time when the custom event was created in ISO 8601 format.
**Example:**2021-12-22T10:13:06.487Z
| ## Redemption Internal -#### Model Used for internal communication +Model Used for internal communication
+ | Attributes | Description | |:-----|:--------| @@ -841,7 +760,7 @@ All of: All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Order information.
| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
This is an object representing a simple redemption.
+ | Attributes | Description | |:-----|:--------| @@ -946,7 +866,8 @@ All of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| @@ -966,7 +887,8 @@ All of: | metadata`object` |A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
| ## Referral Program -#### Defines the referee reward and the way a referral is triggered. Context: `REFERRAL_PROGRAM`. +Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.
Defines the referee reward.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
related_object_parentobject | Details of the resource from which the reward originates.
| ||||||||
typestring | Type of reward. Available values:DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER, LUCKY_DRAW_CODE | ||||||||
amountstring | Define the number of |
Contains current gift card balance information.
+ | Attributes | Description | |:-----|:--------| @@ -984,8 +907,6 @@ All of: | effect`string` |Defines how the credits are applied to the customer's order.
Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -993,7 +914,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Customer Object -#### This is an object representing a customer with limited properties used in Event Tracking endpoints. +This is an object representing a customer with limited properties used in Event Tracking endpoints.
+ | Attributes | Description | |:-----|:--------| @@ -1016,7 +938,8 @@ Any of: | loyalty_tier_id`string` |Unique loyalty tier ID assigned by Voucherify.
| ## Voucher -#### This is an object representing a voucher. +This is an object representing a voucher.
+ | Attributes | Description | |:-----|:--------| @@ -1051,7 +974,8 @@ Any of: | redemption`object` |Stores a summary of redemptions that have been applied to the voucher.
| Attributes | Description |
|---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_amountinteger | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. Example:100000 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -1100,7 +1024,8 @@ Any of: | points`object` |Defines range of loyalty tier in points.
| Attributes | Description |
|---|---|
frominteger | Bottom points threshold value. |
tointeger | Top points threshold value. |
Defines loyalty tier expiration date.
+ | Attributes | Description | |:-----|:--------| @@ -1131,7 +1056,8 @@ Any of: | metadata`object` |The metadata object stores all custom attributes assigned to the earning rule. A set of key/value pairs that you can attach to an earning rule object. It can be useful for storing additional information about the earning rule in a structured format.
| ## Order Response Base -#### Order information. +Order information.
+ | Attributes | Description | |:-----|:--------| @@ -1205,7 +1131,8 @@ Available values: `POINTS_ACCRUAL`, `POINTS_CANCELLATION`, `POINTS_REDEMPTION`, | result`object` || Attributes | Description |
|---|
Order information.
+ | Attributes | Description | |:-----|:--------| @@ -1227,7 +1154,8 @@ Available values: `POINTS_ACCRUAL`, `POINTS_CANCELLATION`, `POINTS_REDEMPTION`, | object`string` |The type of object represented by JSON.
Available values: `order` | ## Simple Promotion Tier -#### This is an object representing a simple promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone. +This is an object representing a simple promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -1334,10 +1262,6 @@ One of: | object |The type of object represented by the JSON. This object stores information about the reward.
Available values: `reward` | ## Product Object -#### This is an object representing a product. - -This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns. -This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of: @@ -1346,7 +1270,8 @@ All of: 2.| Attributes | Description |
|---|---|
| skus | See: SKUs object |
This is an object representing a product SKU.
+ | Attributes | Description | |:-----|:--------| @@ -1364,7 +1289,8 @@ All of: | object`string` |The type of object represented by JSON. This object stores information about the SKU.
This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -1377,7 +1303,8 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Voucher Assets -#### Stores links to images of QR and barcode that correspond to an encrypted voucher code. +Stores links to images of QR and barcode that correspond to an encrypted voucher code.
+ | Attributes | Description | |:-----|:--------| @@ -1385,7 +1312,8 @@ All of: | barcode`object` |Stores barcode representation of encrypted code.
| Attributes | Description |
|---|---|
idstring | Encrypted voucher code ID. Example:U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ== |
urlstring | URL to barcode Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D |
Validation Rule Assignments
+ | Attributes | Description | |:-----|:--------| @@ -1470,42 +1398,48 @@ All of: 1. [Applicable To](#applicable-to) ## Coupon Code -#### This is a `result` object representing the results for a coupon code. +This is a result object representing the results for a coupon code.
Discount details about the type of discount to be applied for the redeemable.
One of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) | ## Gift Card -#### This is a `result` object representing the results for a gift card. +This is a result object representing the results for a gift card.
Stores the amount of gift card credits to be applied in the redemption.
| Attributes | Description |
|---|---|
creditsinteger | Total number of gift card credits to be applied in the redemption expressed as the smallest currency unit (e.g. 100 cents for $1.00). |
This is a result object representing the results for a loyalty card.
Stores the amount of loyalty card points to be applied in the redemption.
| Attributes | Description |
|---|---|
pointsinteger | Total number of loyalty points to be applied in the redemption. |
This is a result object representing the results for a promotion tier.
Discount details about the type of discount to be applied for the redeemable.
Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) | ## Promotion Stack -#### This is a `result` object representing the results for a promotion stack. +This is a result object representing the results for a promotion stack.
Stores the amount of loyalty card points to be applied in the redemption.
| Attributes | Description |
|---|---|
pointsinteger | Total number of loyalty points to be applied in the redemption. |
Error details
+ | Attributes | Description | |:-----|:--------| @@ -1597,7 +1531,8 @@ One of: | object`string` |The type of object represented by JSON. This object stores information about the product.
Available values: `product` | ## SKUs object -#### Contains information about child SKUs. +Contains information about child SKUs.
+ | Attributes | Description | |:-----|:--------| @@ -1607,7 +1542,8 @@ One of: | total`integer` |Total number of SKUs in the product.
| ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/CUSTOMERS-API-Customer-Object.md b/docs/reference-docs/CUSTOMERS-API-Customer-Object.md index 5649266ef..09bfc024d 100644 --- a/docs/reference-docs/CUSTOMERS-API-Customer-Object.md +++ b/docs/reference-docs/CUSTOMERS-API-Customer-Object.md @@ -28,7 +28,8 @@ All of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/EVENTS-API-Custom-Event-Object.md b/docs/reference-docs/EVENTS-API-Custom-Event-Object.md index a6ac09600..528a373e2 100644 --- a/docs/reference-docs/EVENTS-API-Custom-Event-Object.md +++ b/docs/reference-docs/EVENTS-API-Custom-Event-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Track Custom Event Request Body -#### Request schema for tracking a custom event. +Request schema for tracking a custom event.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/EXPORTS-API-Export-Object.md b/docs/reference-docs/EXPORTS-API-Export-Object.md index 6a6579807..b80b18ce4 100644 --- a/docs/reference-docs/EXPORTS-API-Export-Object.md +++ b/docs/reference-docs/EXPORTS-API-Export-Object.md @@ -74,7 +74,8 @@ Available values: `-created_at`, `created_at`, `-updated_at`, `updated_at`, `-co Available values: `code`, `voucher_type`, `value`, `discount_type`, `campaign`, `category`, `start_date`, `expiration_date`, `gift_balance`, `loyalty_balance`, `redemption_quantity`, `redemption_count`, `active`, `qr_code`, `bar_code`, `metadata`, `id`, `is_referral_code`, `created_at`, `updated_at`, `validity_timeframe_interval`, `validity_timeframe_duration`, `validity_day_of_week`, `discount_amount_limit`, `campaign_id`, `additional_info`, `customer_id`, `discount_unit_type`, `discount_unit_effect`, `customer_source_id` ## Export Voucher Filters -#### Allowed additional properties must start with "metadata." or "redemption." +Allowed additional properties must start with "metadata." or "redemption."
+ | Attributes | Description | |:-----|:--------| @@ -104,7 +105,8 @@ Available values: `-id`, `id`, `-voucher_code`, `voucher_code`, `-tracking_id`, Available values: `id`, `object`, `date`, `voucher_code`, `campaign`, `promotion_tier_id`, `customer_id`, `customer_source_id`, `customer_name`, `tracking_id`, `order_amount`, `gift_amount`, `loyalty_points`, `result`, `failure_code`, `failure_message`, `metadata` ## Export Redemption Filters -#### Allowed additional properties must start with "metadata." +Allowed additional properties must start with "metadata."
+ | Attributes | Description | |:-----|:--------| @@ -134,7 +136,8 @@ Available values: `-name`, `name`, `-id`, `id`, `-email`, `email`, `-source_id`, Available values: `name`, `id`, `description`, `email`, `source_id`, `created_at`, `address_city`, `address_state`, `address_line_1`, `address_line_2`, `address_country`, `address_postal_code`, `redemptions_total_redeemed`, `redemptions_total_failed`, `redemptions_total_succeeded`, `redemptions_total_rolled_back`, `redemptions_total_rollback_failed`, `redemptions_total_rollback_succeeded`, `orders_total_amount`, `orders_total_count`, `orders_average_amount`, `orders_last_order_amount`, `orders_last_order_date`, `loyalty_points`, `loyalty_referred_customers`, `updated_at`, `phone`, `birthday`, `metadata`, `birthdate` ## Export Customer Filters -#### Allowed additional properties must start with "metadata." or "address." or "summary." or "loyalty." or "loyalty_tier." or "loyalty_points." or "system_metadata." +Allowed additional properties must start with "metadata." or "address." or "summary." or "loyalty." or "loyalty_tier." or "loyalty_points." or "system_metadata."
+ | Attributes | Description | |:-----|:--------| @@ -157,7 +160,8 @@ Available values: `-id`, `id`, `-voucher_code`, `voucher_code`, `-tracking_id`, Available values: `voucher_code`, `customer_id`, `customer_source_id`, `date`, `channel`, `campaign`, `is_winner`, `metadata` ## Export Publication Filters -#### Allowed additional properties must start with "metadata." +Allowed additional properties must start with "metadata."
+ | Attributes | Description | |:-----|:--------| @@ -184,7 +188,8 @@ Available values: `-created_at`, `created_at`, `-updated_at`, `updated_at`, `-st Available values: `id`, `source_id`, `created_at`, `updated_at`, `status`, `amount`, `discount_amount`, `items_discount_amount`, `total_discount_amount`, `total_amount`, `customer_id`, `referrer_id`, `metadata` ## Export Order Filters -#### Allowed additional properties must start with "metadata." +Allowed additional properties must start with "metadata."
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/LOCATIONS-API-Location-Object.md b/docs/reference-docs/LOCATIONS-API-Location-Object.md index 83cf7a82c..eecdb4e3a 100644 --- a/docs/reference-docs/LOCATIONS-API-Location-Object.md +++ b/docs/reference-docs/LOCATIONS-API-Location-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Location object -#### This is an object representing a location. +This is an object representing a location.
+ | Attributes | Description | |:-----|:--------| @@ -21,33 +22,31 @@ order: 1 | updated_at`string` |Timestamp representing the date and time when the location was updated in ISO 8601 format.
**Example:**2022-03-14T15:12:06.817Z
| ## Circle -#### This is an object representing a circular shape. +This is an object representing a circular shape.
+ | Attributes | Description | |:-----|:--------| | type`string` |The type of shape being defined is a circle.
The location is defined in terms of a distance object.
Defines the parameters for the circle.
| Attributes | Description |
|---|---|
centerstring | Center of the circle identified by GPS coordinates in decimal degrees. Example:geo:40.79372699823857,-74.15092132694554 |
radiusstring | Defines the radius of the circle. |
Defines the parameters for the circle.
Defines the parameters for the circle.
| Attributes | Description |
|---|---|
centerstring | Center of the circle identified by GPS coordinates in decimal degrees. Example:geo:40.79372699823857,-74.15092132694554 |
radiusstring | Defines the radius of the circle. |
This is an object representing a polygon.
+ | Attributes | Description | |:-----|:--------| | type`string` |The type of shape being defined is a polygon.
The location is defined in terms of a geojson object.
Defines the parameters for the polygon.
| Attributes | Description |
|---|---|
typestring | Type of geojson coordinates, i.e. |
coordinatesarray | Contains array of GeoJSON coordinate arrays. Array of GeoJSON coordinate array. |
Defines the parameters for the polygon.
Defines the parameters for the polygon.
| Attributes | Description |
|---|---|
typestring | Type of geojson coordinates, i.e. |
coordinatesarray | Contains array of GeoJSON coordinate arrays. Array of GeoJSON coordinate array. |
GeoJSON coordinate array.
Array of [GeoJSON coordinate.](#geojson-coordinate.) ## GeoJSON coordinate. -#### GeoJSON coordinate. -GeoJSON coordinate.
[block:html] diff --git a/docs/reference-docs/LOYALTIES-API-Loyalty-Campaign-Object.md b/docs/reference-docs/LOYALTIES-API-Loyalty-Campaign-Object.md index 9354cfcc5..46be7fb87 100644 --- a/docs/reference-docs/LOYALTIES-API-Loyalty-Campaign-Object.md +++ b/docs/reference-docs/LOYALTIES-API-Loyalty-Campaign-Object.md @@ -9,9 +9,8 @@ order: 1 --- ## Loyalty Campaign Object -#### This is an object representing a loyalty campaign. +This is an object representing a loyalty campaign.
The loyalty campaign object contains details about the loyalty campaign. You can use dedicated endpoints to list loyalty campaigns, list loyalty card holders, member activities, active rewards, earning rules, loyalty tiers for given loyalty campaign.
-The loyalty campaign object contains details about the loyalty campaign. You can use dedicated endpoints to list loyalty campaigns, list loyalty card holders, member activities, active rewards, earning rules, loyalty tiers for given loyalty campaign. | Attributes | Description | |:-----|:--------| @@ -43,7 +42,8 @@ The loyalty campaign object contains details about the loyalty campaign. You can | object`string` |The type of object represented by JSON. This object stores information about the campaign.
| ## Loyalty Card -#### Schema model for a loyalty card. +Schema model for a loyalty card.
+ | Attributes | Description | |:-----|:--------| @@ -54,7 +54,8 @@ The loyalty campaign object contains details about the loyalty campaign. You can | is_referral_code`boolean` |Indicates whether the voucher is a referral code; this is true for campaign type REFERRAL_PROGRAM.
This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -67,7 +68,8 @@ The loyalty campaign object contains details about the loyalty campaign. You can | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Balance -#### Defines the Balance expiration mechanism for loyalty tiers. +Defines the Balance expiration mechanism for loyalty tiers.
+ | Attributes | Description | |:-----|:--------| @@ -76,7 +78,8 @@ The loyalty campaign object contains details about the loyalty campaign. You can | expiration_date |Defines the conditions for the expiration date of a tier.
Any of: [Balance Drop](#balance-drop), [Custom](#custom) | ## Points in Period -#### Defines the Points in Period expiration mechanism for loyalty tiers. +Defines the Points in Period expiration mechanism for loyalty tiers.
+ | Attributes | Description | |:-----|:--------| @@ -86,14 +89,16 @@ The loyalty campaign object contains details about the loyalty campaign. You can | expiration_date`object` |Defines the conditions for the expiration date of a tier.
| Attributes | Description |
|---|---|
typestring | What triggers the tier to expire for a customer. END_OF_PERIOD, END_OF_NEXT_PERIOD |
extendstring | Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of |
Defines the conditions for the expiration date of a tier based on a pure balance drop.
+ | Attributes | Description | |:-----|:--------| | type`string` |What triggers the tier to expire for a customer.BALANCE_DROP: Tier expires when the points balance drops below the required range of the tier.
Defines the custom conditions for the expiration date of a tier.
+ | Attributes | Description | |:-----|:--------| @@ -102,7 +107,8 @@ The loyalty campaign object contains details about the loyalty campaign. You can | rounding |Defines the rounding mechanism for tier expiration.
Any of: [Calendar Periods](#calendar-periods), [Specific Month](#specific-month) | ## Calendar Periods -#### Defines the rounding mechanism for tier expiration based on a list of available time periods. +Defines the rounding mechanism for tier expiration based on a list of available time periods.
+ | Attributes | Description | |:-----|:--------| @@ -110,7 +116,8 @@ The loyalty campaign object contains details about the loyalty campaign. You can | strategy`string` |Which portion of the given period should the rounding be applied to.
Available values: `END` | ## Specific Month -#### Defines the custom rounding mechanism for tier expiration. +Defines the custom rounding mechanism for tier expiration.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/LOYALTIES-API-Loyalty-Card-Object.md b/docs/reference-docs/LOYALTIES-API-Loyalty-Card-Object.md index e0669a224..707be1d76 100644 --- a/docs/reference-docs/LOYALTIES-API-Loyalty-Card-Object.md +++ b/docs/reference-docs/LOYALTIES-API-Loyalty-Card-Object.md @@ -9,7 +9,8 @@ order: 2 --- ## Loyalty Card Object -#### This is an object representing a loyalty card. +This is an object representing a loyalty card.
+ | Attributes | Description | |:-----|:--------| @@ -41,7 +42,8 @@ order: 2 | object`string` |The type of object represented by JSON. Default is voucher.
This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md b/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md index 57481dbaa..c9908b2ec 100644 --- a/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md +++ b/docs/reference-docs/LOYALTIES-API-Loyalty-Tier-Object.md @@ -23,7 +23,8 @@ All of: | points`object` |Defines range of loyalty tier in points.
| Attributes | Description |
|---|---|
frominteger | Bottom points threshold value. |
tointeger | Top points threshold value. |
Defines loyalty tier expiration date.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md b/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md index 873b24bb3..4b087870b 100644 --- a/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md +++ b/docs/reference-docs/METADATA-SCHEMAS-API-Metadata-Schema-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Metadata Schema Object -#### This is an object representing a metadata schema. +This is an object representing a metadata schema.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/ORDERS-API-Order-Object.md b/docs/reference-docs/ORDERS-API-Order-Object.md index e3fb7416c..08c124803 100644 --- a/docs/reference-docs/ORDERS-API-Order-Object.md +++ b/docs/reference-docs/ORDERS-API-Order-Object.md @@ -12,10 +12,11 @@ order: 1 All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Order information.
| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Order information.
+ | Attributes | Description | |:-----|:--------| @@ -109,7 +110,8 @@ All of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/PRODUCT-COLLECTIONS-API-Product-Collection-Object.md b/docs/reference-docs/PRODUCT-COLLECTIONS-API-Product-Collection-Object.md index 7f9b89b25..04ddb80be 100644 --- a/docs/reference-docs/PRODUCT-COLLECTIONS-API-Product-Collection-Object.md +++ b/docs/reference-docs/PRODUCT-COLLECTIONS-API-Product-Collection-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Product Collection Base -#### This is an object representing a product collection base. +This is an object representing a product collection base.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/PRODUCTS-API-Product-Object.md b/docs/reference-docs/PRODUCTS-API-Product-Object.md index 585b94ac5..ef49fcaf2 100644 --- a/docs/reference-docs/PRODUCTS-API-Product-Object.md +++ b/docs/reference-docs/PRODUCTS-API-Product-Object.md @@ -9,10 +9,6 @@ order: 1 --- ## Product Object -#### This is an object representing a product. - -This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns. -This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of: @@ -35,7 +31,8 @@ All of: | object`string` |The type of object represented by JSON. This object stores information about the product.
Available values: `product` | ## SKUs object -#### Contains information about child SKUs. +Contains information about child SKUs.
+ | Attributes | Description | |:-----|:--------| @@ -45,7 +42,8 @@ All of: | total`integer` |Total number of SKUs in the product.
| ## SKU Object -#### This is an object representing a product SKU. +This is an object representing a product SKU.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/PRODUCTS-API-SKU-Object.md b/docs/reference-docs/PRODUCTS-API-SKU-Object.md index c546e35cf..0df3fe3a9 100644 --- a/docs/reference-docs/PRODUCTS-API-SKU-Object.md +++ b/docs/reference-docs/PRODUCTS-API-SKU-Object.md @@ -9,7 +9,8 @@ order: 2 --- ## SKU Object -#### This is an object representing a product SKU. +This is an object representing a product SKU.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/PROMOTIONS-API-Promotion-Tier-Object.md b/docs/reference-docs/PROMOTIONS-API-Promotion-Tier-Object.md index b63f6ce01..7a357e5dc 100644 --- a/docs/reference-docs/PROMOTIONS-API-Promotion-Tier-Object.md +++ b/docs/reference-docs/PROMOTIONS-API-Promotion-Tier-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Promotion Tier -#### This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone. +This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -36,8 +37,6 @@ order: 1 | categories`array` | Array of [Category](#category) | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -45,7 +44,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Validation Rule Assignments -#### Validation Rule Assignments +Validation Rule Assignments
+ | Attributes | Description | |:-----|:--------| @@ -55,7 +55,8 @@ Any of: | total`integer` |Total number of validation rule assignments.
| ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -117,7 +118,8 @@ Any of: | is_dynamic`boolean` |Flag indicating whether the discount was calculated using a formula.
| ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md b/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md index 88636f94e..93433280c 100644 --- a/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md +++ b/docs/reference-docs/PUBLICATIONS-API-Publication-Object.md @@ -9,8 +9,6 @@ order: 1 --- ## Create Publication Response Body -#### Response schema model for publishing vouchers to a specific customer. -Response schema model for publishing vouchers to a specific customer.
One of: @@ -18,8 +16,6 @@ One of: [Publications Create Response Single Voucher Body](#publications-create-response-single-voucher-body), [Publications Create Response Multiple Vouchers Body](#publications-create-response-multiple-vouchers-body) ## Publications Create Response Single Voucher Body -#### Response schema model for publishing a single voucher to a specific customer. -Response schema model for publishing a single voucher to a specific customer.
All of: @@ -28,8 +24,6 @@ All of: 2.| Attributes | Description |
|---|---|
| voucher | See: Voucher |
Response schema model for publishing a multiple vouchers to a specific customer.
All of: @@ -53,7 +47,8 @@ All of: | vouchers_id`array` |Contains the unique internal voucher ID that was assigned by Voucherify.
| ## Voucher -#### This is an object representing a voucher. +This is an object representing a voucher.
+ | Attributes | Description | |:-----|:--------| @@ -94,7 +89,8 @@ All of: 2. [Customer Base](#customer-base) ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -107,8 +103,6 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -116,7 +110,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Voucher Assets -#### Stores links to images of QR and barcode that correspond to an encrypted voucher code. +Stores links to images of QR and barcode that correspond to an encrypted voucher code.
+ | Attributes | Description | |:-----|:--------| @@ -147,7 +142,8 @@ Any of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md b/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md index ea0976370..cd3b5af9e 100644 --- a/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md +++ b/docs/reference-docs/QUALIFICATIONS-API-Qualification-Object.md @@ -13,7 +13,8 @@ order: 1 > Read our dedicated guide to learn about some use cases these endpoints can cover [here](doc:checking-eligibility). ## Qualification object -#### This is an object representing a qualification. +This is an object representing a qualification.
+ | Attributes | Description | |:-----|:--------| @@ -23,7 +24,8 @@ order: 1 | stacking_rules | See: [Examine Qualification Stacking Rules](#examine-qualification-stacking-rules) | ## Redeemables -#### List of redeemables for examine qualification. +List of redeemables for examine qualification.
+ | Attributes | Description | |:-----|:--------| @@ -38,10 +40,11 @@ order: 1 All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Order information.
| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Defines stacking rules for redeemables. Read more in the Help Center
+ | Attributes | Description | |:-----|:--------| @@ -58,7 +61,8 @@ All of: 2.| Attributes | Description |
|---|---|
redeemablesarray | Array of Single redeemable |
Order information.
+ | Attributes | Description | |:-----|:--------| @@ -106,7 +110,8 @@ All of: 1. [Customer Id](#customer-id) ## Single redeemable -#### Data of single redeemable which was properly qualified. +Data of single redeemable which was properly qualified.
+ | Attributes | Description | |:-----|:--------| @@ -173,7 +178,8 @@ All of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| @@ -193,7 +199,8 @@ All of: | metadata`object` |A set of custom key/value pairs that you can attach to a customer. The metadata object stores all custom attributes assigned to the customer. It can be useful for storing additional information about the customer in a structured format. This metadata can be used for validating whether the customer qualifies for a discount or it can be used in building customer segments.
| ## Redeemable Single Result -#### Information about redeemable result. +Information about redeemable result.
+ | Attributes | Description | |:-----|:--------| @@ -219,7 +226,8 @@ All of: | data_ref`string` |The type of object represented by JSON.
Available values: `data` | ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -232,7 +240,8 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Validation Rules Assignments List -#### List of Validation Rules Assignments +List of Validation Rules Assignments
+ | Attributes | Description | |:-----|:--------| @@ -263,8 +272,6 @@ All of: | last_order_date`string` |Timestamp representing the date and time of the customer's last order in ISO 8601 format.
**Example:**2022-08-30T11:51:08.029Z
| ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -272,7 +279,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Gift -#### Contains current gift card balance information. +Contains current gift card balance information.
+ | Attributes | Description | |:-----|:--------| @@ -280,7 +288,8 @@ Any of: | credits`number` |The number of credits that the user wants to use from the gift card to fulfil the order. The value of credits cannot be higher than the current balance on the gift card. If the user gives more points than he has on the gift card, the application will return an error code in response. Value is multiplied by 100 to precisely represent 2 decimal places. For example 10000 cents for $100.00.
Loyalty Card object response
+ | Attributes | Description | |:-----|:--------| @@ -291,7 +300,8 @@ Any of: | transfers`array` | Array of [Loyalties Transfer Points](#loyalties-transfer-points) | ## Error Object -#### Error details +Error details
+ | Attributes | Description | |:-----|:--------| @@ -327,7 +337,8 @@ All of: 1. [Applicable To](#applicable-to) ## Business Validation Rule Assignment -#### Assignments of business validation rule +Assignments of business validation rule
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md b/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md index eadae26ae..cd5715d6f 100644 --- a/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md +++ b/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Redemption -#### This is an object representing a redemption. +This is an object representing a redemption.
+ | Attributes | Description | |:-----|:--------| @@ -41,7 +42,7 @@ order: 1 All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | If only |
| referrer | If only |
Order information.
| Attributes | Description |
|---|---|
| customer | If only |
| referrer | If only |
The type of object represented by JSON.
Available values: `customer` | ## Voucher -#### This is an object representing a voucher. +This is an object representing a voucher.
+ | Attributes | Description | |:-----|:--------| @@ -89,7 +91,8 @@ All of: | redemption`object` |Stores a summary of redemptions that have been applied to the voucher.
| Attributes | Description |
|---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_amountinteger | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. Example:100000 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -127,7 +130,8 @@ All of: | loyalty_tier_id`string` |Unique loyalty tier ID assigned by Voucherify.
| ## Order Response Base -#### Order information. +Order information.
+ | Attributes | Description | |:-----|:--------| @@ -164,7 +168,8 @@ All of: 1. [Customer Id](#customer-id) ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -177,8 +182,6 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -186,7 +189,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Voucher Assets -#### Stores links to images of QR and barcode that correspond to an encrypted voucher code. +Stores links to images of QR and barcode that correspond to an encrypted voucher code.
+ | Attributes | Description | |:-----|:--------| @@ -194,7 +198,8 @@ Any of: | barcode`object` |Stores barcode representation of encrypted code.
| Attributes | Description |
|---|---|
idstring | Encrypted voucher code ID. Example:U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ== |
urlstring | URL to barcode Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D |
Validation Rule Assignments
+ | Attributes | Description | |:-----|:--------| @@ -225,10 +230,6 @@ All of: 2. [Customer Base](#customer-base) ## Product Object -#### This is an object representing a product. - -This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns. -This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of: @@ -237,7 +238,8 @@ All of: 2.| Attributes | Description |
|---|---|
| skus | See: SKUs object |
This is an object representing a product SKU.
+ | Attributes | Description | |:-----|:--------| @@ -337,7 +339,8 @@ All of: | is_dynamic`boolean` |Flag indicating whether the discount was calculated using a formula.
| ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| @@ -367,7 +370,8 @@ One of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| @@ -401,7 +405,8 @@ One of: | object`string` |The type of object represented by JSON. This object stores information about the product.
Available values: `product` | ## SKUs object -#### Contains information about child SKUs. +Contains information about child SKUs.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md b/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md index 60cb68d00..bbfe4a0ba 100644 --- a/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md +++ b/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md @@ -9,7 +9,8 @@ order: 2 --- ## Redemption Rollback -#### This is an object representing a redemption rollback. +This is an object representing a redemption rollback.
+ | Attributes | Description | |:-----|:--------| @@ -42,7 +43,7 @@ order: 2 All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | If only |
| referrer | If only |
Order information.
| Attributes | Description |
|---|---|
| customer | If only |
| referrer | If only |
The type of object represented by JSON.
Available values: `customer` | ## Voucher -#### This is an object representing a voucher. +This is an object representing a voucher.
+ | Attributes | Description | |:-----|:--------| @@ -90,7 +92,8 @@ All of: | redemption`object` |Stores a summary of redemptions that have been applied to the voucher.
| Attributes | Description |
|---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_amountinteger | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. Example:100000 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -128,7 +131,8 @@ All of: | loyalty_tier_id`string` |Unique loyalty tier ID assigned by Voucherify.
| ## Order Response Base -#### Order information. +Order information.
+ | Attributes | Description | |:-----|:--------| @@ -165,7 +169,8 @@ All of: 1. [Customer Id](#customer-id) ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -178,8 +183,6 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -187,7 +190,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Voucher Assets -#### Stores links to images of QR and barcode that correspond to an encrypted voucher code. +Stores links to images of QR and barcode that correspond to an encrypted voucher code.
+ | Attributes | Description | |:-----|:--------| @@ -195,7 +199,8 @@ Any of: | barcode`object` |Stores barcode representation of encrypted code.
| Attributes | Description |
|---|---|
idstring | Encrypted voucher code ID. Example:U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ== |
urlstring | URL to barcode Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D |
Validation Rule Assignments
+ | Attributes | Description | |:-----|:--------| @@ -226,10 +231,6 @@ All of: 2. [Customer Base](#customer-base) ## Product Object -#### This is an object representing a product. - -This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns. -This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of: @@ -238,7 +239,8 @@ All of: 2.| Attributes | Description |
|---|---|
| skus | See: SKUs object |
This is an object representing a product SKU.
+ | Attributes | Description | |:-----|:--------| @@ -338,7 +340,8 @@ All of: | is_dynamic`boolean` |Flag indicating whether the discount was calculated using a formula.
| ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| @@ -368,7 +371,8 @@ One of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| @@ -402,7 +406,8 @@ One of: | object`string` |The type of object represented by JSON. This object stores information about the product.
Available values: `product` | ## SKUs object -#### Contains information about child SKUs. +Contains information about child SKUs.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md b/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md index dffa04745..214dd4135 100644 --- a/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md +++ b/docs/reference-docs/SEGMENTS-API-Customer-Segment-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Customer Segment Object -#### This is an object representing a customer segment. +This is an object representing a customer segment.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md b/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md index 0a2113316..86e08e1f0 100644 --- a/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md +++ b/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md @@ -18,7 +18,8 @@ order: 3 | skipped_redeemables`array` |Lists validation results of each redeemable. If a redeemable can be applied, the API returns "status": "APPLICABLE".
This is an object representing a redemption.
+ | Attributes | Description | |:-----|:--------| @@ -50,7 +51,7 @@ order: 3 All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Order information.
| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
| Attributes | Description |
|---|---|
| customer | If only |
| referrer | If only |
Order information.
| Attributes | Description |
|---|---|
| customer | If only |
| referrer | If only |
The type of object represented by JSON.
Available values: `customer` | ## Voucher -#### This is an object representing a voucher. +This is an object representing a voucher.
+ | Attributes | Description | |:-----|:--------| @@ -120,7 +122,8 @@ All of: | redemption`object` |Stores a summary of redemptions that have been applied to the voucher.
| Attributes | Description |
|---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_amountinteger | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. Example:100000 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This is an object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
+ | Attributes | Description | |:-----|:--------| @@ -158,7 +161,8 @@ All of: | loyalty_tier_id`string` |Unique loyalty tier ID assigned by Voucherify.
| ## Order Response Base -#### Order information. +Order information.
+ | Attributes | Description | |:-----|:--------| @@ -206,7 +210,8 @@ All of: 1. [Customer Id](#customer-id) ## Error Object -#### Error details +Error details
+ | Attributes | Description | |:-----|:--------| @@ -219,7 +224,8 @@ All of: | resource_type`string` |The resource type.
**Example:**voucher
| ## Category -#### This is an object representing a category. +This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -232,8 +238,6 @@ All of: | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -241,7 +245,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Voucher Assets -#### Stores links to images of QR and barcode that correspond to an encrypted voucher code. +Stores links to images of QR and barcode that correspond to an encrypted voucher code.
+ | Attributes | Description | |:-----|:--------| @@ -249,7 +254,8 @@ Any of: | barcode`object` |Stores barcode representation of encrypted code.
| Attributes | Description |
|---|---|
idstring | Encrypted voucher code ID. Example:U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ== |
urlstring | URL to barcode Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.
https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D |
Validation Rule Assignments
+ | Attributes | Description | |:-----|:--------| @@ -274,10 +280,6 @@ Any of: | object |The type of object represented by the JSON. This object stores information about the reward.
Available values: `reward` | ## Product Object -#### This is an object representing a product. - -This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns. -This is an object representing a product.
This entity should be used to map product items from your inventory management system. The aim of products is to build which reflect product-specific campaigns.
All of: @@ -286,7 +288,8 @@ All of: 2.| Attributes | Description |
|---|---|
| skus | See: SKUs object |
This is an object representing a product SKU.
+ | Attributes | Description | |:-----|:--------| @@ -350,7 +353,8 @@ All of: | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| @@ -419,7 +423,8 @@ All of: | is_dynamic`boolean` |Flag indicating whether the discount was calculated using a formula.
| ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| @@ -450,7 +455,8 @@ One of: | object`string` |The type of object represented by JSON. This object stores information about the product.
Available values: `product` | ## SKUs object -#### Contains information about child SKUs. +Contains information about child SKUs.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Assignment-Object.md b/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Assignment-Object.md index 3582eb2c2..c09f4eca9 100644 --- a/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Assignment-Object.md +++ b/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Assignment-Object.md @@ -9,7 +9,8 @@ order: 2 --- ## Validation Rule Assignment -#### This is an object representing a validation rule assignment. +This is an object representing a validation rule assignment.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md b/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md index 76759057b..806ba29ee 100644 --- a/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md +++ b/docs/reference-docs/VALIDATION-RULES-API-Validation-Rule-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Validation Rule Response -#### This is an object representing a validation rule. +This is an object representing a validation rule.
+ | Attributes | Description | |:-----|:--------| @@ -26,7 +27,8 @@ order: 1 | object`string` |The type of object represented by JSON. This object stores information about the validation rule.
| ## Validation Rule Rules -#### Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consequtively beginning from `1`. The values are objects containing the rule conditions. +Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consequtively beginning from 1. The values are objects containing the rule conditions.
Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
| Attributes | Description | ||||
|---|---|---|---|---|---|
namestring | Voucherify specific rule name. The list of available names is provided below. Name | ||||
propertystring,null | Custom name for a metadata property associated with the condition to be satisfied. Required if the property | ||||
| conditions | See: Validation Rule Conditions | ||||
| rules | See: Validation Rule Rules | ||||
errorobject | Contains the error message returned from API when validation / redemption fails to meet requirements of defined rule.
|
A set of key value pairs representing the condition name and value. The list of available conditions is provided below:
| Condition (key) | Definition |
|---|---|
| $is | A property is a predefined value. |
| $is_not | A property is not a predefined value. |
| $in | A property either one value in a predefined list of values. |
| $less_than | A property is less than a predefined value. |
| $less_than_or_equal | A property is less than or equal to a predefined value. |
| $more_than | A property is more than a predefined value. |
| $more_than_or_equal | A property is more than or equal to a predefined value. |
| $starts_with | A property starts with the predefined sequence of characters. |
| $ends_with | A property ends with the predefined sequence of characters. |
| $contains | A property contains the predefined sequence of characters. |
| $timeframe | |
| $timeframe_absolute | |
| $dow | |
| $count | |
| $count_more | |
| $count_less | |
| $from |
The type of object represented by JSON.
Available values: `data` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -70,7 +68,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Gift -#### Contains current gift card balance information. +Contains current gift card balance information.
+ | Attributes | Description | |:-----|:--------| @@ -82,7 +81,7 @@ Any of: All of: 1. [Order Response Base](#order-response-base) -2.| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Order information.
| Attributes | Description |
|---|---|
| customer | Any of: Customer Response, Customer Id |
| referrer | Any of: Referrer Response, Referrer Id |
Flag indicating whether the discount was calculated using a formula.
| ## Order Response Base -#### Order information. +Order information.
+ | Attributes | Description | |:-----|:--------| @@ -298,7 +298,8 @@ Available values: `APPLY_TO_ORDER`, `APPLY_TO_ITEMS` | campaigns`object` |Contains campaigns with details about point balances and how many customers were referred by the customer.
| Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
[propertyName]object | Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.
|
Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.
+ | Attributes | Description | |:-----|:--------| diff --git a/docs/reference-docs/VOUCHERS-API-Voucher-Object.md b/docs/reference-docs/VOUCHERS-API-Voucher-Object.md index ac16c9c80..bf4009404 100644 --- a/docs/reference-docs/VOUCHERS-API-Voucher-Object.md +++ b/docs/reference-docs/VOUCHERS-API-Voucher-Object.md @@ -9,7 +9,8 @@ order: 1 --- ## Voucher -#### This is an object representing a voucher. +This is an object representing a voucher.
+ | Attributes | Description | |:-----|:--------| @@ -44,7 +45,8 @@ order: 1 | redemption`object` |Stores a summary of redemptions that have been applied to the voucher.
| Attributes | Description |
|---|---|
quantityinteger | How many times a voucher can be redeemed. A |
redeemed_quantityinteger | How many times a voucher has already been redeemed. Example:1 |
redeemed_amountinteger | Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000. Example:100000 |
redeemed_pointsinteger | Total loyalty points redeemed. Example:100000 |
objectstring | The type of object represented is by default |
urlstring | The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/WVPblOYX/redemptions?page=1&limit=10 |
This is an object representing a category.
+ | Attributes | Description | |:-----|:--------| @@ -57,8 +59,6 @@ order: 1 | stacking_rules_type`string` |The type of the stacking rule eligibility.
Available values: `JOINT`, `EXCLUSIVE` | ## Discount -#### Contains information about discount. -Contains information about discount.
Any of: @@ -66,7 +66,8 @@ Any of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) ## Voucher Assets -#### Stores links to images of QR and barcode that correspond to an encrypted voucher code. +Stores links to images of QR and barcode that correspond to an encrypted voucher code.
+ | Attributes | Description | |:-----|:--------|