Edit

Commit an add-on submission

  • Article

Use this method in the Microsoft Store submission API to commit a new or updated add-on (also known as in-app product or IAP) submission to Partner Center. The commit action alerts Partner Center that the submission data has been uploaded (including any related icons). In response, Partner Center commits the changes to the submission data for ingestion and publishing. After the commit operation succeeds, the changes to the submission are shown in Partner Center.

For more information about how the commit operation fits into the process of submitting an add-on by using the Microsoft Store submission API, see Manage add-on submissions.

Prerequisites

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

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
POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/{inAppProductId}/submissions/{submissionId}/commit

Request header

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

Request parameters

Name Type Description
inAppProductId string Required. The Store ID of the add-on that contains the submission you want to commit. The Store ID is available in Partner Center, and it is included in the response data for requests to Get all add-ons and Create an add-on.
submissionId string Required. The ID of the submission you want to commit. This ID is available in the response data for requests to create an add-on submission. For a submission that was created in Partner Center, this ID is also available in the URL for the submission page in Partner Center.

Request body

Do not provide a request body for this method.

Request example

The following example demonstrates how to commit an add-on submission.

POST https://manage.devcenter.microsoft.com/v1.0/my/inappproducts/9NBLGGH4TNMP/submissions/1152921504621230023/commit 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 the following sections.

{
  "status": "CommitStarted"
}

Response body

Value Type Description
status string The status of the submission. This can be one of the following values:
  • None
  • Canceled
  • PendingCommit
  • CommitStarted
  • CommitFailed
  • PendingPublication
  • Publishing
  • Published
  • PublishFailed
  • PreProcessing
  • PreProcessingFailed
  • Certification
  • CertificationFailed
  • Release
  • ReleaseFailed

Error codes

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

Error code Description
400 The request parameters are invalid.
404 The specified submission could not be found.
409 The specified submission was found but it could not be committed in its current state, or the add-on uses a Partner Center feature that is currently not supported by the Microsoft Store submission API.