Manage orders - Get an order by ID

Service:

Partner Center Rest

API Version:

v1

Gets a specific order using a ID.

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	The customer identifier.
order_id	path	True	string	The order identifier.
version	path	True	string
include_price	query		boolean	Whether to include price in the response.

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Services.Orders.V2.Models.Order	The request was successful. The response body contains the order information. Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request		There was a missing or an invalid input. The response body will provide the error details. Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden		The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error		The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

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

Microsoft.Partner.Core.Collections.Link

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

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

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

Name	Type	Description
deviceFamily	string
marketplaceCountry	string
name	string

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

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

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

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

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

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

Name	Type	Description
discountedPrice	number
extendedPrice	number
listPrice	number
price	number
proratedPrice	number

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

Name	Type	Description
amount	number
currency	string
grain	string

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

Name	Type	Description
termDuration	string

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

Name	Type	Description
key	string
value	string