List

get https://restapi.ordergroove.com/offer_profiles/

Lists all offer profiles for an individual User.

🔐
Authentication
✔️ Application API Scope
✖️ Storefront API Scope

Standard Flex Incentives support:

The control for inclusion/filtering of standard flex incentives is made through the parameter offer_profile_category which has three possible values:

all - Returns all offer profiles without SFI details.
all_with_standard_flex_incentives - Returns all offer profiles, and includes SFI details for those that support it.
only_with_standard_flex_incentives - Returns only offer profiles that contain SFI, and includes the SFI details.

Response Body Definitions

Name	Type	Description	Example
public_id	string	Unique Offer Profile ID	"e3e9ac44a24f15e485b0bc764e107cf3"
name	string	Name of Offer Profile	Default Offer Profile
merchant	string	Merchant ID	"ac4f7938383a11e89ecbbc764e1107f2"
live	boolean	True=active profile; False=inactive profile	true
weight	integer	Profile weight	100 or 0
offers	array	List of Offer IDs associated with the profile	["a748aa648ac811e8af3bbc764e106cf4"]
recurring_coupon	object	Recurring Coupon object	{} or null
initial_coupon	object	Initial Coupon object	{} or null

Response Body Definitions (Recurring Coupon Object)

Name	Type	Description	Example
public_id	string	Unique Recurring Coupon ID	"ff48e9fdc8eb4d79abd7c8c573523d25"
name	string	Recurring Coupon name	"Demo Store Incentives"
code	string	Recurring Coupon code	"demo_store"
discounts	object	Discounts object	{} or null
standard_flex_incentives	object	Standard Flex Incentives object	Returned only when offer_profile_category is all_with_standard_flex_incentives or only_with_standard_flex_incentives.

Response Body Definitions (Initial Coupon Object)

Name	Type	Description	Example
public_id	string	Unique Recurring Coupon ID	"ff48e9fdc8eb4d79abd7c8c573523d25"
name	string	Recurring Coupon name	"Demo Store Incentives"
code	string	Recurring Coupon code	"demo_store"
discounts	object	Discounts object	{} or null
standard_flex_incentives	object	Standard Flex Incentives object	Returned only when offer_profile_category is all_with_standard_flex_incentives or only_with_standard_flex_incentives.

Response Body Definitions (Discounts Object)

Name	Type	Description	Example
public_id	string	Unique Discount ID	"c67dec11aedb4885aa9a58c3f89de746"
name	string	Discount name	"Free shipping on orders over $50"
object	integer		1
type	string		2
value	string	Discount value	"100"
threshold_field	integer		3
threshold_value	string		"50"

Response Body Definitions (Standard Flex Incentives Object)

Name	Type	Description	Example
public_id	string	Unique Standard Flex Incentive ID	"c67dec11aedb4885aa9a58c3f89de746"
offer_profile	string	Parent Offer profile ID	"e3e9ac44a24f15e485b0bc764e107cf3"
criteria	object	Criteria tree that determines when incentives apply	{}
incentives	array	One or more incentive definitions	{}

Response Body Definitions (Criteria Node Object)

Name	Type	Description	Example
node_type	string	Specifies the type of node. (AND, OR, NOT, PREMISE)	“PREMISE”
children	array	AND, OR nodes have two children.	[] or null
standard	string	The SFI standard / type	“PSI”
premise_value	string	Type will depend on the standard. Can be an in, array, string or none.	“10”
premise_operand	string	The comparison operator that will be used to the premise	“LESS_THAN”

Response Body Definitions (Incentive Object)

Name	Type	Description	Example
incentive_type	string	discount_percent, discount_amount, gift	“discount_percent”
incentive_value	mixed	Must be 0-100 for discount_percent incentive types. Must be the "external_product_id" for gifts	20
incentive_target	string	order, item, shipping	“order”
threshold_field	string	Type will depend on the standard. Can be an in, array, string or none.	“”
threshold_value	string	The comparison operator that will be used to the premise	“”

Language