Manage orders - Get orders for a customer and an indirect reseller partner
Gets a collection of order for specified customer and an indirect reseller partner.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/ordersGET 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}URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
customer_id
|
path | True |
string |
The customer identifier. |
|
version
|
path | True |
string |
|
|
billing
|
query |
integer int32 |
||
|
include_price
|
query |
boolean |
Whether to include price in the response (Default : false). |
|
|
include_system_purchases
|
query |
boolean |
Whether to include system created purchases (Default : false). |
|
|
indirect_reseller_id
|
query |
string |
The indirect reseller Id. |
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 |
The request was successful. The response body contains the orders. 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
Microsoft.Partner.Core.Collections.Link
| Name | Type | Description |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| Name | Type | Description |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Orders.V2.Models.Order]
| Name | Type | Description |
|---|---|---|
| attributes | ||
| items | ||
| links | ||
| totalCount |
integer |
Microsoft.Partner.Core.Collections.ResourceLinks
| Name | Type | Description |
|---|---|---|
| next | ||
| previous | ||
| self |
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 | ||
| billingCycle |
enum:
|
|
| client | ||
| creationDate |
string |
|
| currencyCode |
string |
|
| currencySymbol |
string |
|
| id |
string |
|
| lineItems | ||
| links | ||
| referenceCustomerId |
string |
|
| status |
enum:
|
|
| totalPrice |
number |
|
| transactionType |
string |
Microsoft.Partner.Services.Orders.V2.Models.OrderLineItem
| Name | Type | Description |
|---|---|---|
| attestationAccepted |
boolean |
|
| customTermEndDate |
string |
|
| friendlyName |
string |
|
| lineItemNumber |
integer |
|
| links |
Microsoft. |
|
| offerId |
string |
|
| parentSubscriptionId |
string |
|
| partnerIdOnRecord |
string |
|
| pricing | ||
| promotionId |
string |
|
| provisioningContext |
object |
|
| purchaseCommitment |
Microsoft. |
|
| quantity |
integer |
|
| renewsTo | ||
| subscriptionId |
string |
|
| termDuration |
string |
|
| transactionType |
string |
Microsoft.Partner.Services.Orders.V2.Models.OrderLineItemLinks
| Name | Type | Description |
|---|---|---|
| activationLinks | ||
| availability | ||
| product | ||
| provisioningStatus | ||
| sku | ||
| subscription |
Microsoft.Partner.Services.Orders.V2.Models.OrderLinks
| Name | Type | Description |
|---|---|---|
| patchOperation | ||
| provisioningStatus | ||
| self |
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 |