Inventory

Endpoint:

GET v2/Part/Inventory?PartId={PartId}&PartFamilyId={PartFamilyId}&BrandId={BrandId}&PartType={PartType}&AllWarehouses={AllWarehouses}&NewDate={NewDate}&ReferenceId={ReferenceId}

URI Parameters

NameDescriptionTypeAdditional information
PartId

string

None.

PartFamilyId

string

None.

BrandId

string

None.

PartType

PartTypes

None.

AllWarehouses

boolean

None.

NewDate

date

None.

ReferenceId

globally unique identifier

None.

Body Parameters

None.

Response Information

ResponseDataOfListOfPartInventory
NameDescriptionTypeAdditional information
Success

boolean

None.

ResponseId

globally unique identifier

None.

ReferenceId

globally unique identifier

None.

SuccessCount

integer

None.

Message

string

None.

ValidationResults

Validation

None.

QueryTime

string

None.

Data

Collection of PartInventory

None.

Response Examples

application/json, text/json :

{
  "Success": true,
  "ResponseId": "7379c36f-ca74-489b-b328-7ad4c0ec2b20",
  "ReferenceId": "51a56dc3-fbb0-4710-8a14-8ce5ee4f2bd0",
  "SuccessCount": 3,
  "Message": "sample string 4",
  "ValidationResults": {
    "IsValid": false,
    "Errors": [],
    "Warnings": [],
    "Info": [
      {
        "FieldName": "sample string 1",
        "FieldValue": "sample string 2",
        "Allow": true,
        "Message": "sample string 5",
        "Severity": 0,
        "Category": 0
      },
      {
        "FieldName": "sample string 1",
        "FieldValue": "sample string 2",
        "Allow": true,
        "Message": "sample string 5",
        "Severity": 0,
        "Category": 0
      }
    ]
  },
  "QueryTime": "sample string 5",
  "Data": [
    {
      "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 :

{"Success":true,"ResponseId":"7379c36f-ca74-489b-b328-7ad4c0ec2b20","ReferenceId":"51a56dc3-fbb0-4710-8a14-8ce5ee4f2bd0","SuccessCount":3,"Message":"sample string 4","ValidationResults":{"IsValid":false,"Errors":[],"Warnings":[],"Info":[{"FieldName":"sample string 1","FieldValue":"sample string 2","Allow":true,"Message":"sample string 5","Severity":0,"Category":0},{"FieldName":"sample string 1","FieldValue":"sample string 2","Allow":true,"Message":"sample string 5","Severity":0,"Category":0}]},"QueryTime":"sample string 5","Data":[{"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 :

<ResponseDataOfArrayOfPartInventoryuwLiWYs0 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models.Api.V2.Responses">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models">
    <d2p1:PartInventory>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:StockDen>1</d2p1:StockDen>
      <d2p1:StockGre>1</d2p1:StockGre>
      <d2p1:StockIml>1</d2p1:StockIml>
      <d2p1:StockLaw>1</d2p1:StockLaw>
      <d2p1:StockLeb>1</d2p1:StockLeb>
      <d2p1:StockMxm>1</d2p1:StockMxm>
      <d2p1:StockOlv>1</d2p1:StockOlv>
      <d2p1:StockRom>1</d2p1:StockRom>
      <d2p1:StockStb>1</d2p1:StockStb>
      <d2p1:StockTotal>2</d2p1:StockTotal>
      <d2p1:StockTra>1</d2p1:StockTra>
      <d2p1:StockTyl>1</d2p1:StockTyl>
    </d2p1:PartInventory>
    <d2p1:PartInventory>
      <d2p1:Id>sample string 1</d2p1:Id>
      <d2p1:StockDen>1</d2p1:StockDen>
      <d2p1:StockGre>1</d2p1:StockGre>
      <d2p1:StockIml>1</d2p1:StockIml>
      <d2p1:StockLaw>1</d2p1:StockLaw>
      <d2p1:StockLeb>1</d2p1:StockLeb>
      <d2p1:StockMxm>1</d2p1:StockMxm>
      <d2p1:StockOlv>1</d2p1:StockOlv>
      <d2p1:StockRom>1</d2p1:StockRom>
      <d2p1:StockStb>1</d2p1:StockStb>
      <d2p1:StockTotal>2</d2p1:StockTotal>
      <d2p1:StockTra>1</d2p1:StockTra>
      <d2p1:StockTyl>1</d2p1:StockTyl>
    </d2p1:PartInventory>
  </Data>
  <Message>sample string 4</Message>
  <QueryTime>sample string 5</QueryTime>
  <ReferenceId>51a56dc3-fbb0-4710-8a14-8ce5ee4f2bd0</ReferenceId>
  <ResponseId>7379c36f-ca74-489b-b328-7ad4c0ec2b20</ResponseId>
  <Success>true</Success>
  <SuccessCount>3</SuccessCount>
  <ValidationResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/Sunlight.Library.Models">
    <d2p1:Errors />
    <d2p1:Info>
      <d2p1:ValidationSummary>
        <d2p1:Allow>true</d2p1:Allow>
        <d2p1:Category>Missing</d2p1:Category>
        <d2p1:FieldName>sample string 1</d2p1:FieldName>
        <d2p1:FieldValue>sample string 2</d2p1:FieldValue>
        <d2p1:Severity>Info</d2p1:Severity>
      </d2p1:ValidationSummary>
      <d2p1:ValidationSummary>
        <d2p1:Allow>true</d2p1:Allow>
        <d2p1:Category>Missing</d2p1:Category>
        <d2p1:FieldName>sample string 1</d2p1:FieldName>
        <d2p1:FieldValue>sample string 2</d2p1:FieldValue>
        <d2p1:Severity>Info</d2p1:Severity>
      </d2p1:ValidationSummary>
    </d2p1:Info>
    <d2p1:Warnings />
  </ValidationResults>
</ResponseDataOfArrayOfPartInventoryuwLiWYs0>