Usage
deventitlementtool <command> /e <testaccountemail> /s <sandboxid> [/p <productid>] [...]
All commands require the /e (email) and /s (sandbox) parameters.
Initial sign-in with an account invokes an interactive password entry dialog.
Once successfully signed in, subsequent operations with the same account/sandbox on the device no longer require password entry.
query
deventitlementtool query /e <testaccountemail> /s <sandboxid> [/d]
List all directly owned entitlements associated with this account in the sandbox.
query output
query example
add
deventitlementtool add /e <testaccountemail> /s <sandboxid> /p <productid1> [<productid2> <productid3> ...] [/q <quantity>] [/d]
Adds an entitlement for one or more specified products to the account.
This command is the equivalent of purchasing the product from Store or through purchase API.
The add operation with an already entitled Game, Durable, Bundle, or Developer-Managed consumable, doesn’t add another entitlement and the tool reports the existing entitlement.
For Store-managed consumable products, a default quantity of 1 is added to the consumable balance on each add command.
An optional quantity value can be specified to change this default value, but the quantity field can only be used if a single productID is passed with /p.
This option is useful for consumables that grant a quantity greater than 1 on purchase.
/d for more details is supported.
Quantity isn’t verifiable with this tool.
add operation with a bundle product grants all of its included products.
If a quantity is specified and the bundle includes Store-managed consumables, the same quantity is assigned to each consumable.
Subscription products aren’t supported.
add output
add examples
Single entitlement addeddelete
deventitlementtool delete /e <testaccountemail> /s <sandboxid> /p <productid1> [<productid2> <productid3> ...] [/all] [/d]
Deletes one or more specified entitlements from the account.
If /all is specified, it attempts to delete all entitlements associated with the account and sandbox.
A Revoked status shows for deleting entitlements granted by this tool.
A Refunded status shows for deleting entitlements that were purchased conventionally through Store client or in-game API.
/d for more details is supported.
delete output
delete examples
catalog
deventitlementtool catalog /e <testaccountemail> /s <sandboxid> /p <productid1> [/m]
Shows the set of products sellable by the provided product ID; that is, child add-on products and products with a can use and sell relationship to the productID in Partner Center.
This command is the equivalent returned by XStoreQueryAssociatedProductsAsync.
Products don’t return when configured in Partner Center as available but not discoverable in the Microsoft Store.
Optionally a market can be specified to retrieve the prices for that particular market.
The parameter needs to be an ISO two character region code, for example, GB, CA, JP, ES, etc.
catalog output
catalog example
Remarks
This tool is strictly for use with XBOX test accounts and for sandbox products. Use for retail accounts and scenarios is blocked. There’s a limit of add and delete operations per account per day. This limit is adjusted based on observed usage. To make requests for increased limits or other feedback, reach out through your Microsoft Account Representative.Reference API documentation
- XStore (API contents)
- Functions
- Structures