List

Lists all offer profiles for an individual User.

🔐

Authentication

✔️ Application API Scope

✖️ Storefront API Scope

Response Body Definitions

NameTypeDescriptionExample
public_idstringUnique Offer Profile ID"e3e9ac44a24f15e485b0bc764e107cf3"
namestringName of Offer ProfileDefault Offer Profile
merchantstringMerchant ID"ac4f7938383a11e89ecbbc764e1107f2"
livebooleanTrue=active profile;
False=inactive profile
true
weightintegerProfile weight100 or 0
offersarrayList of Offer IDs associated with the profile["a748aa648ac811e8af3bbc764e106cf4"]
recurring_couponobjectRecurring Coupon object{} or null
initial_couponobjectInitial Coupon object{} or null

Response Body Definitions (Recurring Coupon Object)

NameTypeDescriptionExample
public_idstringUnique Recurring Coupon ID"ff48e9fdc8eb4d79abd7c8c573523d25"
namestringRecurring Coupon name"Demo Store Incentives"
codestringRecurring Coupon code"demo_store"
discountsobjectDiscounts object{} or null

Response Body Definitions (Initial Coupon Object)

NameTypeDescriptionExample
public_idstringUnique Recurring Coupon ID"ff48e9fdc8eb4d79abd7c8c573523d25"
namestringRecurring Coupon name"Demo Store Incentives"
codestringRecurring Coupon code"demo_store"
discountsobjectDiscounts object{} or null

Response Body Definitions (Discounts Object)

NameTypeDescriptionExample
public_idstringUnique Discount ID"c67dec11aedb4885aa9a58c3f89de746"
namestringDiscount name"Free shipping on orders over $50"
objectinteger1
typestring2
valuestringDiscount value"100"
threshold_fieldinteger3
threshold_valuestring"50"
Language