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

Body Parameters

None.

Response Information

Resource Description

GetOrderByVendorCodeResponseServiceModel
NameDescriptionTypeAdditional Information
Order

The Order item list.

GetOrderByVendorCodeResponseServiceModel_Order

None.

Sample Response

{
  "Order": {
    "VendorOrderCode": "PSV0053212944",
    "VendorOrderDate": "2019-09-19T05:18:44.339802Z",
    "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": 126195056,
        "Keycode": "8D32029D76CB4A749753",
        "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>8D32029D76CB4A749753</Keycode>
        <LicenseId>126195056</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>PSV0053212944</VendorOrderCode>
    <VendorOrderDate>2019-09-19T05:18:44.339802Z</VendorOrderDate>
  </Order>
</GetOrderByVendorCodeResponseServiceModel>