Manage orders - Get an order by ID

  • Referenz
Dienst:
Partner Center Rest
API-Version:
v1

Ruft eine bestimmte Bestellung mithilfe einer ID ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
customer_id
 path True

string

Der Kundenbezeichner.
order_id
 path True

string

Der Auftragsbezeichner.
version
 path True

string

include_price
 query

boolean

Gibt an, ob der Preis in die Antwort eingeschlossen werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Autorisierungs-Bearertoken
ms-correlationid

string

Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue.
ms-cv

string

Wird intern zum Nachverfolgen von Anforderungen verwendet. Wenn kein ms-cv bereitgestellt wird, generiert der Server für jede Anforderung eine neue.
ms-requestid

string

Wird für die Idempotenz von Anforderungen verwendet. Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue anforderung.

Antworten

Name Typ Beschreibung
200 OK

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

Die Anforderung war erfolgreich. Der Antworttext enthält die Bestellinformationen.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request

Es fehlte eine oder eine ungültige Eingabe. Der Antworttext enthält die Fehlerdetails.

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

Die Anforderung wurde nicht authentifiziert. Der Client muss sich zuerst beim Partner-API-Dienst authentifizieren.

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

Die Anforderung wurde authentifiziert, wurde aber abgelehnt, da der Aufrufer nicht über die Rechte zum Aufrufen verfügt.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found

Die Ressource wurde mit den angegebenen Eingabeparametern nicht gefunden oder nicht verfügbar.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error

Der Partner-API-Dienst oder eine seiner Abhängigkeiten konnte die Anforderung nicht erfüllen. Anrufer versuchen dies möglicherweise erneut.

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

Definitionen

Name Beschreibung
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]
Name Typ Beschreibung
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Typ Beschreibung
etag

string

objectType

string

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

Name Typ Beschreibung
deviceFamily

string

marketplaceCountry

string

name

string

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

Name Typ Beschreibung
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

Name Typ Beschreibung
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

Name Typ Beschreibung
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

Name Typ Beschreibung
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

Name Typ Beschreibung
discountedPrice

number

extendedPrice

number

listPrice

number

price

number

proratedPrice

number

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

Name Typ Beschreibung
amount

number

currency

string

grain

string

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

Name Typ Beschreibung
termDuration

string

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

Name Typ Beschreibung
key

string

value

string