Obter uma lista de pedidos por cliente e tipo de ciclo de cobrança
Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government
Obtém uma coleção de recursos do Order que correspondem a um determinado cliente e tipo de ciclo de faturamento. Há um atraso de até 15 minutos entre o momento em que um pedido é enviado e quando ele aparece em uma coleção de pedidos de um cliente.
Pré-requisitos
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Uma ID do cliente (
customer-tenant-id
). Se você não souber a ID do cliente, poderá procurá-la no Partner Center selecionando o espaço de trabalho Clientes, o cliente na 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 é igual à ID do cliente (customer-tenant-id
).
C#
Para obter uma coleção de pedidos de um cliente:
Use sua coleção IAggregatePartner.Customers e chame o método ById() com a ID do cliente selecionada.
Chame a propriedade Orders e o método ByBillingCycleType() com seu BillingCycleType especificado.
Chame o método Get() ou GetAsync().
// IAggregatePartner partnerOperations;
// string selectedCustomerId;
// BillingCycleType selectedBillingCycleType;
var orders = partnerOperations.Customers.ById(selectedCustomerId).Orders.ByBillingCycleType(selectedBillingCycleType).Get();
Solicitação REST
Sintaxe da solicitação
Método | URI da solicitação |
---|---|
GET | {baseURL}/v1/customers/{customer-tenant-id}/orders?billingType={billing-cycle-type} HTTP/1.1 |
Parâmetros do URI
Esta tabela lista os parâmetros de consulta necessários para obter uma coleção de pedidos por ID do cliente e tipo de ciclo de faturamento.
Nome | Digitar | Obrigatória | Descrição |
---|---|---|---|
id de locatário do cliente | string | Sim | Uma cadeia de caracteres formatada em GUID correspondente ao cliente. |
tipo ciclo de faturamento | string | Não | Uma cadeia de caracteres correspondente ao tipo de ciclo de faturamento. |
Cabeçalhos da solicitação
Para obter mais informações, confira Cabeçalhos REST do Partner Center.
Corpo da solicitação
Nenhum.
Exemplo de solicitação
GET https://api.partnercenter.microsoft.com/v1/customers/b0d70a69-4c42-4b27-b17b-91a835d8686a/orders?billingType=onetime HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 0e5fc923-8e3c-4560-9100-ce7283c3e081
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
Connection: Keep-Alive
Resposta REST
Se bem-sucedido, esse método retorna uma coleção de recursos Order no corpo da resposta.
Códigos de êxito e de erro de resposta
Cada resposta vem com um código de status HTTP que indica sucesso 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.
Exemplo de resposta
HTTP/1.1 200 OK
Content-Length: 22463
Content-Type: application/json; charset=utf-8
MS-CorrelationId: bbbb1111-cc22-3333-44dd-555555eeeeee
MS-RequestId: 3c6a034c-82ee-4095-d50f-9b530a415f1f
MS-CV: nb4/b3Yl2keY0eYR.0
MS-ServerId: 202010607
Date: Thu, 15 Mar 2018 20:44:40 GMT
{
"totalCount": 2,
"items": [
{
"id": "9qg-ErcO-4MPbPqq_3MIQaS7bn8W6HfG1",
"referenceCustomerId": "b0d70a69-4c42-4b27-b17b-91a835d8686a",
"billingCycle": "one_time",
"currencyCode": "USD",
"lineItems": [
{
"lineItemNumber": 0,
"offerId": "DZH318Z0BQ4B:000Z:DZH318Z0DSPL",
"friendlyName": "Reserved_VM_Instance_Standard_D1_AP_East_1_Year",
"quantity": 1,
"links": {
"sku": {
"uri": "/products/DZH318Z0BQ4B/skus/000Z?country=US",
"method": "GET",
"headers": []
}
}
}
],
"creationDate": "2018-03-15T02:17:15.6455674Z",
"status": "pending",
"links": {
"provisioningStatus": {
"uri": "/customers/b0d70a69-4c42-4b27-b17b-91a835d8686a/orders/9qg-ErcO-4MPbPqq_3MIQaS7bn8W6HfG1/provisioningstatus",
"method": "GET",
"headers": []
},
"self": {
"uri": "/customers/b0d70a69-4c42-4b27-b17b-91a835d8686a/orders/9qg-ErcO-4MPbPqq_3MIQaS7bn8W6HfG1",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Order"
}
},
{
"id": "s-BZlr_TeGksPNT61SsWRL-sqMaKbyVa1",
"referenceCustomerId": "b0d70a69-4c42-4b27-b17b-91a835d8686a",
"billingCycle": "one_time",
"currencyCode": "USD",
"lineItems": [
{
"lineItemNumber": 0,
"offerId": "DZH318Z0BQ4Z:002P:DZH318Z0CL2D",
"friendlyName": "Reserved_VM_Instance_Standard_NC12_AU_East_3_Years",
"quantity": 1,
"links": {
"sku": {
"uri": "/products/DZH318Z0BQ4Z/skus/002P?country=US",
"method": "GET",
"headers": []
}
}
}
],
"creationDate": "2018-03-15T01:42:36.8440279Z",
"status": "pending",
"links": {
"provisioningStatus": {
"uri": "/customers/b0d70a69-4c42-4b27-b17b-91a835d8686a/orders/s-BZlr_TeGksPNT61SsWRL-sqMaKbyVa1/provisioningstatus",
"method": "GET",
"headers": []
},
"self": {
"uri": "/customers/b0d70a69-4c42-4b27-b17b-91a835d8686a/orders/s-BZlr_TeGksPNT61SsWRL-sqMaKbyVa1",
"method": "GET",
"headers": []
}
},
"attributes": { "objectType": "Order" }
}
],
"links": {
"self": {
"uri": "/customers/b0d70a69-4c42-4b27-b17b-91a835d8686a/orders",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType":
"Collection"
}
}