GET /service/api/ecom/orders/{vendorOrderCode}

Gets orders by vendor order code.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
vendorOrderCode

The vendor order code of the orders.

string

Required

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/ecom/orders/PSV0025764728

Body Parameters

None.

Response Information

Resource Description

GetOrderByVendorCodeResponseServiceModel
NameDescriptionTypeAdditional Information
Order

The Order item list.

GetOrderByVendorCodeResponseServiceModel_Order

None.

Sample Response

{
  "Order": {
    "VendorOrderCode": "PSV0058240131",
    "VendorOrderDate": "2020-07-12T17:36:56.2342372Z",
    "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": 137018418,
        "Keycode": "F09213E1E2994B508308",
        "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>F09213E1E2994B508308</Keycode>
        <LicenseId>137018418</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>PSV0058240131</VendorOrderCode>
    <VendorOrderDate>2020-07-12T17:36:56.2342372Z</VendorOrderDate>
  </Order>
</GetOrderByVendorCodeResponseServiceModel>