Cancelar um pedido da área restrita de integraçãoCancel an order from the integration sandbox

Aplica-se a:Applies to:

  • Partner CenterPartner Center
  • Partner Center operado pela 21VianetPartner Center operated by 21Vianet
  • Partner Center do Microsoft Cloud GermanyPartner Center for Microsoft Cloud Germany
  • Partner Center do Microsoft Cloud for US GovernmentPartner Center for Microsoft Cloud for US Government

Como cancelar ordens reservadas de assinatura, software e software comercial como um serviço (SaaS) das contas da área restrita da integração.How to cancel reserved instance, software, and commercial marketplace Software as a Service (SaaS) subscription orders from integration sandbox accounts.

Observação

Lembre-se de que os cancelamentos da instância reservada ou das ordens de assinatura SaaS do Marketplace comercial só são possíveis de contas da área restrita da integração.Please be aware that the cancellations of reserved instance, or commercial marketplace SaaS subscription orders are only possible from integration sandbox accounts.

Para cancelar as ordens de produção de software por meio da API, use Cancelar-software-compras.To cancel production orders of software through API, use cancel-software-purchases. Você também pode cancelar ordens de produção de software por meio do painel usando cancelar uma compra.You can also cancel production orders of software through dashboard using cancel a purchase.

Pré-requisitosPrerequisites

  • Credenciais, conforme descrito em Autenticação do Partner Center.Credentials as described in Partner Center authentication. Esse cenário dá suporte à autenticação com aplicativos autônomos e aplicativos + credenciais de usuário.This scenario supports authentication with both standalone App and App+User credentials.

  • Uma conta de parceiro de área restrita de integração com um cliente que tenha uma instância reservada ativa/software/pedidos de assinatura de SaaS de terceiros.An integration sandbox partner account with a customer having active reserved instance / software / third-party SaaS subscription orders.

C#C#

Para cancelar um pedido da área restrita da integração, passe as credenciais da sua conta para o CreatePartnerOperations método para obter uma IPartner interface para obter operações de parceiro.To cancel an order from the integration sandbox, pass your account credentials to the CreatePartnerOperations method to get an IPartner interface to get partner operations.

Para selecionar um pedidoespecífico, use o método de operações e chamadas de parceiro Customers.ById() com o identificador de cliente para especificar o cliente, seguido pelo Orders.ById() identificador de ordem para especificar a ordem e, por fim, o Get GetAsync método para recuperá-lo.To select a particular Order, use the partner operations and call Customers.ById() method with the customer identifier to specify the customer, followed by Orders.ById() with order identifier to specify the order and finally Get or GetAsync method to retrieve it.

Defina a Order.Status propriedade como cancelled e use o Patch() método para atualizar a ordem.Set the Order.Status property to cancelled and use the Patch() method to update the order.

// 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);

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
DISTRIBUÍDOPATCH {baseURL}/v1/Customers/{Customer-Tenant-ID}/Orders/{Order-ID} http/1.1{baseURL}/v1/customers/{customer-tenant-id}/orders/{order-id} HTTP/1.1

Parâmetro do URIURI parameter

Use o parâmetro de consulta a seguir para excluir um cliente.Use the following query parameter to delete a customer.

NomeName TipoType ObrigatórioRequired DescriçãoDescription
customer-tenant-idcustomer-tenant-id guidguid YY O valor é um GUID formatado Customer-Tenant-ID que permite ao revendedor filtrar os resultados de um determinado cliente que pertence ao revendedor.The value is a GUID formatted customer-tenant-id that allows the reseller to filter the results for a given customer that belongs to the reseller.
ID do pedidoorder-id cadeia de caracteresstring YY O valor é uma cadeia de caracteres que denota as IDs de pedidos que precisam ser canceladas.The value is a string denoting the order IDs that need to be canceled.

Cabeçalhos de solicitaçãoRequest headers

Para obter mais informações, confira Cabeçalhos REST do Partner Center.For more information, see Partner Center REST headers.

Corpo da solicitaçãoRequest body

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

Exemplo de solicitaçãoRequest example

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: 1438ea3d-b515-45c7-9ec1-27ee0cc8e6bd

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

Resposta RESTREST response

Se for bem-sucedido, esse método retornará a ordem cancelada.If successful, this method returns the canceled order.

Códigos de êxito e de erro de respostaResponse success and error codes

Cada resposta vem com um código de status HTTP que indica êxito ou falha e informações de depuração adicionais.Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais.Use a network trace tool to read this code, error type, and additional parameters. Para obter a lista completa, confira Códigos de erro REST do Partner Center.For the full list, see Partner Center REST error codes.

Exemplo de respostaResponse example

HTTP/1.1 200 OK
Content-Length: 866
MS-CorrelationId: 1438ea3d-b515-45c7-9ec1-27ee0cc8e6bd
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"
    }
}