Revv.

InventoryService
Overview

Security
Type Name Scopes

apiKey Bearer

Paths
POST /v1/Images/addImage Uploads an image to a
specified inventory item. This endpoint allows adding
images during the creation or update of a stock.
Parameters

Type Name Description Schema

query forId The unique identifier of the inventory item to string

optional which the image will be added.

query tag A tag or name to associate with the uploaded string

optional image.

Responses

Code Description Links

200 Returns the uploaded image details as an No Links

Revv.Inventory.Shared.ImageModel object if the upload is
successful.

Content
text/plain
application/json
text/json

404 Returns an error if the specified inventory item is not found. No Links

500 Returns an error if the image upload fails due to server-side issues. No Links

1
DELETE /v1/Images/deleteImage Deletes a specific image
associated with an inventory item. This endpoint
allows removing images during the update of a stock.
Parameters

Type Name Description Schema

query imageId The unique identifier of the image to be deleted. string

optional

query forId The unique identifier of the inventory item from string
optional which the image will be deleted.

Responses

Code Description Links

200 Returns a boolean value of true if the image is successfully deleted. No Links

Content
text/plain
application/json
text/json

400 Returns an error if the image or inventory item is not found. No Links

500 Returns an error if the image deletion fails due to server-side issues. No Links

DELETE /v1/Images/deleteAllImages Deletes all images

associated with a specific inventory item. This
endpoint allows removing all images during the
update of a stock.
Parameters

Type Name Description Schema

query forId The unique identifier of the inventory item from string
optional which all images will be deleted.

Responses

2
Code Description Links

200 Returns a boolean value of true if all images are successfully No Links
deleted.

Content
text/plain
application/json
text/json

400 Returns an error if the inventory item is not found. No Links

500 Returns an error if the image deletion fails due to server-side issues. No Links

GET /v1/Inventory/getInventoryByID Retrieves detailed

information about a specific inventory item by its
unique ID.
This endpoint is used to view the details of a stock item in the inventory. .Parameters

Type Name Description Schema

query inventoryID The unique identifier of the inventory item to be string

optional fetched.

Responses

Code Description Links

200 Returns the details of the inventory item as a No Links

GetInventoryQueryResponse object.

Content
text/plain
application/json
text/json

404 Returns an error if the inventory ID is invalid or the inventory item No Links
is not found.

400 Returns an error message in case of a bad request. No Links

POST /v1/Inventory/createInventory Creates a new

inventory item. This endpoint is used to add stock to
the inventory system.
Responses

3
Code Description Links

200 Success No Links

Content
text/plain
application/json
text/json

201 Returns the details of the created inventory item as a No Links

InventoryCreatedEvent.

400 Returns an error message if the input is invalid. No Links

409 Returns an error if a duplicate VIN is found during creation. No Links

401 Returns an error if the user is unauthorized to perform this action. No Links

PATCH /v1/Inventory/updateInventory Updates the

details of an existing inventory item.
Responses

Code Description Links

200 Returns the details of the updated inventory item as a No Links

InventoryChangedEvent object.

Content
text/plain
application/json
text/json

404 Returns an error if the inventory item is not found. No Links

400 Returns an error message if the request is invalid or the update fails. No Links

POST /v1/Inventory/GetAllInventories Retrieves a list of

inventory items based on the specified search criteria.
The search can filter by inventory state, vehicle details, auction house, pagination parameters, and
user email. .Responses

4
Code Description Links

200 Returns a paginated list of inventory items as a No Links

GetAllInventoriesQueryResponse object.

Content
text/plain
application/json
text/json

400 Returns an error message if the query is invalid. No Links

401 Returns an error if the user is unauthorized. No Links

GET /v1/Inventory/getAllStates Retrieves a list of all

available inventory states.
Responses

Code Description Links

200 Returns a list of inventory state names as a List{String} No Links

Content
text/plain
application/json
text/json

GET /v1/Inventory/getAllStatesWithActions Retrieves all

inventory states along with their corresponding
actions.
Responses

Code Description Links

200 Returns a list of inventory states with their associated actions as a No Links
List{InventoryState}

Content
text/plain
application/json
text/json

5
GET /v1/Inventory/getInventoriesCountCallToAction
Retrieves the count of inventory items grouped by
state or call-to-action.
This endpoint is used for dashboard reporting of stock counts. .Responses

Code Description Links

200 Returns a list of states and their corresponding inventory counts as No Links
a GetInventoriesCountForStatesAndCallToActionQueryResponse
object.

Content
text/plain
application/json
text/json

400 Returns an error if the request is invalid. No Links

401 Returns an error if the user is unauthorized. No Links

GET /v1/Vin/getDetailsByVINNumber This API is used to

get vehicle details by a VIN number.
It internally tries to fetch Vehicle details from this website https://vpic.nhtsa.dot.gov/api/vehicles/
decodevinextended/. This API is used by the create and update stock functionality. .Parameters

Type Name Description Schema

query year The year of the vehicle whose details need to be integer (int32)
optional fetched.

query vin The VIN of the vehicle whose details need to be string
optional fetched.

Responses

Code Description Links

200 If the VIN is found then vehicle details are returned successfully. No Links

Content
text/plain
application/json
text/json

6
Components
Schemas
AddInventoryCommand
Properties

Name Description Schema

inventoryMod InventoryMod
el optional el

email optional nullable string

Address
Properties

Name Description Schema

addressType AddressTypes
optional

locationName nullable string

optional

addressLine1 nullable string

optional

addressLine2 nullable string

optional

city optional nullable string

zipCode nullable string

optional

state optional nullable string

country nullable string

optional

AddressTypes

AssignedAuctionHouse

Represents the auction house that has been assigned to handle the auction of the inventory item.

Properties

7
Name Description Schema

auctionHouseI The unique identifier of the assigned auction house. string

d optional
nullable

name optional The name of the assigned auction house. string

nullable

description Additional details or a brief description of the assigned auction string

optional house.

nullable

isRecommende Indicates whether this auction house is recommended for the boolean
dAuctionHouse inventory item.
optional
nullable

AssignedAuctionInHouse
Properties

Name Description Schema

auctionId nullable string

optional

name optional nullable string

description nullable string

optional

auctionBranch nullable string

Address
optional

emailId nullable string

optional

phoneNumber nullable string

optional

offSite optional nullable boolean

offsiteAddress nullable string

optional

AuctionInformation
Properties

Name Description Schema

lane optional nullable string

run optional nullable string

8
Name Description Schema

when optional nullable string (date-

time)

AuctionTransportDetails
Properties

Name Description Schema

stockId nullable string

optional

releasedForPic nullable string (date-

kup optional time)

anticipatedPic nullable string (date-

kupDate time)
optional

vehiclePickupS nullable string (date-

hipDate time)
optional

vehicleDeliver nullable string (date-

edDate time)
optional

deliveredTo nullable string

optional

vehiclePickup nullable string

Mileage
optional

transportationI nullable string

nvoice optional

transportation nullable string

ChargedBy
optional

transportCharg nullable string

eCompanyNam
e optional

transportComp nullable string

anyName
optional

pickupStorage nullable string

Fee optional

pickupTowFee nullable string

optional

9
Name Description Schema

otherPickupFe nullable string

es optional

otherPickupFe nullable string

esComment
optional

vehiclePickup nullable boolean

Damage
optional

vehiclePickup nullable string

DamageNotes
optional

keysType nullable string

optional

keysQuantity nullable string

optional

licensePlate nullable string

optional

licensePlateSta nullable string

te optional

AudioOptions

BodyType

Represents the various body styles of vehicles.

BuyerInfo
Properties

Name Description Schema

highestBid nullable string

optional

buyerName nullable string

optional

buyerPayment nullable string

Received
optional

internetBuyer nullable string

optional

10
Name Description Schema

manufacturerB nullable string

uyerNumber
optional

buyerRepresen nullable string

tative optional

buyerStreet nullable string

optional

buyerCity nullable string

optional

buyerZip nullable string

optional

buyerState nullable string

optional

buyerPhone nullable string

optional

CTAItem
Properties

Name Description Schema

title optional nullable string

variableName nullable string

optional

ctaItemsTotalC nullable integer (int32)

ount optional

Color
Properties

Name Description Schema

code optional nullable string

description nullable string

optional

Condition
Properties

Name Description Schema

frameDamage nullable boolean

optional

11
Name Description Schema

priorPaint nullable < PriorPaint >

optional array

conditionNotes nullable string

optional

announcement nullable < string > array

s optional

grade optional nullable number

(double)

gradeDescripti nullable string

on optional

drivable nullable boolean

optional

asIs optional nullable boolean

disclosure nullable < string > array

optional

createdTimeSt nullable string (date-

amp optional time)

conditionRepo ConditionRepo
rtIAA optional rtIAA

ConditionReport
Properties

Name Description Schema

source optional nullable string

href optional nullable string

ConditionReportIAA
Properties

Name Description Schema

stockId nullable string

optional

createdTimeSt nullable string (date-

amp optional time)

lossType nullable < string > array

optional

primaryDamag nullable < string > array

e optional

12
Name Description Schema

secondaryDam nullable < string > array

age optional

href optional nullable string

salvage nullable boolean

optional

Contact
Properties

Name Description Schema

contactName nullable string

optional

companyName nullable string

optional

phone optional nullable string

email optional nullable string

manheimAcco nullable string

untNumber
optional

ContactDetails
Properties

Name Description Schema

firstName nullable string

optional

lastName nullable string

optional

email optional nullable string

phoneNumber nullable string

1 optional

phoneNumber nullable string

2 optional

fax optional nullable string

Description
Properties

13
Name Description Schema

modelYear nullable integer (int32)

optional

make optional nullable string

model optional nullable string

trim optional nullable string

color optional nullable string

series optional nullable string

interiorColor Color
optional

exteriorColor Color
optional

engineType EngineType
optional

engineHorsepo nullable string

wer optional

engineDisplace nullable string

ment optional

fuel optional FuelType

engineModel nullable string

optional

transmission TransmissionT
optional ype

interiorType InteriorType
optional

roofType RoofType
optional

driveType DriveType
optional

audio optional nullable < AudioOptions

> array

doorCount nullable string

optional

options nullable < string > array

optional

brakes optional nullable string

seats optional nullable string

14
Name Description Schema

cruiseControl nullable string

optional

DriveType

DropOff

Represents the details related to the drop-off of an inventory item, applicable when the transport
type is "DropOff".

Properties

Name Description Schema

when optional The date and time when the drop-off is scheduled to occur. This string (date-
field is conditionally required based on specific business rules. time)

nullable

notes optional Additional notes or remarks about the drop-off, such as special string
instructions or clarifications.

nullable

EditableInventoryModel
Properties

Name Description Schema

inventoryId nullable string

optional

sellerOrganizat nullable string

ionId optional

sellerOrganizat nullable string

ionOfficeId
optional

creatorAccount nullable string

optional

pickupInforma Pickup
tion optional

dropOffInform DropOff
ation optional

type optional VehicleType

subtype BodyType
optional

15
Name Description Schema

assignedAuctio AssignedAuctio
nHouse nHouse
optional

assignedAuctio AssignedAuctio
nInHouse nInHouse
optional

vin optional nullable string

contact Contact
optional

customerRefer nullable string

enceID
optional

description Description
optional

odometer Odometer
optional

physicalLocati PhysicalLocati
on optional on

conditionRepo nullable <

rts optional ConditionRepo
rt > array

condition Condition
optional

title optional Title

images nullable < ImageModel

optional > array

runAndDrive nullable boolean

optional

restraint_Info nullable string

optional

currentState nullable string

optional

auctionTransp AuctionTransp
ortDetails ortDetails
optional

recommended Recommended
AuctionHouse AuctionHouse
optional

16
Name Description Schema

statesHistory nullable <

optional InventoryHisto
ry > array

stockNumber nullable integer (int32)

optional

assignmentDat nullable string (date-

e optional time)

auctionStockId nullable string

optional

sales optional nullable < Sale > array

lights optional nullable < Lights >

array

blackbookValu nullable number

e optional (double)

mmrReport MMRReport
optional

isCancellationP nullable boolean

ending
optional

lightsDescripti nullable string

on optional

isFloorPriceDis nullable boolean

able optional

isAssignSaleDa nullable boolean

teDisable
optional

isSalvage nullable boolean

optional

sold optional nullable string (date-

time)

cancellation nullable string (date-

optional time)

clearedForSale nullable string (date-

Date optional time)

reRuns nullable integer (int32)

optional

buyerInfo BuyerInfo
optional

17
Name Description Schema

paymentInfo PaymentInfo
optional

invoiceInfo InvoiceInfo
optional

legalSaleDate nullable string (date-

optional time)

saleableDate nullable string (date-

optional time)

onlineDaysRun nullable string

optional

EngineType

FuelType

GetAllInventoriesQuery
Properties

Name Description Schema

inventoryState nullable string

optional

callToAction nullable string

optional

search optional nullable string

pageNumber nullable integer (int32)

optional

pageSize nullable integer (int32)

optional

email optional nullable string

GetAllInventoriesQueryResponse
Properties

Name Description Schema

inventories nullable <

optional InventoryMod
el > array

total optional integer (int64)

18
GetInventoriesCountForStatesAndCallToActionQueryResponse
Properties

Name Description Schema

inventoryState nullable <

s optional InventoryState
> array

GetInventoryQueryResponse
Properties

Name Description Schema

inventory InventoryMod
optional el

ImageModel

The ImageModel object is returned when the addImage API is called

Properties

Name Description Schema

tag optional The file name of the uploaded image string

nullable

imageId An unique Id passed to identify an image string

optional
nullable

key optional The stock Id of the stock string

nullable

InteriorType

InventoryChangedEvent
Properties

Name Description Schema

inventoryId nullable string

optional

InventoryCreatedEvent
Properties

19
Name Description Schema

inventoryMod InventoryMod
el optional el

InventoryHistory
Properties

Name Description Schema

when optional nullable string (date-

time)

state optional nullable string

trackingColor TrackColor
optional

InventoryModel
Properties

Name Description Schema

inventoryId The unique identifier for the inventory item, stored as an string
optional ObjectId in MongoDB.

nullable

sellerOrganizat The identifier of the seller organization that owns this inventory string
ionId optional item.

nullable

sellerOrganizat The identifier of the specific office of the seller organization that string
ionOfficeId owns this inventory item.
optional
nullable

creatorAccount The account ID of the user who created the inventory record. string
optional
nullable

pickupInforma Pickup
tion optional

dropOffInform DropOff
ation optional

type optional VehicleType

subtype BodyType
optional

20
Name Description Schema

assignedAuctio AssignedAuctio
nHouse nHouse
optional

assignedAuctio AssignedAuctio
nInHouse nInHouse
optional

vin optional The unique Vehicle Identification Number (VIN) for this string
inventory item.

nullable

contact Contact
optional

customerRefer A reference number provided by the seller to identify this string

enceID inventory item.
optional
nullable

description Description
optional

odometer Odometer
optional

physicalLocati PhysicalLocati
on optional on

conditionRepo Reports on the condition of the vehicle, provided by the auction <
rts optional house. ConditionRepo
rt > array
nullable

condition Condition
optional

title optional Title

images A collection of images showcasing the vehicle. < ImageModel

optional > array
nullable

runAndDrive Indicates if the vehicle is operational and can be driven. boolean

optional
nullable

restraint_Info Additional restraint information for the vehicle, if available. string

optional
nullable

currentState The current state of the inventory item in the workflow (e.g., string
optional Pending, Sold).

nullable

21
Name Description Schema

auctionTransp AuctionTransp
ortDetails ortDetails
optional

recommended Recommended
AuctionHouse AuctionHouse
optional

statesHistory A history of state changes for the inventory item, including <
optional timestamps. InventoryHisto
ry > array
nullable

stockNumber A unique stock number assigned to this inventory item by the integer (int32)
optional Revv system.

nullable

assignmentDat The date on which the inventory was assigned to its current state string (date-
e optional or workflow. time)

nullable

auctionStockId A reference number provided by the auction house to identify string

optional this inventory item.

nullable

sales optional A collection of sales records related to the inventory item. < Sale > array

nullable

lights optional A list of light indicators associated with the vehicle’s condition. < Lights >
array
nullable

blackbookValu The market valuation of the vehicle as per the BlackBook API. number
e optional (double)
nullable

mmrReport MMRReport
optional

isCancellationP Indicates if there is a pending cancellation request for this boolean

ending inventory item.
optional
nullable

lightsDescripti A description of the lights or indicators for the vehicle, if string

on optional available.

nullable

isFloorPriceDis Indicates if the floor price is disabled for this inventory item. boolean
able optional
nullable

22
Name Description Schema

isAssignSaleDa Indicates if the assignment sale date is disabled for this boolean
teDisable inventory item.
optional
nullable

isSalvage Specifies whether the vehicle is classified as salvage. boolean

optional
nullable

sold optional The date when the inventory item was sold. string (date-
time)
nullable

cancellation The date when the inventory item was canceled. string (date-
optional time)
nullable

clearedForSale The date when the inventory item was cleared for sale. string (date-
Date optional time)
nullable

reRuns The number of times the inventory item has been re-listed for integer (int32)
optional sale.

nullable

buyerInfo BuyerInfo
optional

paymentInfo PaymentInfo
optional

invoiceInfo InvoiceInfo
optional

legalSaleDate The legally binding sale date for the inventory item. string (date-
optional time)
nullable

saleableDate The date from which the inventory item becomes saleable. string (date-
optional time)
nullable

onlineDaysRun A string representation of the number of days the inventory item string
optional has been online.

nullable

InventoryState
Properties

Name Description Schema

stateName nullable string

optional

23
Name Description Schema

stateTitle nullable string

optional

ctaSubSections nullable < StateCTAs >

optional array

ctaSubSections nullable integer (int32)

TotalCount
optional

InvoiceInfo
Properties

Name Description Schema

auctionInvoice nullable string

Number
optional

saleAmount nullable string

optional

checkAmount nullable string

optional

checkNumber nullable string

optional

chargeAmount nullable string

optional

buyerFees nullable string

optional

corporateParts nullable string

Amount
optional

corporateTires nullable string

Amount
optional

pstCollected nullable string

optional

gstCollected nullable string

optional

Lights

LocationType

24
MMRReport
Properties

Name Description Schema

min optional nullable number

(double)

average nullable number

optional (double)

max optional nullable number

(double)

Odometer
Properties

Name Description Schema

reading nullable integer (int32)

optional

units optional OdometerUnits

digits optional nullable integer (int32)

type optional OdometerType

operable nullable boolean

optional

OdometerType

OdometerUnits

OperatingLocation
Properties

Name Description Schema

href optional nullable string

PaymentInfo
Properties

Name Description Schema

paymentMetho nullable string

d optional

airBillNumber nullable string

Funds optional

25
Name Description Schema

fundsSentDate nullable string (date-

optional time)

fundsArrivedD nullable string (date-

ate optional time)

certificationCh nullable string

eckType
optional

certificationCh nullable string (date-

eckApprovedD time)
ate optional

certificationCh nullable string

eckAuctionApp
rovedBy
optional

certificationCh nullable string (date-

eckCompleted time)
Date optional

certificationCh nullable string

eckSellerAppro
val optional

certificationCh nullable string

eckSellerReject
ion optional

certificationCh nullable string

eckSellerAppro
vedRejectedBy
optional

PhysicalLocation
Properties

Name Description Schema

name optional nullable string

type optional LocationType

operatingLocat OperatingLoca
ion optional tion

address nullable string

optional

city optional nullable string

state optional nullable string

26
Name Description Schema

zip optional nullable string

Pickup

Represents the details related to the pickup of an inventory item, applicable when the transport
type is "Pickup".

Properties

Name Description Schema

when optional The date and time when the pickup is scheduled to occur. This string (date-
field is conditionally required based on certain business rules. time)

nullable

notes optional Additional notes or remarks about the pickup, provided for string
clarification or special instructions.

nullable

paymentRequi Indicates whether payment is required at the time of pickup. boolean

red optional
nullable

paymentNotes Notes related to the payment, such as payment methods or string

optional specific payment instructions.

nullable

location Address
optional

primaryContac ContactDetails
t optional

secondaryCont ContactDetails
act optional

PriorPaint
Properties

Name Description Schema

description nullable string

optional

condition nullable string

optional

RecommendedAuctionHouse
Properties

27
Name Description Schema

recommended nullable string

AuctionHouse
Name optional

recommended nullable string

AuctionHouseI
d optional

recommended nullable string

BranchName
optional

recommended nullable string

BranchId
optional

recommended nullable string

BranchAddress
optional

recommended nullable string

BranchDistanc
e optional

RoofType

Sale
Properties

Name Description Schema

saleOutcome SaleOutcomes
optional

winnerId nullable string

optional

floorPrice nullable number

optional (double)

auctionFloorPr nullable number

iceRecommend (double)
ation optional

amount nullable number

optional (double)

auctionInform AuctionInform
ation optional ation

bidAmountDiff nullable number

erence (double)
optional

28
SaleOutcomes

StateCTAs
Properties

Name Description Schema

sectionTitle nullable string

optional

actions nullable < CTAItem >

optional array

Title
Properties

Name Description Schema

number nullable integer (int32)

optional

state optional nullable string

notRequired nullable boolean

optional

receivedDate nullable string

optional

location TitleLocation
optional

operatingLocat OperatingLoca
ion optional tion

branding TitleBranding
optional

problem nullable string

optional

present nullable string

optional

TitleBranding

TitleLocation

TrackColor

TransmissionType

29
VINLookupQueryResponse
Properties

Name Description Schema

vin optional nullable string

make optional nullable string

model optional nullable string

modelYear nullable string

optional

bodyClass nullable string

optional

engineCylinder nullable string

s optional

engineDisplace nullable string

ment optional

fuelTypePrima nullable string

ry optional

transmissionSt nullable string

yle optional

plantCountry nullable string

optional

vehicleType nullable string

optional

restraint_Info nullable string

optional

engineModel nullable string

optional

brakes optional nullable string

cruiseControl nullable string

optional

seats optional nullable string

trim optional nullable string

driveType nullable string

optional

doorCount nullable string

optional

series optional nullable string

30
VehicleType

Represents different types of vehicles categorized for inventory purposes.

31