Manage orders - Get an order by ID

Servicio:

Partner Center Rest

Versión de la API:

v1

Obtiene un orden específico mediante un identificador.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
customer_id	path	True	string	Identificador del cliente.
order_id	path	True	string	Identificador de pedido.
version	path	True	string
include_price	query		boolean	Si se debe incluir el precio en la respuesta.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Authorization	True	string	Token de portador de autorización
ms-correlationid		string	Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-correlationid, el servidor generará uno nuevo para cada solicitud.
ms-cv		string	Se usa para realizar el seguimiento de las solicitudes internamente. Si no se proporciona un ms-cv, el servidor generará uno nuevo para cada solicitud.
ms-requestid		string	Se usa para la idempoencia de las solicitudes. Si no se proporciona un ms-requestid, el servidor generará uno nuevo para cada solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	Microsoft.Partner.Services.Orders.V2.Models.Order	La solicitud se realizó correctamente. El cuerpo de la respuesta contiene la información del pedido. Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request		Faltaba o faltaba una entrada no válida. El cuerpo de la respuesta proporcionará los detalles del error. Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized		La solicitud no se autenticó. El cliente debe autenticarse primero con el servicio de API del asociado. Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden		La solicitud se autenticó pero se rechazó, ya que el autor de la llamada no tiene los derechos para invocarla. Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found		El recurso no se encuentra o no está disponible con los parámetros de entrada especificados. Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error		El servicio de API del asociado o una de sus dependencias no pudieron cumplir la solicitud. Los autores de llamadas pueden volver a intentarlo. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definiciones

Nombre	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

Nombre	Tipo	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nombre	Tipo	Description
etag	string
objectType	string

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

Nombre	Tipo	Description
deviceFamily	string
marketplaceCountry	string
name	string

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

Nombre	Tipo	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

Nombre	Tipo	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

Nombre	Tipo	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

Nombre	Tipo	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

Nombre	Tipo	Description
discountedPrice	number
extendedPrice	number
listPrice	number
price	number
proratedPrice	number

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

Nombre	Tipo	Description
amount	number
currency	string
grain	string

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

Nombre	Tipo	Description
termDuration	string

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

Nombre	Tipo	Description
key	string
value	string