Udostępnij za pośrednictwem


Manage orders - Get an order by ID

Pobiera określone zamówienie przy użyciu identyfikatora.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/orders/{order_id}
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/orders/{order_id}?include_price={include_price}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
customer_id
path True

string

Identyfikator klienta.

order_id
path True

string

Identyfikator zamówienia.

version
path True

string

include_price
query

boolean

Określa, czy uwzględnić cenę w odpowiedzi.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Authorization True

string

Token elementu nośnego autoryzacji

ms-correlationid

string

Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania

ms-cv

string

Służy do śledzenia żądań wewnętrznie. Jeśli ms-cv nie zostanie podany, serwer wygeneruje nowy dla każdego żądania

ms-requestid

string

Służy do idempotentności żądań. Jeśli parametr ms-requestid nie zostanie podany, serwer wygeneruje nowy dla każdego żądania

Odpowiedzi

Nazwa Typ Opis
200 OK

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

Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera informacje o zamówieniu.

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

400 Bad Request

Brak danych wejściowych lub nieprawidłowych danych wejściowych. Treść odpowiedzi udostępni szczegóły błędu.

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

401 Unauthorized

Żądanie nie zostało uwierzytelnione. Klient musi najpierw uwierzytelnić się za pomocą usługi interfejsu API partnera.

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

403 Forbidden

Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma uprawnień do jego wywołania.

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

404 Not Found

Zasób nie został znaleziony lub nie jest dostępny z podanymi parametrami wejściowymi.

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

500 Internal Server Error

Usługa interfejsu API partnera lub jedna z jej zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę.

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

Definicje

Nazwa Opis
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
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]
Nazwa Typ Opis
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nazwa Typ Opis
etag

string

objectType

string

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

Nazwa Typ Opis
deviceFamily

string

marketplaceCountry

string

name

string

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

Nazwa Typ Opis
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

Nazwa Typ Opis
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

Nazwa Typ Opis
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

Nazwa Typ Opis
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

Nazwa Typ Opis
discountedPrice

number

extendedPrice

number

listPrice

number

price

number

proratedPrice

number

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

Nazwa Typ Opis
amount

number

currency

string

grain

string

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

Nazwa Typ Opis
termDuration

string

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

Nazwa Typ Opis
key

string

value

string