Loyalty API

Type

OrderAssetDetails1

Describes an asset (achievement or way-to-earn) unlocked by an order and the points earned from it.

Kind Type
Used in EstimateAccrual1, QueryOrderDetails1

When an order triggers the completion of an achievement or way-to-earn, this type provides information about the asset and the points the customer earned. This is returned in the assets field of order estimation and query responses.

Properties

  • asset Asset2 required

    The asset that was unlocked.

    Contains the asset's identifying information, title, description, and state flags. For order assets, the state flags (is_completed, is_rewarded) reflect that the asset was completed by this order.

  • ownership Ownership2 optional

    The ownership created when this asset was unlocked.

    For estimation responses, this field is not populated since no ownership has been created yet. For query responses on processed orders, this may contain the created ownership details.

  • pts_earned integer required

    Points earned from unlocking this asset.

    The number of bonus points the customer received (or would receive) from unlocking this asset. This is in addition to the base points earned from the order itself.

Previous
Offer1