Cancelar um pedido da área restrita de integração usando APIs do Partner Center

Artigo
03/15/2024

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

Este artigo descreve como usar APIs do Partner Center para cancelar diferentes tipos de pedidos de assinatura de contas de área restrita de integração. Esses pedidos podem incluir instâncias reservadas, software e pedidos de assinatura de Software como Serviço (SaaS) do mercado comercial.

A tabela a seguir mostra a ordem de cancelamento na área restrita e na produção.

Tipo de produto	Ordem de atualização da Sandbox	Subscrição de atualização da Sandbox	Ordem de atualização de produção	Subscrição da atualização de produção
Instâncias Reservadas do Azure	Y	N	N	N
Software perpétuo	Y	N	Y	N
Subscrições de software	Y	Y	Y	Y
Novo comércio	N	Y	N	Y
Marketplace comercial	N	Y	N	Y
plano do Azure	N	Y	N	Y

Nota

Cancelamentos de uma instância reservada ou pedidos de assinatura SaaS do mercado comercial só são possíveis a partir de contas sandbox de integração. Quaisquer pedidos de área restrita com mais de 60 dias não podem ser cancelados no Partner Center.

Para cancelar ordens de produção de software através de API, use cancelar-software-compras. Você também pode cancelar ordens de produção de software através do painel usando cancelar uma compra.

Pré-requisitos

Credenciais conforme descrito na autenticação do Partner Center. Este cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Uma conta de parceiro sandbox de integração com um cliente com pedidos de assinatura SaaS de instâncias reservadas ativas / software / terceiros.

C#

Para cancelar um pedido da área restrita de integração, passe as credenciais da sua conta para o CreatePartnerOperations método para obter uma IPartner interface para obter operações de parceiros.

Para selecionar um pedido específico, use as operações do parceiro e o método de chamada Customers.ById() com o identificador do cliente para especificar o cliente, seguido pelo Orders.ById() identificador do pedido para especificar o pedido e, finalmenteGet, o método ou GetAsync método para recuperá-lo.

Defina a Order.Status propriedade como cancelled e use o Patch() método para atualizar a ordem.

// IPartnerCredentials tipAccountCredentials;
// Customer tenant Id to be deleted.
// string customerTenantId;

IPartner tipAccountPartnerOperations = PartnerService.Instance.CreatePartnerOperations(tipAccountCredentials);

// Cancel order
var order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Get();
order.Status = "cancelled";
order = tipAccountPartnerOperations.Customers.ById(customerTenantId).Orders.ById(orderId).Patch(order);

Pedido REST

Sintaxe da solicitação

Método	URI do pedido
REMENDO	{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

Parâmetro URI

Use o seguinte parâmetro de consulta para excluir um cliente.

Nome	Type	Obrigatório	Description
ID do cliente-locatário	GUID	Y	O valor é um ID de cliente-locatário formatado em GUID que permite ao revendedor filtrar os resultados de um determinado cliente que pertence ao revendedor.
ID da encomenda	string	Y	O valor é uma cadeia de caracteres que indica os IDs de ordem que precisam ser cancelados.

Cabeçalhos do pedido

Para obter mais informações, consulte Cabeçalhos REST do Partner Center.

Corpo do pedido

{
    "id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
    "status": "cancelled",
}

Exemplo de solicitação

PATCH https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/orders/<order-id> HTTP/1.1
Accept: application/json
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

{
    "id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
    "status": "cancelled",
}

Resposta do REST

Se for bem-sucedido, esse método retornará o pedido cancelado.

Códigos de sucesso e erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e mais 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, consulte Códigos de erro REST do Partner Center.

Exemplo de resposta

HTTP/1.1 200 OK
Content-Length: 866
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
MS-RequestId: 655890ba-4d2b-4d09-a95f-4ea1348686a5

{
    "id": "UKXASSO1dezh3HdxClHxSp5UEFXGbAnt1",
    "alternateId": "11fc4bdfd47a",
    "referenceCustomerId": "bd59b416-37f9-4d8f-8df3-5750111fc615",
    "billingCycle": "one_time",
    "currencyCode": "USD",
    "currencySymbol": "$",
    "lineItems": [
        {
            "lineItemNumber": 0,
            "offerId": "DG7GMGF0DWT0:0001:DG7GMGF0DSQR",
            "termDuration": "",
            "transactionType": "New",
            "friendlyName": "Microsoft Identity Manager 2016 - 1 User CAL",
            "quantity": 1,
            "links": {
                "product": {
                    "uri": "/products/DG7GMGF0DWT0?country=US",
                    "method": "GET",
                    "headers": []
                },
                "sku": {
                    "uri": "/products/DG7GMGF0DWT0/skus/0001?country=US",
                    "method": "GET",
                    "headers": []
                },
                "availability": {
                    "uri": "/products/DG7GMGF0DWT0/skus/0001/availabilities/DG7GMGF0DSQR?country=US",
                    "method": "GET",
                    "headers": []
                }
            }
        }
    ],
    "creationDate": "2019-02-21T17:56:21.1335741Z",
    "status": "cancelled",
    "transactionType": "UserPurchase",
    "attributes": {
        "objectType": "Order"
    }
}

Partilhar via