GET api/inventory/{id1}/{id2}/{option}

Returns inventory base on the following option values: "bycodes" - WarehouseCode (id1), PartCode (id2), this is also the default if option is left out "bywarehouse" - WarehouseCode (id1), id2 will be ignored but needs a place holder (use zero), "bypart" = id1 will be ignored but needs a place holder (use zero), PartCode (id2)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id1

WarehouseCode from the IN_Warehouse table

string

Required

id2

PartCode from the IN_Part table

string

Required

option

bycodes, bywarehouse or bypart

string

Default value is bycodes

Body Parameters

None.

Response Information

Resource Description

Collection of Inventory
NameDescriptionTypeAdditional information
InventoryId

Key from IN_Inventory

integer

None.

WarehouseId

Foreign key from IN_Warehouse

integer

None.

WarehouseCode

Abbreviated Warehouse code; defaults to N/A if not supplied

string

String length: inclusive between 0 and 25

PartId

Foreign key from IN_Part

integer

None.

PartCode

Abbreviated PartCode, from INPart table

string

String length: inclusive between 0 and 25

PartDescription

Description from IN_Part

string

String length: inclusive between 0 and 25

PartDetail

Detail from IN_Part

string

String length: inclusive between 0 and 25

ProductLineCode

ProductLine for Part

string

None.

OnHandNew

Number of now onhand

integer

None.

OnHandUsed

Number of used onhand

integer

None.

CommittedQuantity

integer

None.

OnOrderQuantity

integer

None.

OutForRepairQty

integer

None.

MinimumQty

integer

None.

MaximumQty

integer

None.

ValueOnHand

decimal number

None.

Location1

string

None.

Location2

string

None.

Location3

string

None.

StandardCost

decimal number

None.

PendingTransferIn

integer

None.

PendingTransferOut

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "InventoryId": 1,
    "WarehouseId": 2,
    "WarehouseCode": "sample string 3",
    "PartId": 4,
    "PartCode": "sample string 5",
    "PartDescription": "sample string 6",
    "PartDetail": "sample string 7",
    "ProductLineCode": "sample string 8",
    "OnHandNew": 1,
    "OnHandUsed": 1,
    "CommittedQuantity": 1,
    "OnOrderQuantity": 1,
    "OutForRepairQty": 1,
    "MinimumQty": 1,
    "MaximumQty": 1,
    "ValueOnHand": 1.0,
    "Location1": "sample string 9",
    "Location2": "sample string 10",
    "Location3": "sample string 11",
    "StandardCost": 12.0,
    "PendingTransferIn": 13,
    "PendingTransferOut": 14
  },
  {
    "InventoryId": 1,
    "WarehouseId": 2,
    "WarehouseCode": "sample string 3",
    "PartId": 4,
    "PartCode": "sample string 5",
    "PartDescription": "sample string 6",
    "PartDetail": "sample string 7",
    "ProductLineCode": "sample string 8",
    "OnHandNew": 1,
    "OnHandUsed": 1,
    "CommittedQuantity": 1,
    "OnOrderQuantity": 1,
    "OutForRepairQty": 1,
    "MinimumQty": 1,
    "MaximumQty": 1,
    "ValueOnHand": 1.0,
    "Location1": "sample string 9",
    "Location2": "sample string 10",
    "Location3": "sample string 11",
    "StandardCost": 12.0,
    "PendingTransferIn": 13,
    "PendingTransferOut": 14
  }
]

application/xml, text/xml

Sample:
<ArrayOfInventory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <Inventory>
    <CommittedQuantity>1</CommittedQuantity>
    <InventoryId>1</InventoryId>
    <Location1>sample string 9</Location1>
    <Location2>sample string 10</Location2>
    <Location3>sample string 11</Location3>
    <MaximumQty>1</MaximumQty>
    <MinimumQty>1</MinimumQty>
    <OnHandNew>1</OnHandNew>
    <OnHandUsed>1</OnHandUsed>
    <OnOrderQuantity>1</OnOrderQuantity>
    <OutForRepairQty>1</OutForRepairQty>
    <PartCode>sample string 5</PartCode>
    <PartDescription>sample string 6</PartDescription>
    <PartDetail>sample string 7</PartDetail>
    <PartId>4</PartId>
    <PendingTransferIn>13</PendingTransferIn>
    <PendingTransferOut>14</PendingTransferOut>
    <ProductLineCode>sample string 8</ProductLineCode>
    <StandardCost>12</StandardCost>
    <ValueOnHand>1</ValueOnHand>
    <WarehouseCode>sample string 3</WarehouseCode>
    <WarehouseId>2</WarehouseId>
  </Inventory>
  <Inventory>
    <CommittedQuantity>1</CommittedQuantity>
    <InventoryId>1</InventoryId>
    <Location1>sample string 9</Location1>
    <Location2>sample string 10</Location2>
    <Location3>sample string 11</Location3>
    <MaximumQty>1</MaximumQty>
    <MinimumQty>1</MinimumQty>
    <OnHandNew>1</OnHandNew>
    <OnHandUsed>1</OnHandUsed>
    <OnOrderQuantity>1</OnOrderQuantity>
    <OutForRepairQty>1</OutForRepairQty>
    <PartCode>sample string 5</PartCode>
    <PartDescription>sample string 6</PartDescription>
    <PartDetail>sample string 7</PartDetail>
    <PartId>4</PartId>
    <PendingTransferIn>13</PendingTransferIn>
    <PendingTransferOut>14</PendingTransferOut>
    <ProductLineCode>sample string 8</ProductLineCode>
    <StandardCost>12</StandardCost>
    <ValueOnHand>1</ValueOnHand>
    <WarehouseCode>sample string 3</WarehouseCode>
    <WarehouseId>2</WarehouseId>
  </Inventory>
</ArrayOfInventory>