Manage orders - Get the list of New-Commerce migrations

Service:

Partner Center Rest

API Version:

v1

Gets the list of New Commerce migrations.

GET https://api.partnercenter.microsoft.com/v{version}/migrations/newcommerce

With optional parameters:

GET https://api.partnercenter.microsoft.com/v{version}/migrations/newcommerce?CustomerTenantId={CustomerTenantId}&CurrentSubscriptionId={CurrentSubscriptionId}&ExternalReferenceId={ExternalReferenceId}&IsMicrosoftLed={IsMicrosoftLed}&PageSize={PageSize}

URI Parameters

Name	In	Required	Type	Description
version	path	True	string
CurrentSubscriptionId	query		string
CustomerTenantId	query		string
ExternalReferenceId	query		string
IsMicrosoftLed	query		boolean
PageSize	query		integer int32

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer Token
MS-CorrelationId		string	Used for tracking requests internally. If a MS-CorrelationId is not provided, the server will generate a new one for each request
MS-CV		string	Used for tracking requests internally. If a MS-CV is not provided, the server will generate a new one for each request
MS-RequestId		string	Used for idempotency of requests. If a MS-RequestId is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Providers.Migration.V1.Models.NewCommerceMigration[]	The request was successful. The response body contains the New Commerce migrations. Media Types: "text/plain", "application/json", "text/json"
400 Bad Request		There was a missing or an invalid input. The response body will provide the error details. Media Types: "text/plain", "application/json", "text/json"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "text/plain", "application/json", "text/json"
403 Forbidden		The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "text/plain", "application/json", "text/json"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "text/plain", "application/json", "text/json"
500 Internal Server Error		The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "text/plain", "application/json", "text/json"

Definitions

Microsoft.Partner.Providers.Migration.V1.Models.NewCommerceMigration

Name	Type	Description
addOnMigrations	Microsoft.Partner.Providers.Migration.V1.Models.NewCommerceMigration[]
billingCycle	string
catalogItemId	string
completedTime	string
currentSubscriptionId	string
customTermEndDate	string
customerTenantId	string
externalReferenceId	string
id	string
microsoftLed	boolean
newCommerceOrderId	string
newCommerceSubscriptionId	string
purchaseFullTerm	boolean
quantity	integer
startedTime	string
status	string
subscriptionEndDate	string
termDuration	string