Deprecated
Announced Jun 1, 2020: APIs under the ECom.Orders scope are scheduled for End of Life effective December 1, 2020. At that time this API will no longer be available. Please see ECom.Shop for the next generation Ecommerce API functionality.
GET /service/api/ecom/orders/{vendorOrderCode}
Gets orders by vendor order code.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| vendorOrderCode |
The vendor order code of the orders. |
string |
Required |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/ecom/orders/PSV0037339869
|
Body Parameters
None.
Response Information
Resource Description
All orders associated with the specified vendor order code.
GetOrderByVendorCodeResponseServiceModel| Name | Description | Type | Additional Information |
|---|---|---|---|
| Order |
The Order item list. |
GetOrderByVendorCodeResponseServiceModel_Order |
None. |
Sample Response
{
"Order": {
"VendorOrderCode": "PSV0030570862",
"VendorOrderDate": "2024-04-19T00:00:08.4102896Z",
"CurrencyCode": "USD",
"TotalAmount": 5000.0,
"SubTotalAmount": 5000.0,
"TaxTotal": 0.0,
"Items": [
{
"ProductId": "113400101",
"Quantity": 1,
"Seats": 50,
"Years": 1,
"ListPrice": 100.0,
"UnitPrice": 100.0,
"LicenseId": 124005796,
"Keycode": "6165D781484F4707AAB0",
"Modules": null
}
],
"Customer": {
"FirstName": "John",
"LastName": "Doe",
"CompanyName": "Incorporated Inc.",
"CustomerEmail": "jdoe@incorporated.com",
"Address1": "Samplestreet 5",
"Address2": null,
"City": "Denver",
"State": "CO",
"Country": "USA",
"PostalCode": "80123"
}
}
}
<GetOrderByVendorCodeResponseServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
<Order>
<CurrencyCode>USD</CurrencyCode>
<Customer>
<Address1>Samplestreet 5</Address1>
<Address2 i:nil="true" />
<City>Denver</City>
<CompanyName>Incorporated Inc.</CompanyName>
<Country>USA</Country>
<CustomerEmail>jdoe@incorporated.com</CustomerEmail>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<PostalCode>80123</PostalCode>
<State>CO</State>
</Customer>
<Items>
<GetOrderByVendorCodeResponseServiceModel_Item>
<Keycode>6165D781484F4707AAB0</Keycode>
<LicenseId>124005796</LicenseId>
<ListPrice>100</ListPrice>
<Modules i:nil="true" />
<ProductId>113400101</ProductId>
<Quantity>1</Quantity>
<Seats>50</Seats>
<UnitPrice>100</UnitPrice>
<Years>1</Years>
</GetOrderByVendorCodeResponseServiceModel_Item>
</Items>
<SubTotalAmount>5000</SubTotalAmount>
<TaxTotal>0</TaxTotal>
<TotalAmount>5000</TotalAmount>
<VendorOrderCode>PSV0030570862</VendorOrderCode>
<VendorOrderDate>2024-04-19T00:00:08.4102896Z</VendorOrderDate>
</Order>
</GetOrderByVendorCodeResponseServiceModel>