Coupon Object

A loyalty coupon is created when a customer redeems their loyalty points for a reward. Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API.

Properties
idstringRead-onlyformat GUID

Loyalty coupon ID.

accountIdstringRead-onlyformat GUID

Loyalty account ID of the customer that redeemed points for a coupon.

memberIdDeprecatedストリングRead-onlydeprecated - use memberId insteadformat GUID

Member ID of the customer that redeemed points for a coupon.

memberIdstringRead-onlyformat GUID

Member ID of the customer that redeemed points for a coupon.

transactionIdstringRead-onlyformat GUID

Transaction ID for the transaction that created a coupon.

couponReferenceobjectRead-only

Reference coupon information for the corresponding coupon that is created along with the loyalty coupon.

statusstringRead-only
6 enum supported values:
UNKNOWNPENDINGACTIVEAPPLIEDFAILEDARCHIVED

Loyalty coupon status.

This status relates to the corresponding coupon that is created at the same time as the loyalty coupon and is included in couponReference.

  • ACTIVE: The reference coupon is active and available to the customer.
  • APPLIED: The reference coupon was applied and is no longer available for use.
  • ARCHIVED: The reference coupon was deleted.
  • FAILED: The reference coupon was created but something went wrong when redeeming points from the loyalty account.
  • PENDING: The refence coupon was created but the loyalty points have not been redeemed yet.
rewardNamestringRead-onlyminLength 1maxLength 50

Name of reward that was redeemed to create this coupon.

revisionintegerformat uint64

Revision number, which increments by 1 each time the loyalty coupon is updated.

To prevent conflicting changes, the current revision must be passed when updating the loyalty coupon.

createdDatestringRead-onlyformat date-time

Date and time the loyalty coupon was created.

updatedDatestringRead-onlyformat date-time

Date and time the loyalty coupon was last updated.

役に立ちましたか？
はい
いいえ