POST Search/getinventory

Get inventory list.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
limit	Limit	integer	None.
offset	Offset	integer	None.
shownew	Show New	boolean	None.
showused	Show Used	boolean	None.
stockno	Stock number	string	None.
vin	Vin	string	None.
color	Color	string	None.
make	Make	string	None.
year	Year	string	None.
model	Model	string	None.
trim	Trim	string	None.
useadvanced	Use Advanced	boolean	None.
entityid	GUID that uniquely identifies the Entity	globally unique identifier	None.
showlease	Show Lease	boolean	None.
showretail	Show Retail	boolean	None.
showballoon	Show Balloon	boolean	None.
termmin	Term Min	byte	None.
termmax	Term Max	byte	None.
pmtmin	Payment Min	integer	None.
pmtmax	Payment Max	integer	None.
sort	Sort	string	None.
direction	Sort Direction	string	None.
token	API access token	globally unique identifier	Required

Request Formats

application/json, text/json

Sample:

{
  "limit": 1,
  "offset": 1,
  "shownew": true,
  "showused": true,
  "stockno": "sample string 1",
  "vin": "sample string 2",
  "color": "sample string 3",
  "make": "sample string 4",
  "year": "sample string 5",
  "model": "sample string 6",
  "trim": "sample string 7",
  "useadvanced": true,
  "entityid": "8e38c34d-07ff-429c-a68c-2b38d5983e1f",
  "showlease": true,
  "showretail": true,
  "showballoon": true,
  "termmin": 64,
  "termmax": 64,
  "pmtmin": 1,
  "pmtmax": 1,
  "sort": "sample string 8",
  "direction": "sample string 9",
  "token": "78c518cd-b654-4fd8-813d-720e136f0d23"
}

application/xml, text/xml

Sample:

<GetInventoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Search">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">78c518cd-b654-4fd8-813d-720e136f0d23</token>
  <color>sample string 3</color>
  <direction>sample string 9</direction>
  <entityid>8e38c34d-07ff-429c-a68c-2b38d5983e1f</entityid>
  <limit>1</limit>
  <make>sample string 4</make>
  <model>sample string 6</model>
  <offset>1</offset>
  <pmtmax>1</pmtmax>
  <pmtmin>1</pmtmin>
  <showballoon>true</showballoon>
  <showlease>true</showlease>
  <shownew>true</shownew>
  <showretail>true</showretail>
  <showused>true</showused>
  <sort>sample string 8</sort>
  <stockno>sample string 1</stockno>
  <termmax>64</termmax>
  <termmin>64</termmin>
  <trim>sample string 7</trim>
  <useadvanced>true</useadvanced>
  <vin>sample string 2</vin>
  <year>sample string 5</year>
</GetInventoryRequest>

Response Information

Resource Description

InventoryList

Name	Description	Type	Additional information
Inventory		Collection of Inventory	None.
code	API result code	integer	None.
error	API error message	string	None.
APIVersion	API Version	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "APIVersion": 1,
  "Inventory": [
    {
      "StockNo": "sample string 1",
      "IsNew": true,
      "TrimID": 3,
      "Price": "sample string 4",
      "Odometer": 5,
      "Color": "sample string 6",
      "Days": "sample string 7",
      "SaleTypeID": 1,
      "NUC": "sample string 8",
      "NewPayment": "sample string 9"
    },
    {
      "StockNo": "sample string 1",
      "IsNew": true,
      "TrimID": 3,
      "Price": "sample string 4",
      "Odometer": 5,
      "Color": "sample string 6",
      "Days": "sample string 7",
      "SaleTypeID": 1,
      "NUC": "sample string 8",
      "NewPayment": "sample string 9"
    }
  ],
  "code": 200,
  "error": "sample string 1"
}

application/xml, text/xml

Sample:

<InventoryList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.Mobile">
  <APIVersion xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">1</APIVersion>
  <error xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">sample string 1</error>
  <Inventory>
    <Inventory>
      <Color>sample string 6</Color>
      <Days>sample string 7</Days>
      <IsNew>true</IsNew>
      <NUC>sample string 8</NUC>
      <NewPayment>sample string 9</NewPayment>
      <Odometer>5</Odometer>
      <Price>sample string 4</Price>
      <SaleTypeID>1</SaleTypeID>
      <StockNo>sample string 1</StockNo>
      <TrimID>3</TrimID>
    </Inventory>
    <Inventory>
      <Color>sample string 6</Color>
      <Days>sample string 7</Days>
      <IsNew>true</IsNew>
      <NUC>sample string 8</NUC>
      <NewPayment>sample string 9</NewPayment>
      <Odometer>5</Odometer>
      <Price>sample string 4</Price>
      <SaleTypeID>1</SaleTypeID>
      <StockNo>sample string 1</StockNo>
      <TrimID>3</TrimID>
    </Inventory>
  </Inventory>
</InventoryList>