Edit

Get an add-on

  • Article

Use this method in the Microsoft Store submission API to retrieve information about an add-on (also known as in-app product or IAP) for an app that is registered to your Partner Center account.

Prerequisites

To use this method, you need to first do the following:

  • If you have not done so already, complete all the prerequisites for the Microsoft Store submission API.
  • Obtain an Azure AD access token to use in the request header for this method. After you obtain an access token, you have 60 minutes to use it before it expires. After the token expires, you can obtain a new one.

Request

This method has the following syntax. See the following sections for usage examples and descriptions of the header and request body.

Method Request URI
GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}

Request header

Header Type Description
Authorization string Required. The Azure AD access token in the form Bearer <token>.

Request parameters

Name Type Description
id string Required. The Store ID of the add-on to retrieve. The Store ID is available in Partner Center.

Request body

Do not provide a request body for this method.

Request example

The following example demonstrates how to retrieve information about an add-on.

GET https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP HTTP/1.1
Authorization: Bearer <your access token>

Response

The following example demonstrates the JSON response body for a successful call to this method. For more details about the values in the response body, see add-on resource.

{
  "applications": {
    "value": [
      {
        "id": "9NBLGGH4R315",
        "resourceLocation": "applications/9NBLGGH4R315"
      }
    ],
    "totalCount": 1
  },
  "id": "9NBLGGH4TNMP",
  "productId": "Test-add-on",
  "productType": "Durable",
  "pendingInAppProductSubmission": {
    "id": "1152921504621243619",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243619"
  },
  "lastPublishedInAppProductSubmission": {
    "id": "1152921504621243705",
    "resourceLocation": "inappproducts/9NBLGGH4TNMP/submissions/1152921504621243705"
  }
}

Error codes

If the request cannot be successfully completed, the response will contain one of the following HTTP error codes.

Error code Description
404 The specified add-on could not be found.
409 The add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.