POST /service/api/ecom/licenses

Creates one or multiple licenses. Returns order details along with the license id and keycode created for each item in the order.

Request Information

URI Parameters

None.

Body Parameters

CreateLicensesRequestServiceModel
NameDescriptionTypeAdditional Information
Order

Order element.

CreateLicensesRequestServiceModel_Order

None.

Sample Request

{
  "Order": {
    "PartnerOrderCode": null,
    "PartnerOrderDate": null,
    "LanguageCode": "EN",
    "LocationCode": "USA",
    "PurchaseOrder": null,
    "Items": [
      {
        "Modules": [
          {
            "Code": "DNS",
            "Seats": 50
          },
          {
            "Code": "WSAT",
            "Seats": 50
          }
        ],
        "PartnerProductId": "113400101",
        "Quantity": 1,
        "Seats": 50,
        "ListPrice": null,
        "UnitPrice": null,
        "StartDate": null,
        "ExpirationDate": null
      }
    ],
    "Customers": [
      {
        "ExternalAccountId": "MyAccountRef6012",
        "FirstName": "John",
        "LastName": "Doe",
        "CompanyName": "Incorporated Inc.",
        "CustomerEmail": "jdoe@incorporated.com",
        "PhoneNumber": "07592278",
        "Address1": "Samplestreet 5",
        "Address2": null,
        "City": "Denver",
        "State": "CO",
        "Country": "USA",
        "PostalCode": "80123",
        "OrderCompanyTypeId": 1
      }
    ]
  }
}                    
<CreateLicensesRequestServiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.ECom.Models">
  <Order>
    <Customers>
      <CreateLicensesRequestServiceModel_Customer>
        <Address1>Samplestreet 5</Address1>
        <Address2 i:nil="true" />
        <City>Denver</City>
        <CompanyName>Incorporated Inc.</CompanyName>
        <Country>USA</Country>
        <CustomerEmail>jdoe@incorporated.com</CustomerEmail>
        <ExternalAccountId>MyAccountRef6012</ExternalAccountId>
        <FirstName>John</FirstName>
        <LastName>Doe</LastName>
        <OrderCompanyTypeId>1</OrderCompanyTypeId>
        <PhoneNumber>07592278</PhoneNumber>
        <PostalCode>80123</PostalCode>
        <State>CO</State>
      </CreateLicensesRequestServiceModel_Customer>
    </Customers>
    <Items>
      <CreateLicensesRequestServiceModel_Item>
        <ExpirationDate i:nil="true" />
        <ListPrice i:nil="true" />
        <Modules>
          <CreateLicensesRequestServiceModel_Module>
            <Code>DNS</Code>
            <Seats>50</Seats>
          </CreateLicensesRequestServiceModel_Module>
          <CreateLicensesRequestServiceModel_Module>
            <Code>WSAT</Code>
            <Seats>50</Seats>
          </CreateLicensesRequestServiceModel_Module>
        </Modules>
        <PartnerProductId>113400101</PartnerProductId>
        <Quantity>1</Quantity>
        <Seats>50</Seats>
        <StartDate i:nil="true" />
        <UnitPrice i:nil="true" />
      </CreateLicensesRequestServiceModel_Item>
    </Items>
    <LanguageCode>EN</LanguageCode>
    <LocationCode>USA</LocationCode>
    <PartnerOrderCode i:nil="true" />
    <PartnerOrderDate i:nil="true" />
    <PurchaseOrder i:nil="true" />
  </Order>
</CreateLicensesRequestServiceModel>                    

Response Information

Resource Description

Details about created license.

CreateLicensesResponseServiceModel
NameDescriptionTypeAdditional Information
Order

Order element.

CreateLicensesResponseServiceModel_Order

None.

Sample Response

{
  "Order": {
    "VendorOrderCode": "PSV0042791749",
    "VendorOrderDate": "2019-08-24T07:14:39.1128259Z",
    "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": 174561056,
        "Keycode": "A2000B2812A64C7E86A4",
        "Modules": [
          {
            "ProductId": "113400101",
            "Quantity": 1,
            "Seats": 50,
            "Years": 2,
            "ListPrice": 200.0,
            "UnitPrice": 250.0
          }
        ]
      }
    ],
    "Customer": {
      "FirstName": "John",
      "LastName": "Doe",
      "CompanyName": "Incorporated Inc.",
      "CustomerEmail": "jdoe@incorporated.com",
      "PhoneNumber": "07850064",
      "Address1": "Samplestreet 5",
      "Address2": null,
      "City": "Denver",
      "State": "CO",
      "PostalCode": "80123",
      "Country": "USA"
    }
  }
}                    
<CreateLicensesResponseServiceModel 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>
      <PhoneNumber>07850064</PhoneNumber>
      <PostalCode>80123</PostalCode>
      <State>CO</State>
    </Customer>
    <Items>
      <CreateLicensesResponseServiceModel_Item>
        <Keycode>A2000B2812A64C7E86A4</Keycode>
        <LicenseId>174561056</LicenseId>
        <ListPrice>100</ListPrice>
        <Modules>
          <CreateLicensesResponseServiceModel_Module>
            <ListPrice>200</ListPrice>
            <ProductId>113400101</ProductId>
            <Quantity>1</Quantity>
            <Seats>50</Seats>
            <UnitPrice>250</UnitPrice>
            <Years>2</Years>
          </CreateLicensesResponseServiceModel_Module>
        </Modules>
        <ProductId>113400101</ProductId>
        <Quantity>1</Quantity>
        <Seats>50</Seats>
        <UnitPrice>100</UnitPrice>
        <Years>1</Years>
      </CreateLicensesResponseServiceModel_Item>
    </Items>
    <SubTotalAmount>5000</SubTotalAmount>
    <TaxTotal>0</TaxTotal>
    <TotalAmount>5000</TotalAmount>
    <VendorOrderCode>PSV0042791749</VendorOrderCode>
    <VendorOrderDate>2019-08-24T07:14:39.1128259Z</VendorOrderDate>
  </Order>
</CreateLicensesResponseServiceModel>