Manage orders - Get an order by ID

Tjänst:

Partner Center Rest

API-version:

v1

Hämtar en specifik order med hjälp av ett ID.

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
customer_id	path	True	string	Kundidentifieraren.
order_id	path	True	string	Orderidentifieraren.
version	path	True	string
include_price	query		boolean	Om du vill inkludera priset i svaret.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	Token för auktoriseringsbärare
ms-correlationid		string	Används för att spåra begäranden internt. Om ett ms-correlationid inte anges genererar servern en ny för varje begäran
ms-cv		string	Används för att spåra begäranden internt. Om en ms-cv inte tillhandahålls genererar servern en ny för varje begäran
ms-requestid		string	Används för idempotens för begäranden. Om ett ms-requestid inte har angetts genererar servern en ny för varje begäran

Svar

Name	Typ	Description
200 OK	Microsoft.Partner.Services.Orders.V2.Models.Order	Begäran lyckades. Svarstexten innehåller orderinformationen. Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request		Det saknades eller ogiltiga indata. Svarstexten innehåller felinformationen. Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized		Begäran autentiserades inte. Klienten måste autentisera med partner-API-tjänsten först. Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden		Begäran autentiserades men nekades eftersom anroparen inte har behörighet att anropa den. Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found		Resursen hittades inte eller är inte tillgänglig med de angivna indataparametrarna. Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error		Partner-API-tjänsten eller något av dess beroenden kunde inte uppfylla begäran. Anropare kan försöka igen. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitioner

Name	Description
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.ProductTerm
Microsoft.Partner.Services.Orders.V2.Models.PurchaseCommitment
Microsoft.Partner.Services.Orders.V2.Models.RenewsTo
Microsoft.Partner.Services.Orders.V2.Models.ScheduledNextTermInstructions
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Core.Collections.Link

Objekt

Name	Typ	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Objekt

Name	Typ	Description
etag	string
objectType	string

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

Objekt

Name	Typ	Description
deviceFamily	string
marketplaceCountry	string
name	string

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

Objekt

Name	Typ	Description
alternateId	string
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
billingCycle	enum: annual (int32) monthly (int32) none (int32) one_time (int32) triennial (int32) unknown (int32)
client	Microsoft.Partner.Services.Orders.V2.Models.ClientContext
creationDate	string (date-time)
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 (int32) completed (int32) error (int32) partial_success (int32) pending (int32) pending_po_upload (int32) pending_review (int32) po_review_rejected (int32) po_upload_complete (int32) suspended (int32) unknown (int32)
totalPrice	number (double)
transactionType	string

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

Objekt

Name	Typ	Description
attestationAccepted	boolean
customTermEndDate	string (date-time)
friendlyName	string
lineItemNumber	integer (int32)
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 (int32)
renewsTo	Microsoft.Partner.Services.Orders.V2.Models.RenewsTo
scheduledNextTermInstructions	Microsoft.Partner.Services.Orders.V2.Models.ScheduledNextTermInstructions
subscriptionId	string
termDuration	string
transactionType	string

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

Objekt

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

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

Objekt

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

Objekt

Name	Typ	Description
discountedPrice	number (double)
extendedPrice	number (double)
listPrice	number (double)
price	number (double)
proratedPrice	number (double)

Microsoft.Partner.Services.Orders.V2.Models.ProductTerm

Objekt

Name	Typ	Description
availabilityId	string
billingCycle	enum: annual (int32) biennial (int32) monthly (int32) none (int32) one_time (int32) triennial (int32) unknown (int32)
productId	string
skuId	string
termDuration	string

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

Objekt

Name	Typ	Description
amount	number (double)
currency	string
grain	string

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

Objekt

Name	Typ	Description
termDuration	string

Microsoft.Partner.Services.Orders.V2.Models.ScheduledNextTermInstructions

Objekt

Name	Typ	Description
product	Microsoft.Partner.Services.Orders.V2.Models.ProductTerm
quantity	number (int32)

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

Objekt

Name	Typ	Description
key	string
value	string