discounts

This topic applies to

Applies to

Commerce Web Stores

 

This object contains information about the per line discount impact for a given item.

Field Name

Field Type

Description

In Get Functions?

In Set Functions?

promotion_couponcode

string

The name of the coupon code. This corresponds to what the user applies during the checkout process.

For example, user might apply SUMMER or FREESHIP.

Note

If you manually add the discount without using a coupon code, the value of promotion_couponcode is Empty.


yes

no

promotion_name

string

Name of the associated promotion.

For example, name of the promotion can be 10% Summer Sale.

Note

If you manually add the discount without using a coupon code, the value of promotion_name is Empty.


yes

no

promotion_id

integer

ID of the associated promotion. 

Note

If you manually add the discount without using a coupon code, the value of promotion_id is Null.


yes

no

discount_item

string

Name of the associated discount item.

For example, name of the discount item can be Ten Percent.

yes

no

discount_item_id

integer

ID of the associated discount item.

yes

no

amount

number

Currency amount of the discount applied to the order as a result of applying this coupon code.

yes

no

amount_formatted

string

Discount amount formatted with currency symbol.

yes

no

is_auto_applied

boolean

Indicates whether the promocode was automatically or manually applied for the current order.

Value should be true or false.

yes

no