Skip to main content
POST
Redeem Apple App Store Inventory Items

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Redeem items from the Apple App Store.

Redeem items from the Apple App Store.

CollectionId
string

The id of the entity's collection to perform this action on. (Default="default")

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Entity
object

The entity to perform this action on.

Receipt
string

The receipt provided by the Apple marketplace upon successful purchase.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026