Criar uma transferênciaCreate a transfer

Aplica-se a:Applies to:

  • Partner CenterPartner Center

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 ID do cliente (customer-tenant-id).A customer ID (customer-tenant-id). Se você não souber a ID do cliente, poderá procurar no painel do Partner Center.If you don't know the customer's ID, you can look it up in the Partner Center dashboard. Selecione CSP no menu do Partner Center e, em seguida, Clientes.Select CSP from the Partner Center menu, followed by Customers. Selecione o cliente na lista de clientes e selecione Conta.Select the customer from the customer list, then select Account. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente.On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).The Microsoft ID is the same as the customer ID (customer-tenant-id).

Solicitação RESTREST request

Sintaxe da solicitaçãoRequest syntax

MétodoMethod URI da solicitaçãoRequest URI
POSTPOST {baseURL}/v1/Customers/{Customer-ID}/Transfers http/1.1{baseURL}/v1/customers/{customer-id}/transfers HTTP/1.1

Parâmetro do URIURI parameter

Use o seguinte parâmetro de caminho para identificar o cliente.Use the following path parameter to identify the customer.

NomeName TypeType ObrigatórioRequired DescriçãoDescription
ID do clientecustomer-id stringstring SimYes Uma ID de cliente formatada pelo GUID que identifica o cliente.A GUID formatted customer-id that identifies the customer.

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

Esta tabela descreve as propriedades TransferEntity no corpo da solicitação.This table describes the TransferEntity properties in the request body.

PropriedadeProperty TipoType ObrigatórioRequired DescriçãoDescription
idid Cadeia de caracteresstring NoNo Um identificador transferEntity que é fornecido após a criação bem-sucedida do transferEntity.A transferEntity identifier that is supplied upon successful creation of the transferEntity.
createdTimecreatedTime DatetimeDateTime NãoNo A data em que o transferEntity foi criado, em formato de data e hora.The date the transferEntity was created, in date-time format. Aplicado após a criação bem-sucedida do transferEntity.Applied upon successful creation of the transferEntity.
lastModifiedTimelastModifiedTime DatetimeDateTime NãoNo A data em que a transferEntity foi atualizada pela última vez, no formato de data e hora.The date the transferEntity was last updated, in date-time format. Aplicado após a criação bem-sucedida do transferEntity.Applied upon successful creation of the transferEntity.
lastModifiedUserlastModifiedUser Cadeia de caracteresstring NoNo O usuário que atualizou a transferEntity pela última vez.The user who last updated the transferEntity. Aplicado após a criação bem-sucedida de transferEntity.Applied upon successful creation of transferEntity.
customerNamecustomerName Cadeia de caracteresstring NoNo Opcional.Optional. O nome do cliente cujas assinaturas estão sendo transferidas.The name of the customer whose subscriptions are being transferred.
customerTenantIdcustomerTenantId Cadeia de caracteresstring NoNo Uma ID de cliente formatada pelo GUID que identifica o cliente.A GUID formatted customer-id that identifies the customer. Aplicado após a criação bem-sucedida do transferEntity.Applied upon successful creation of the transferEntity.
partnertenantidpartnertenantid Cadeia de caracteresstring NoNo Uma ID de parceiro formatada como GUID que identifica o parceiro.A GUID formatted partner-id that identifies the partner.
sourcePartnerNamesourcePartnerName Cadeia de caracteresstring NoNo Opcional.Optional. O nome da organização do parceiro que está iniciando a transferência.The name of the partner's organization who is initiating the transfer.
sourcePartnerTenantIdsourcePartnerTenantId stringstring SimYes Uma ID de parceiro formatada como GUID que identifica o parceiro que inicia a transferência.A GUID formatted partner-id that identifies the partner initiating the transfer.
targetPartnerNametargetPartnerName Cadeia de caracteresstring NoNo Opcional.Optional. O nome da organização do parceiro para a qual a transferência é direcionada.The name of the partner's organization to whom the transfer is targeted.
targetPartnerTenantIdtargetPartnerTenantId stringstring SimYes Uma ID de parceiro formatada como GUID que identifica o parceiro ao qual a transferência é direcionada.A GUID formatted partner-id that identifies the partner to whom the transfer is targeted.
itens de linhalineItems Matriz de objetosArray of objects SimYes Uma matriz de recursos de TransferLineItem .An Array of TransferLineItem resources.
statusstatus stringstring NoNo O status do transferEntity.The status of the transferEntity. Os valores possíveis são "ativo" (pode ser excluído/enviado) e "concluído" (já foi concluído).Possible values are "Active" (can be deleted/submitted) and "Completed" (has already been completed). Aplicado após a criação bem-sucedida do transferEntity.Applied upon successful creation of the transferEntity.

Esta tabela descreve as propriedades TransferLineItem no corpo da solicitação.This table describes the TransferLineItem properties in the request body.

PropriedadeProperty TipoType ObrigatórioRequired DescriçãoDescription
idid Cadeia de caracteresstring NoNo Um identificador exclusivo para um item de linha de transferência.A unique identifier for a transfer line item. Aplicado após a criação bem-sucedida do transferEntity.Applied upon successful creation of the transferEntity.
subscriptionIdsubscriptionId stringstring SimYes O identificador da assinatura.The subscription identifier.
quantidadequantity intint NãoNo O número de licenças ou instâncias.The number of licenses or instances.
billingCyclebillingCycle ObjetoObject NãoNo O tipo de ciclo de cobrança definido para o período atual.The type of billing cycle set for the current period.
friendlyNamefriendlyName Cadeia de caracteresstring NoNo Opcional.Optional. O nome amigável para o item definido pelo parceiro para ajudar a ambiguidade.The friendly name for the item defined by the partner to help disambiguate.
partnerIdOnRecordpartnerIdOnRecord Cadeia de caracteresstring NoNo PartnerId no registro (MPNID) na compra que ocorre quando a transferência é aceita.PartnerId on Record (MPNID) on the purchase that happens when the transfer is accepted.
offerIdofferId Cadeia de caracteresstring NoNo O identificador da oferta.The offer identifier.
addonItemsaddonItems Lista de objetos TransferLineItemList of TransferLineItem objects NãoNo Uma coleção de itens de linha transferEntity para complementos que serão transferidos junto com a assinatura base que está sendo transferida.A collection of transferEntity line items for addons that will be transferred along with the base subscription that is being transferred. Aplicado após a criação bem-sucedida do transferEntity.Applied upon successful creation of the transferEntity.
transferErrortransferError Cadeia de caracteresstring NoNo Aplicado após o transferEntity ser aceito em caso de erro.Applied after transferEntity is accepted in case of an error.
statusstatus stringstring NoNo O status do LineItem no transferEntity.The status of the lineitem in the transferEntity.

Exemplo de solicitaçãoRequest example

POST /v1/customers/d6bf25b7-e0a8-4f2d-a31b-97b55cfc774d/transfers HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: 0e93c70c-977c-4a88-9580-7cf084c73286
X-Locale: en-US
Content-Type: application/json
Host: api.partnercenter.microsoft.com
Expect: 100-continue

{
    "sourcePartnerTenantId": "da6c51b5-1246-4a42-b4ab-cbf38df54537",
    "targetPartnerTenantId": "656218b1-80c9-40b2-83ae-3a2703b55271",
    "lineItems": [
        {
            "subscriptionId": "7291BFBF-1772-4C5B-A624-18B6152CD8CB",
            "partnerIdOnRecord": "517285"
        },
        {
            "subscriptionId": "6C0B221B-8DF9-4F4A-A5BB-4C9CBB7B27B0",
            "partnerIdOnRecord": "517285"
        }
    ]
}

Resposta RESTREST response

Se for bem-sucedido, esse método retornará o recurso TransferEnity populado no corpo da resposta.If successful, this method returns the populated TransferEnity resource in the response body.

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.For the full list, see Error Codes.

Exemplo de respostaResponse example

HTTP/1.1 201 Created
Content-Length: 138
Content-Type: application/json; charset=utf-8
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: 0e93c70c-977c-4a88-9580-7cf084c73286
X-Locale: en-US,en-US
{
    "id": "67c5b05b-09b5-47ba-9047-5056fe2afa4f",
    "status": "Active",
    "createdTime": "2020-03-24T20:44:14.9602781Z",
    "lastModifiedTime": "2020-03-24T20:44:15Z",
    "customerTenantId": "823c6c3f-9259-4d51-bae2-5dd06743177f",
    "partnertenantid": "da6c51b5-1246-4a42-b4ab-cbf38df54537",
    "sourcePartnerTenantId": "da6c51b5-1246-4a42-b4ab-cbf38df54537",
    "targetPartnerTenantId": "656218b1-80c9-40b2-83ae-3a2703b55271",
    "lastModifiedUser": "d0648481-b615-45c9-8cd1-ff87940dbdc4",
    "lineItems": [
        {
            "id": 0,
            "subscriptionId": "7291BFBF-1772-4C5B-A624-18B6152CD8CB",
            "offerId": "50E9A47A-7B4D-4970-9D90-CAE927F53753",
            "billingCycle": "annual",
            "friendlyName": "Dynamics 365 for Sales Enterprise Attach to Qualifying Dynamics 365 Base Offer",
            "quantity": 1,
            "addonItems": [
                {
                    "id": 0,
                    "subscriptionId": "D738C6C9-DDBD-46E9-B316-65F9D9B3ECB4",
                    "offerId": "2BCF9FE8-8B65-4FCF-9240-419203FB8CF4",
                    "billingCycle": "annual",
                    "friendlyName": "Dynamics 365 - Additional Production Instance (Qualified Offer)",
                    "quantity": 4
                }
            ]
        },
        {
            "id": 0,
            "subscriptionId": "6C0B221B-8DF9-4F4A-A5BB-4C9CBB7B27B0",
            "offerId": "455DDD41-32ED-4E2D-B3A2-BBCB22CAA467",
            "billingCycle": "annual",
            "friendlyName": "Dynamics 365 Customer Engagement Plan Patch",
            "quantity": 8,
            "addonItems": []
        }
    ],
    "links": {
        "self": {
            "uri": "/customers/823c6c3f-9259-4d51-bae2-5dd06743177f/transfers/67c5b05b-09b5-47ba-9047-5056fe2afa4f",
            "method": "GET",
            "headers": []
        }
    },
    "attributes": {
        "objectType": "TransferEntity"
    }
}