Get Parts Inventory

Endpoint:

GET v1/Inventory?partFamilyId={partFamilyId}&brandId={brandId}&partType={partType}&allWarehouses={allWarehouses}&newDate={newDate}

URI Parameters

NameDescriptionTypeAdditional information
partFamilyId

Part Family Id

string

None.

brandId

Brand Id

string

None.

partType

0 – Standard (all parts except for discontinued) 1 – All (all parts available for sale on our website) [DEFAULT] 2 – Limit to sale parts 3 – Limit to discontinued parts 4 – Limit to seconds 5 – Limit to new

byte

Default value is 1

allWarehouses

1 - include pricing for all warehouses

byte

Default value is 0

newDate

New Date

date

None.

Body Parameters

None.

Response Information

Collection of PartInventory
NameDescriptionTypeAdditional information
Id

string

None.

StockDen

integer

None.

StockRom

integer

None.

StockIml

integer

None.

StockOlv

integer

None.

StockLaw

integer

None.

StockTra

integer

None.

StockTyl

integer

None.

StockGre

integer

None.

StockMxm

integer

None.

StockLeb

integer

None.

StockStb

integer

None.

StockTotal

integer

None.

Response Examples

application/json, text/json :

[
  {
    "Id": "sample string 1",
    "StockDen": 1,
    "StockRom": 1,
    "StockIml": 1,
    "StockOlv": 1,
    "StockLaw": 1,
    "StockTra": 1,
    "StockTyl": 1,
    "StockGre": 1,
    "StockMxm": 1,
    "StockLeb": 1,
    "StockStb": 1,
    "StockTotal": 2
  },
  {
    "Id": "sample string 1",
    "StockDen": 1,
    "StockRom": 1,
    "StockIml": 1,
    "StockOlv": 1,
    "StockLaw": 1,
    "StockTra": 1,
    "StockTyl": 1,
    "StockGre": 1,
    "StockMxm": 1,
    "StockLeb": 1,
    "StockStb": 1,
    "StockTotal": 2
  }
]

text/javascript :

[{"Id":"sample string 1","StockDen":1,"StockRom":1,"StockIml":1,"StockOlv":1,"StockLaw":1,"StockTra":1,"StockTyl":1,"StockGre":1,"StockMxm":1,"StockLeb":1,"StockStb":1,"StockTotal":2},{"Id":"sample string 1","StockDen":1,"StockRom":1,"StockIml":1,"StockOlv":1,"StockLaw":1,"StockTra":1,"StockTyl":1,"StockGre":1,"StockMxm":1,"StockLeb":1,"StockStb":1,"StockTotal":2}]

application/xml, text/xml :

<ArrayOfPartInventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models">
  <PartInventory>
    <Id>sample string 1</Id>
    <StockDen>1</StockDen>
    <StockGre>1</StockGre>
    <StockIml>1</StockIml>
    <StockLaw>1</StockLaw>
    <StockLeb>1</StockLeb>
    <StockMxm>1</StockMxm>
    <StockOlv>1</StockOlv>
    <StockRom>1</StockRom>
    <StockStb>1</StockStb>
    <StockTotal>2</StockTotal>
    <StockTra>1</StockTra>
    <StockTyl>1</StockTyl>
  </PartInventory>
  <PartInventory>
    <Id>sample string 1</Id>
    <StockDen>1</StockDen>
    <StockGre>1</StockGre>
    <StockIml>1</StockIml>
    <StockLaw>1</StockLaw>
    <StockLeb>1</StockLeb>
    <StockMxm>1</StockMxm>
    <StockOlv>1</StockOlv>
    <StockRom>1</StockRom>
    <StockStb>1</StockStb>
    <StockTotal>2</StockTotal>
    <StockTra>1</StockTra>
    <StockTyl>1</StockTyl>
  </PartInventory>
</ArrayOfPartInventory>

text/csv :

Id,StockDen,StockRom,StockIml,StockOlv,StockLaw,StockTra,StockTyl,StockGre,StockMxm,StockLeb,StockStb,StockTotal
sample string 1,1,1,1,1,1,1,1,1,1,1,1,2
sample string 1,1,1,1,1,1,1,1,1,1,1,1,2

text/tsv :

Id	StockDen	StockRom	StockIml	StockOlv	StockLaw	StockTra	StockTyl	StockGre	StockMxm	StockLeb	StockStb	StockTotal
sample string 1	1	1	1	1	1	1	1	1	1	1	1	2
sample string 1	1	1	1	1	1	1	1	1	1	1	1	2