Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleDiscount codes

Returns list of discounts in the shop.

Field

Description

Applies on subscription

Whether the discount applies on subscription shipping lines.

Applies once per customer

Whether the discount can be applied only once per customer.

Applies once per time purchase

Whether the discount applies on regular one-time-purchase shipping lines.

Async usage count

The number of times that the discount has been used.

Code count

The number of redeem codes for the discount.

Created at

The date and time when the discount was created.

Discount Id

The ID for the discount.

Discount class

The class of the discount for combining purposes.

Codes count

The number of redeem codes for the discount.

Codes count precision

Precision of codes count, how exact is the value.

Ends at

The date and time when the discount ends. For open-ended discounts, use `null`.

Has timeline comment

Indicates whether there are any timeline comments on the discount.

Recurring cycle limit

The number of times a discount applies on recurring purchases (subscriptions)

ShortSummary

A short summary of the discount.

Starts At

The date and time when the discount starts.

Status

The status of the discount.

Summary

A detailed summary of the discount.

Title

The title of the discount.

Updated at

The date and time when the discount was updated.

Usage limit

The maximum number of times that the discount can be used.

...

Expand
titleDiscount codes / Total sales

The total amount spent by this company, across all its locations.

Field

Description

Amount

Decimal money amount.

Currency code

Currency of the money.