• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
LoyaltyProgramAccrualRuleSpendData

Represents additional data for rules with the SPEND accrual type.

Properties

Name Description
amount_money
Money

Required

Read only The amount that buyers must spend to earn points. For example, given an "Earn 1 point for every $10 spent" accrual rule, a buyer who spends $105 earns 10 points.

excluded_category_ids
string [ ]

Read only The IDs of any CATEGORY catalog objects that are excluded from points accrual.

You can use the BatchRetrieveCatalogObjects endpoint to retrieve information about the excluded categories.

excluded_item_variation_ids
string [ ]

Read only The IDs of any ITEM_VARIATION catalog objects that are excluded from points accrual.

You can use the BatchRetrieveCatalogObjects endpoint to retrieve information about the excluded item variations.

tax_mode
string

Required

Read only Indicates how taxes should be treated when calculating the purchase amount used for points accrual.