Consultar novas migrações de comércio

Artigo
10/15/2024

Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

Como consultar assinaturas migradas com base na ID do cliente, na ID da assinatura atual ou na ID de referência externa

Funções apropriadas: Agente administrativo | Agente de vendas

Pré-requisitos

Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.

Essa API pode filtrar com base nas cadeias de caracteres de consulta selecionadas pelo parceiro. As cadeias de caracteres de consulta selecionadas podem ser qualquer uma das três opções a seguir:

Um CustomerTenantId. Se você não souber a ID do cliente, poderá procurá-la no Partner Center selecionando o workspace Clientes, o cliente da lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente.
Um CurrentSubscriptionId (a ID herdada de uma assinatura que foi migrada)
Um ExternalReferenceId (a ID do lote retornada pela Ferramenta de Migração em Lote que está disponível para download por meio do SDK do Partner Center)

Solicitação REST

Sintaxe da solicitação

Método	URI da solicitação
GET	{baseURL}/v1/migrations/newcommerce HTTP/1.1

Consultar cadeia de caracteres

Esta tabela lista as cadeias de caracteres de consulta necessárias para filtrar e recuperar novas migrações de comércio. Pelo menos uma das três IDs é necessária para consultar migrações com êxito. A entrada de várias IDs na consulta é aceita, mas não obrigatória.

Nome	Descrição
CustomerTenantId	Uma cadeia com formato de GUID que identifica o cliente.
CurrentSubscriptionId	Uma cadeia de caracteres formatada em GUID que identifica uma assinatura herdada migrada.
ExternalReferenceId	Uma cadeia de caracteres formatada em GUID que identifica o lote de migração.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center. A resposta da API retorna um máximo de 300 registros de página. Se mais de 300 registros forem retornados em uma consulta inserida, um token de continuação será fornecido no cabeçalho de resposta. O token de continuação pode ser inserido no cabeçalho de uma solicitação a seguir para retornar registros de página extras consultados.

Corpo da solicitação

Nenhum.

Resposta REST

Se for bem-sucedido, esse método retornará detalhes das assinaturas que foram migradas (objeto de migração) no corpo da resposta. Isso inclui a ID de migração.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica êxito ou falha e outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplos de URL de solicitação

baseurl/v1/migrations/newcommerce?CustomerTenantId=aaaabbbb-0000-cccc-1111-dddd2222eeee&CurrentSubscriptionId=6CCC6A93-93E4-4382-AF1F-E51237232833&ExternalReferenceId=9ab61899-0b2b-4320-bd6d-8196c53607d6

baseurl/v1/migrations/newcommerce?CurrentSubscriptionId=6CCC6A93-93E4-4382-AF1F-E51237232833

Exemplos de respostas

[
{
"addOnMigrations": [],
"id": "8ce7115e-0324-41b1-8ca3-7c7ae3b64f75",
"startedTime": "2022-02-24T23:50:30.4384819Z",
"completedTime": "2022-02-24T23:53:14.0813711Z",
"currentSubscriptionId": "9E289691-2FF3-419D-B39B-26B3E5A817FB",
"status": "Completed",
"customerTenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"catalogItemId": "CFQ7TTC0LF8Q:0001:CFQ7TTC0KQDF",
"newCommerceSubscriptionId": "f2d6534b-9e30-4cf5-c7b0-5d6393dbf12d",
"newCommerceOrderId": "09714c93092a",
"subscriptionEndDate": "2023-02-14T00:00:00Z",
"quantity": 2,
"termDuration": "P1Y",
"billingCycle": "Monthly",
"purchaseFullTerm": false,
"externalReferenceId": "771317a4-275d-47d9-9724-3eefa4a168ad"
}
]

Compartilhar via