Compartilhar via


Manage orders - Get orders for a customer and an indirect reseller partner

Obtém uma coleção de pedidos para o cliente especificado e um parceiro de revendedor indireto.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/orders
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/orders?indirect_reseller_id={indirect_reseller_id}&billingType={billingType}&include_price={include_price}&include_system_purchases={include_system_purchases}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
customer_id
path True

string

O identificador do cliente.

version
path True

string

billingType
query

integer

int32
include_price
query

boolean

Se o preço deve ser incluído na resposta (Padrão: false).

include_system_purchases
query

boolean

Se as compras criadas pelo sistema devem ser incluídas (padrão: false).

indirect_reseller_id
query

string

A ID do revendedor indireto.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
Authorization True

string

Token de portador de autorização

ms-correlationid

string

Usado para acompanhar solicitações internamente. Se um ms-correlationid não for fornecido, o servidor gerará um novo para cada solicitação

ms-cv

string

Usado para acompanhar solicitações internamente. Se um ms-cv não for fornecido, o servidor gerará um novo para cada solicitação

ms-requestid

string

Usado para idempotência de solicitações. Se um ms-requestid não for fornecido, o servidor gerará um novo para cada solicitação

Respostas

Nome Tipo Description
200 OK

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Orders.V2.Models.Order]

A solicitação foi bem-sucedida. O corpo da resposta contém os pedidos.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

400 Bad Request

Havia uma entrada ausente ou inválida. O corpo da resposta fornecerá os detalhes do erro.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

401 Unauthorized

A solicitação não foi autenticada. O cliente precisa se autenticar com o serviço de API do parceiro primeiro.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

403 Forbidden

A solicitação foi autenticada, mas foi recusada, pois o chamador não tem os direitos de invocá-la.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

404 Not Found

O recurso não foi encontrado ou não está disponível com os parâmetros de entrada fornecidos.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

500 Internal Server Error

O serviço de API do parceiro ou uma de suas dependências falhou ao atender à solicitação. Os chamadores podem repetir isso.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definições

Nome Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Orders.V2.Models.Order]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Services.Orders.V2.Models.ClientContext
Microsoft.Partner.Services.Orders.V2.Models.Order
Microsoft.Partner.Services.Orders.V2.Models.OrderLineItem
Microsoft.Partner.Services.Orders.V2.Models.OrderLineItemLinks
Microsoft.Partner.Services.Orders.V2.Models.OrderLinks
Microsoft.Partner.Services.Orders.V2.Models.Pricing
Microsoft.Partner.Services.Orders.V2.Models.PurchaseCommitment
Microsoft.Partner.Services.Orders.V2.Models.RenewsTo
System.Collections.Generic.KeyValuePair[System.String,System.String]
Nome Tipo Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nome Tipo Description
etag

string

objectType

string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Orders.V2.Models.Order]

Nome Tipo Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

items

Microsoft.Partner.Services.Orders.V2.Models.Order[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

totalCount

integer

Nome Tipo Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Services.Orders.V2.Models.ClientContext

Nome Tipo Description
deviceFamily

string

marketplaceCountry

string

name

string

Microsoft.Partner.Services.Orders.V2.Models.Order

Nome Tipo Description
alternateId

string

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • triennial
  • unknown
client

Microsoft.Partner.Services.Orders.V2.Models.ClientContext

creationDate

string

currencyCode

string

currencySymbol

string

id

string

lineItems

Microsoft.Partner.Services.Orders.V2.Models.OrderLineItem[]

links

Microsoft.Partner.Services.Orders.V2.Models.OrderLinks

referenceCustomerId

string

status enum:
  • cancelled
  • completed
  • error
  • partial_success
  • pending
  • pending_po_upload
  • pending_review
  • po_review_rejected
  • po_upload_complete
  • suspended
  • unknown
totalPrice

number

transactionType

string

Microsoft.Partner.Services.Orders.V2.Models.OrderLineItem

Nome Tipo Description
attestationAccepted

boolean

customTermEndDate

string

friendlyName

string

lineItemNumber

integer

links

Microsoft.Partner.Services.Orders.V2.Models.OrderLineItemLinks

offerId

string

parentSubscriptionId

string

partnerIdOnRecord

string

pricing

Microsoft.Partner.Services.Orders.V2.Models.Pricing

promotionId

string

provisioningContext

object

purchaseCommitment

Microsoft.Partner.Services.Orders.V2.Models.PurchaseCommitment

quantity

integer

renewsTo

Microsoft.Partner.Services.Orders.V2.Models.RenewsTo

subscriptionId

string

termDuration

string

transactionType

string

Nome Tipo Description
activationLinks

Microsoft.Partner.Core.Collections.Link

availability

Microsoft.Partner.Core.Collections.Link

product

Microsoft.Partner.Core.Collections.Link

provisioningStatus

Microsoft.Partner.Core.Collections.Link

sku

Microsoft.Partner.Core.Collections.Link

subscription

Microsoft.Partner.Core.Collections.Link

Nome Tipo Description
patchOperation

Microsoft.Partner.Core.Collections.Link

provisioningStatus

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Services.Orders.V2.Models.Pricing

Nome Tipo Description
discountedPrice

number

extendedPrice

number

listPrice

number

price

number

proratedPrice

number

Microsoft.Partner.Services.Orders.V2.Models.PurchaseCommitment

Nome Tipo Description
amount

number

currency

string

grain

string

Microsoft.Partner.Services.Orders.V2.Models.RenewsTo

Nome Tipo Description
termDuration

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Nome Tipo Description
key

string

value

string