Unity API Documentation

GET /service/api/ecom/shop/products/{keycode}/orderstatus

Gets information about the order status for a keycode.

This API returns status information about all orders associated with the provided keycode. The response may include multiple status information in case an existing license is upgraded or renewed for example. Each status information record provides the VendorOrderCode value which identifies the cart order that was used to create an order on the license.

Note: If no order status information is available for the provided keycode, the API will respond with a status code of 404 (NotFound). This can be the case for example when trying to query information for a trial license.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
keycode

The product keycode to query order status information for. In general, this is the keycode that was returned when an order is placed by processing a cart via the CreateOrder API.

 string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/ecom/shop/products/E00DFBA7F4824AC2B99C/orderstatus

Body Parameters

None.

Response Information

Resource Description

Information about the status of orders associated with the keycode.

GetOrderStatusResponseServiceModel
NameDescriptionTypeAdditional Information
OrderStatus

List of status information records for each order associated with a keycode.

 Collection of GetOrderStatusResponseServiceModelOrderStatus

None.

Sample Response

{
  "OrderStatus": [
    {
      "Keycode": "73FE2496CBAF42C295C4",
      "VendorOrderCode": "PSV0057936263",
      "ExceptionStatus": null,
      "PartnerLicenseStatus": "approved"
    },
    {
      "Keycode": "73FE2496CBAF42C295C4",
      "VendorOrderCode": "PSV0048271627",
      "ExceptionStatus": "resolved",
      "PartnerLicenseStatus": null
    }
  ]
}                    
<GetOrderStatusResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <OrderStatus>
    <GetOrderStatusResponseServiceModelOrderStatus>
      <ExceptionStatus i:nil="true" />
      <Keycode>73FE2496CBAF42C295C4</Keycode>
      <PartnerLicenseStatus>approved</PartnerLicenseStatus>
      <VendorOrderCode>PSV0057936263</VendorOrderCode>
    </GetOrderStatusResponseServiceModelOrderStatus>
    <GetOrderStatusResponseServiceModelOrderStatus>
      <ExceptionStatus>resolved</ExceptionStatus>
      <Keycode>73FE2496CBAF42C295C4</Keycode>
      <PartnerLicenseStatus i:nil="true" />
      <VendorOrderCode>PSV0048271627</VendorOrderCode>
    </GetOrderStatusResponseServiceModelOrderStatus>
  </OrderStatus>
</GetOrderStatusResponseServiceModel>