Get a snapshot of the current offer profile's configuration including all of its incentives and the criteria for them to get applied in the form of conditions
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Response Body Definitions
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | Offer Profile's unique ID | 83dc2b6a519111ef869ed637592b5542 |
| name | string | Offer Profile's name | Live Offer Profile |
| weight | integer | Offer Profile's weight | 100 |
| live | boolean | Flag that indicates whether the Offer Profile is live/active or not/inactive | true |
| initial_coupon | object | Initial Coupon object | Coupon object |
| recurring_coupon | object | Recurring Coupon object | Coupon object |
| offers | array | List of Offer objects associated with the Offer Profile | List of Offer objects |
| premises | array | List of Premise objects associated to at least one Offer Profile's coupon's (initial or recurring) condition | List of Premise objects |
Response Body Definitions (Coupon)
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | Coupon's unique ID | 14e4a6f57a95481fa78e6a05cae53ea3 |
| name | string | Coupon's name | Initial Coupon |
| code | string | Coupon's code | rc3_ioi_coupon |
| conditions | array | List of Condition objects associated with the Coupon | List of Condition objects |
| incentives | array | List of Incentive objects directly associated with the Coupon | List of Incentive objects |
| standard_flex_incentives | array | List of Standard Flex Incentives associated with the Coupon | List of Standard Flex Incentive objects |
Response Body Definitions (Offer)
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | Offer's unique ID | 83f5a824559111ef861f1a1bb24efa7a |
| name | string | Offer's name | Default Offer |
| offer_type | integer | Offer's type | 1 |
| weight | integer | Offer's weight | 100 |
| live | boolean | Flag that indicates whether the Offer is live/active or not/inactive | true |
Response Body Definitions (Premise)
Name | Type | Description | Example |
|---|---|---|---|
id | integer | Premise's numeric and unique ID (this ID is used in the | 1 |
public_id | string | Premise's unique ID | 81ce2c4b813642c3b7a85de39e51cd84 |
slug | string | Premise's slug | 34deca71bfba4ae0aa34dc2d2c5b4b76 |
premise_type | string | Premise's type to define which premise instance will be used to determine its eligibility based on its operand and value | Number of orders per billing for a prepaid subscription cycle |
operand | string | Premise's operand:
| eq |
value | string | Premise's value | 2 |
Response Body Definitions (Condition)
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | Condition's unique ID | 134cd0c6111143f8b4e74cd48ddd2756 |
| premises | string | An expression used to determine the criteria a condition needs to fulfill given a certain context (item or order, for example) for it to be considered valid and its incentives get applied; Notice that this field will be a mix of operands, premise's ids and parenthesis to specify precedence; | OR(AND(9228, 9229), 9230) |
| description | string | Condition's description | 2 shipments prepaid condition |
| incentives | array | List of Incentive objects directly associated with the Condition | List of Incentive objects |
Response Body Definitions (Incentive)
Incentive objects may assume different formats depending on its purpose, this can be easily identified by the polymorphic_type field present on every type of incentive.
Response Body Definitions (Discount)
Name | Type | Description | Example |
|---|---|---|---|
public_id | string | Discount's unique ID | bd3e24e351c147d88ac71136b7e67638 |
name | string | Discount's name | Default Recurring Discount |
polymorphic_type | string | For Discounts this field will always be "Discount" | Discount |
object | integer | Discount's object:
| 1 |
field | integer | Discount's field to be discounted:
| 2 |
type | string | Discount's type:
| discount_percent |
value | string | Discount's value represented as a numeric string; | 10.99 |
threshold_field | integer | Discount's threshold field to be considered:
| 1 |
threshold_value | integer | Discount's threshold value represented as a numeric string to be considered (the Discount will be considered threshold valid when the | 100.00 |
Response Body Definitions (Gift)
Name | Type | Description | Example |
|---|---|---|---|
public_id | string | Gift's unique ID | bd3e24e35ec447d88ac71136b7e67638 |
name | string | Gift's name | Toy |
polymorphic_type | string | For Discounts this field will always be "Gift" | Gift |
external_product_id | string | The external product identifier of the product that will be added as a Gift; | 401099289 |
target_level | integer | Gift's target level:
| 1 |
Response Body Definitions (SampleSKU)
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | SampleSKU's unique ID | bd3e24e35ec447d88ac71136b7e67ab1 |
| name | string | SampleSKU's name | Sample Toy |
| polymorphic_type | string | For SampleSKU this field will always be "SampleSku" | SampleSku |
| external_product_id | string | The external product identifier of the product that will be added as a Sample SKU; | 401099289 |
| ordinal | integer | SampleSKU's ordinal | 4 |
Standard Flex Incentives
| Name | Type | Description | Example |
|---|---|---|---|
| public_id | string | A standardized unique identifier for a Flex Incentive record, used for public reference and integration. | "ac4f7938383a11e89ecbbc764e1107f2" |
| description | string | "adds a 10 USD in discount" | |
| criteria | object | A recursive criteria tree that defines the conditions under which the Standardized Flex Incentive is applicable or not. | { "node_type": "PREMISE", "standard": "ITEM_HAS_SUBSCRIPTION", "premise_value": True } |
| incentives | array | An array of incentive objects that should be applied when the criteria are met. | [ { "incentive_type": "discount_percent", "incentive_value": 10, "incentive_target": "order" } ] |