diff --git a/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md b/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md index 3fe9c1122..24483a724 100644 --- a/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md +++ b/docs/reference-docs/CAMPAIGNS-API-Campaign-Object.md @@ -124,7 +124,7 @@ All of: | validity_day_of_week
`array` |

Integer array corresponding to the particular days of the week in which the promotion tier is valid.

| | summary
`object` |

Contains statistics about promotion tier redemptions and orders.

AttributesDescription
redemptions
object

Contains statistics about promotion tier redemptions.

AttributesDescription
total_redeemed
integer

Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

AttributesDescription
total_amount
integer

Sum of order totals.

total_discount_amount
integer

Sum of total discount applied using the promotion tier.

| | object
`string` |

The type of object represented by JSON. This object stores information about the promotion tier.

| -| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| validation_rule_assignments | See: [Validation Rule Assignments List](#validation-rule-assignments-list) | | category_id
`string` |

Promotion tier category ID.

**Example:**

cat_0c9da30e7116ba6bba

| | categories
`array` | Array of [Category](#category) | @@ -166,7 +166,7 @@ All of: 1. [Code Config](#code-config) -## Validation Rule Assignments +## Validation Rule Assignments List | Attributes | Description | |:-----|:--------| | object
`string` |

The type of object represented by JSON. This object stores information about validation rule assignments.

| diff --git a/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md b/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md index 3bc503629..0b9b48a37 100644 --- a/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md +++ b/docs/reference-docs/CUSTOMERS-API-Customer-Activity-Object.md @@ -907,7 +907,7 @@ One of: | validity_day_of_week
`array` |

Integer array corresponding to the particular days of the week in which the promotion tier is valid.

| | summary
`object` |

Contains statistics about promotion tier redemptions and orders.

AttributesDescription
redemptions
object

Contains statistics about promotion tier redemptions.

AttributesDescription
total_redeemed
integer

Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

AttributesDescription
total_amount
integer

Sum of order totals.

total_discount_amount
integer

Sum of total discount applied using the promotion tier.

| | object
`string` |

The type of object represented by JSON. This object stores information about the promotion tier.

| -| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| validation_rule_assignments | See: [Validation Rule Assignments List](#validation-rule-assignments-list) | | category_id
`string` |

Promotion tier category ID.

**Example:**

cat_0c9da30e7116ba6bba

| | categories
`array` | Array of [Category](#category) | @@ -1200,7 +1200,7 @@ All of: | qr
`object` |

Stores Quick Response (QR) representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==

url
string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D

| | barcode
`object` |

Stores barcode representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==

url
string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D

| -## Validation Rule Assignments +## Validation Rule Assignments List | Attributes | Description | |:-----|:--------| | object
`string` |

The type of object represented by JSON. This object stores information about validation rule assignments.

| diff --git a/docs/reference-docs/EXPORTS-API-Export-Object.md b/docs/reference-docs/EXPORTS-API-Export-Object.md index 02918478e..0bf9d01b2 100644 --- a/docs/reference-docs/EXPORTS-API-Export-Object.md +++ b/docs/reference-docs/EXPORTS-API-Export-Object.md @@ -261,7 +261,9 @@ Available values: `id`, `campaign_id`, `voucher_id`, `type`, `source_id`, `reaso | details | See: [Field Conditions](#field-conditions) | ## Junction -Available values: `and`, `AND`, `or`, `OR` +

Logical Operator Between Filters. Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.

+ +Available values: `and`, `or` ## Field Conditions | 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 e3e71eb8b..8bb56aabf 100644 --- a/docs/reference-docs/PRODUCT-COLLECTIONS-API-Product-Collection-Object.md +++ b/docs/reference-docs/PRODUCT-COLLECTIONS-API-Product-Collection-Object.md @@ -20,7 +20,9 @@ order: 1 | object
`string` |

The type of object represented by JSON. This object stores information about the static product collection.

Available values: `products_collection` | ## Junction -Available values: `and`, `AND`, `or`, `OR` +

Logical Operator Between Filters. Filter by conditions set on the junction parameter indicating how the conditions should be accounted for in the query. An AND is an all-inclusive logical operator, meaning the AND operator displays a record if ALL the conditions separated by AND are TRUE, while an OR operator displays a record if ANY of the conditions separated by OR is TRUE.

+ +Available values: `and`, `or` ## Field Conditions | 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 3fd64f58e..8e39fe542 100644 --- a/docs/reference-docs/PROMOTIONS-API-Promotion-Tier-Object.md +++ b/docs/reference-docs/PROMOTIONS-API-Promotion-Tier-Object.md @@ -29,7 +29,7 @@ order: 1 | validity_day_of_week
`array` |

Integer array corresponding to the particular days of the week in which the promotion tier is valid.

| | summary
`object` |

Contains statistics about promotion tier redemptions and orders.

AttributesDescription
redemptions
object

Contains statistics about promotion tier redemptions.

AttributesDescription
total_redeemed
integer

Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

AttributesDescription
total_amount
integer

Sum of order totals.

total_discount_amount
integer

Sum of total discount applied using the promotion tier.

| | object
`string` |

The type of object represented by JSON. This object stores information about the promotion tier.

| -| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| validation_rule_assignments | See: [Validation Rule Assignments List](#validation-rule-assignments-list) | | category_id
`string` |

Promotion tier category ID.

**Example:**

cat_0c9da30e7116ba6bba

| | categories
`array` | Array of [Category](#category) | @@ -40,7 +40,7 @@ One of: [Amount](#amount), [Unit](#unit), [Unit Multiple](#unit-multiple), [Percent](#percent), [Fixed](#fixed) -## Validation Rule Assignments +## Validation Rule Assignments List | Attributes | Description | |:-----|:--------| | object
`string` |

The type of object represented by JSON. This object stores information about validation rule assignments.

| diff --git a/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md b/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md index 93e6f3a28..ca8b2b4a3 100644 --- a/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md +++ b/docs/reference-docs/REDEMPTIONS-API-Redemption-Object.md @@ -105,7 +105,7 @@ All of: | validity_day_of_week
`array` |

Integer array corresponding to the particular days of the week in which the promotion tier is valid.

| | summary
`object` |

Contains statistics about promotion tier redemptions and orders.

AttributesDescription
redemptions
object

Contains statistics about promotion tier redemptions.

AttributesDescription
total_redeemed
integer

Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

AttributesDescription
total_amount
integer

Sum of order totals.

total_discount_amount
integer

Sum of total discount applied using the promotion tier.

| | object
`string` |

The type of object represented by JSON. This object stores information about the promotion tier.

| -| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| validation_rule_assignments | See: [Validation Rule Assignments List](#validation-rule-assignments-list) | | category_id
`string` |

Promotion tier category ID.

**Example:**

cat_0c9da30e7116ba6bba

| | categories
`array` | Array of [Category](#category) | @@ -179,7 +179,7 @@ One of: | qr
`object` |

Stores Quick Response (QR) representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==

url
string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D

| | barcode
`object` |

Stores barcode representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==

url
string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D

| -## Validation Rule Assignments +## Validation Rule Assignments List | Attributes | Description | |:-----|:--------| | object
`string` |

The type of object represented by JSON. This object stores information about validation rule assignments.

| diff --git a/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md b/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md index 42b5020a5..e140cceb9 100644 --- a/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md +++ b/docs/reference-docs/REDEMPTIONS-API-Rollback-Redemption-Object.md @@ -106,7 +106,7 @@ All of: | validity_day_of_week
`array` |

Integer array corresponding to the particular days of the week in which the promotion tier is valid.

| | summary
`object` |

Contains statistics about promotion tier redemptions and orders.

AttributesDescription
redemptions
object

Contains statistics about promotion tier redemptions.

AttributesDescription
total_redeemed
integer

Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

AttributesDescription
total_amount
integer

Sum of order totals.

total_discount_amount
integer

Sum of total discount applied using the promotion tier.

| | object
`string` |

The type of object represented by JSON. This object stores information about the promotion tier.

| -| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| validation_rule_assignments | See: [Validation Rule Assignments List](#validation-rule-assignments-list) | | category_id
`string` |

Promotion tier category ID.

**Example:**

cat_0c9da30e7116ba6bba

| | categories
`array` | Array of [Category](#category) | @@ -180,7 +180,7 @@ One of: | qr
`object` |

Stores Quick Response (QR) representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==

url
string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D

| | barcode
`object` |

Stores barcode representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==

url
string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D

| -## Validation Rule Assignments +## Validation Rule Assignments List | Attributes | Description | |:-----|:--------| | object
`string` |

The type of object represented by JSON. This object stores information about validation rule assignments.

| 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 7d445fd91..700501343 100644 --- a/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md +++ b/docs/reference-docs/STACKABLE-DISCOUNTS-API-Stackable-Redemptions-Object.md @@ -136,7 +136,7 @@ All of: | validity_day_of_week
`array` |

Integer array corresponding to the particular days of the week in which the promotion tier is valid.

| | summary
`object` |

Contains statistics about promotion tier redemptions and orders.

AttributesDescription
redemptions
object

Contains statistics about promotion tier redemptions.

AttributesDescription
total_redeemed
integer

Number of times the promotion tier was redeemed.

orders
object

Contains statistics about orders related to the promotion tier.

AttributesDescription
total_amount
integer

Sum of order totals.

total_discount_amount
integer

Sum of total discount applied using the promotion tier.

| | object
`string` |

The type of object represented by JSON. This object stores information about the promotion tier.

| -| validation_rule_assignments | See: [Validation Rule Assignments](#validation-rule-assignments) | +| validation_rule_assignments | See: [Validation Rule Assignments List](#validation-rule-assignments-list) | | category_id
`string` |

Promotion tier category ID.

**Example:**

cat_0c9da30e7116ba6bba

| | categories
`array` | Array of [Category](#category) | @@ -232,7 +232,7 @@ One of: | qr
`object` |

Stores Quick Response (QR) representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q==

url
string

URL to QR code

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/qr/U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK%2Bt4pp7U7oFzjGJzj9q%2FbmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg%2BBaZk5QwXMf8k%2FOzSlOEVybpwSq%2BAiqPoNtjeuqtIgkDyvT6Q%3D%3D

| | barcode
`object` |

Stores barcode representation of encrypted code.

AttributesDescription
id
string

Encrypted voucher code ID.

Example:

U2FsdGVkX19eJhGfWwUrH9+tulBkON+AnMktic+N6CVWzZ9+fHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ+kJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6/pFs61apEn9SJx32ttCF6d3oxKISQQ==

url
string

URL to barcode

Optional: Attach query parameters to base URL to customize the image of the encrypted voucher code.

  • size: integer value from 1 to 100
  • format: string, either png (default) or svg
Example:

https://dev.dl.voucherify.io/api/v1/assets/barcode/U2FsdGVkX19eJhGfWwUrH9%2BtulBkON%2BAnMktic%2BN6CVWzZ9%2BfHVxuVx22WakrzxiWXy0skuvvEHSeZIw9HlgyIJ%2BkJ1iPdUKpyENuNYJKzoZlO0mmTf6WQM6%2FpFs61apEn9SJx32ttCF6d3oxKISQQ%3D%3D

| -## Validation Rule Assignments +## Validation Rule Assignments List | Attributes | Description | |:-----|:--------| | object
`string` |

The type of object represented by JSON. This object stores information about validation rule assignments.

|