Skip to content

Latest commit

 

History

History
35 lines (32 loc) · 1.03 KB

GiftCatalogEntry.md

File metadata and controls

35 lines (32 loc) · 1.03 KB

GiftCatalogEntry

Gifts an item from the item shop.

Attributes

Compatible Profiles: common_core
Supported MCPs: fortnite, wex

Payload

{
    "offerId": "",
    "purchaseQuantity": 0,
    "currency": "MtxCurrency",
    "expectedTotalPrice": 0,
    "gameContext": "",
    "receiverAccountIds": [""],
    "giftWrapTemplateId": "",
    "personalMessage": ""
}

Parameters

  • offerId: offer ID of the item that is being purchased
  • purchaseQuantity: amount of item(s) being purchased
  • currency: type of currency the transaction is being paid in
  • expectedTotalPrice: price of the item
  • gameContext: only used for analytics and can be ignored
  • receiverAccountIds: array with the ids of the accounts that are being gifted
  • giftWrapTemplateId: the wrap of the gift; can be:
    • GiftBox:gb_default
    • GiftBox:gb_giftwrap1
    • GiftBox:gb_giftwrap2
    • GiftBox:gb_giftwrap3
    • GiftBox:gb_giftwrap4
  • personalMessage: the gift's message; not currently supported in-game so use at your own risk