Versions Compared

Old Version 17

changes.mady.by.user Lopes da Costa, Valentina

Saved on

compared with

New Version 18

changes.mady.by.user Lopes da Costa, Valentina

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • points <number>: this represents the number of loyalty points the user has. If the order has a status of “PENDING” and includes rewards, then this number already has those loyalty points temporarily deducted from total user’s loyalty points balance. If the order has a status of “CLAIMED” this is the final point balance of the guest after the order is completed.

  • pointsEarned <number>: this represents the number of loyalty points the user has earned. If the order has a status of “PENDING”, then this number will always be 0 since we don’t update the guests earned loyalty points until the order is completed. If the order has a status of “CLAIMED” this is the total number of points that were earned in this order.

  • pointsRedeemed <number>: this represents the number of loyalty points the user has redeemed. If the order has a status of “PENDING” and includes rewards, then this number is the total loyalty points temporarily deducted from total user’s loyalty points balance. If the order has a status of “CLAIMED” this is the final number of points that were deducted / burned in this order.

  • loyaltyId <string>: unique identifier of the loyalty user in UUID format.

  • transactionId <string>: unique identifier of the loyalty transaction created in UUID format.

  • receiptCode <string>: autogenerated code for easy lookup of the order via support tool

  • presentation (optional): object that returns Receipt content information set in Sanity here.

    • footer <string> (optional): this represents the content that will show in the footer of the receipt: Loyalty API - Receipts

    • header <string>(optional): this represents the content that will show in the header of the receipt: Loyalty API - Receipts

    • identifier <string>(optional): this represents the content that will show in the receipt to identify the order: Loyalty API - Receipts

    • pointsEarned <string>(optional): this represents the points earned that will show in the receipt of the loyalty order: Loyalty API - Receipts

    • totalPoints <string>(optional): this represents the total points balance that will show in the receipt of the loyalty order: Loyalty API - Receipts

...