POST Search/getinventory

Request Information

URI Parameters

None.

Body Parameters

GetInventoryRequest
NameDescriptionTypeAdditional information
limit

integer

None.

offset

integer

None.

shownew

boolean

None.

showused

boolean

None.

stockno

string

None.

vin

string

None.

color

string

None.

make

string

None.

year

string

None.

model

string

None.

trim

string

None.

useadvanced

boolean

None.

entityid

globally unique identifier

None.

showlease

boolean

None.

showretail

boolean

None.

showballoon

boolean

None.

termmin

byte

None.

termmax

byte

None.

pmtmin

integer

None.

pmtmax

integer

None.

sort

string

None.

direction

string

None.

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": "0f08b104-f2f7-41e9-84d3-fe1ab00f97d7",
  "showlease": true,
  "showretail": true,
  "showballoon": true,
  "termmin": 64,
  "termmax": 64,
  "pmtmin": 1,
  "pmtmax": 1,
  "sort": "sample string 8",
  "direction": "sample string 9",
  "token": "e65986c8-af67-4eaf-a8a6-bde3928e4e2a"
}

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">e65986c8-af67-4eaf-a8a6-bde3928e4e2a</token>
  <color>sample string 3</color>
  <direction>sample string 9</direction>
  <entityid>0f08b104-f2f7-41e9-84d3-fe1ab00f97d7</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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InventoryList
NameDescriptionTypeAdditional information
Inventory

Collection of Inventory

None.

code

integer

None.

error

string

None.

APIVersion

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>