POST api/PimInventoryLookup

Perform inventory lookup for specified items passed in to API

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional Information
Items	Items to lookup inventory data for.	Collection of InventoryLookupItemDetails	None.
ExcludeNeedsWarehouseAllocation		boolean	None.
SiteCode		string	None.
VerificationKey		string	None.
TimestampUTC		string	None.
ResponseCallbackUri		string	None.
APIUsername		string	None.
IDToken		string	None.
UserAccount		Account	None.
UserdID		integer	None.
IsValidJwtToken		boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "InventoryFeedName": "sample string 1",
      "SiteCode": "sample string 2",
      "UPC": "sample string 3",
      "EAN": "sample string 4",
      "JAN": "sample string 5",
      "SKU": "sample string 6",
      "NodeCodes": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "InventoryFeedName": "sample string 1",
      "SiteCode": "sample string 2",
      "UPC": "sample string 3",
      "EAN": "sample string 4",
      "JAN": "sample string 5",
      "SKU": "sample string 6",
      "NodeCodes": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ],
  "ExcludeNeedsWarehouseAllocation": true,
  "SiteCode": "sample string 2",
  "VerificationKey": "sample string 3",
  "TimestampUTC": "sample string 4",
  "ResponseCallbackUri": "sample string 5",
  "APIUsername": "sample string 6",
  "IDToken": "sample string 7",
  "UserAccount": {
    "UserID": 1,
    "Username": "sample string 2",
    "CreateDate": "2025-12-19T10:31:46.3010973+00:00",
    "ConfirmationToken": "sample string 4",
    "IsConfirmed": true,
    "LastPasswordFailureDate": "2025-12-19T10:31:46.3010973+00:00",
    "PasswordFailuresSinceLastSuccess": 7,
    "Password": "sample string 8",
    "PasswordChangedDate": "2025-12-19T10:31:46.3010973+00:00",
    "PasswordSalt": "sample string 10",
    "PasswordVerificationToken": "sample string 11",
    "PasswordVerificationTokenExpirationDate": "2025-12-19T10:31:46.3010973+00:00",
    "SecurityQuestion": "sample string 13",
    "SecurityAnswer": "sample string 14",
    "SecurityFailuresSinceLastSuccess": 15,
    "LastSecurityFailureDate": "2025-12-19T10:31:46.3010973+00:00",
    "IsAuthorized": true,
    "IsArchived": true,
    "LoginToken": "sample string 19",
    "LoginTokenExpirationDate": "2025-12-19T10:31:46.3010973+00:00",
    "ApiKey": "sample string 21",
    "FederatedID": "sample string 22",
    "FirstName": "sample string 23",
    "LastName": "sample string 24",
    "FullName": "sample string 23sample string 24"
  },
  "UserdID": 8,
  "IsValidJwtToken": true
}

application/xml, text/xml

Sample:

<PimInventoryLookupController.InventoryLookupApiRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Controllers.PIM">
  <APIUsername xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 6</APIUsername>
  <IDToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 7</IDToken>
  <IsValidJwtToken xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">true</IsValidJwtToken>
  <ResponseCallbackUri xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 5</ResponseCallbackUri>
  <SiteCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 2</SiteCode>
  <TimestampUTC xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 4</TimestampUTC>
  <UserAccount xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.Core.Domain.Membership.Models" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">
    <d2p1:ApiKey>sample string 21</d2p1:ApiKey>
    <d2p1:ConfirmationToken>sample string 4</d2p1:ConfirmationToken>
    <d2p1:CreateDate>2025-12-19T10:31:46.3010973+00:00</d2p1:CreateDate>
    <d2p1:FederatedID>sample string 22</d2p1:FederatedID>
    <d2p1:FirstName>sample string 23</d2p1:FirstName>
    <d2p1:IsArchived>true</d2p1:IsArchived>
    <d2p1:IsAuthorized>true</d2p1:IsAuthorized>
    <d2p1:IsConfirmed>true</d2p1:IsConfirmed>
    <d2p1:LastName>sample string 24</d2p1:LastName>
    <d2p1:LastPasswordFailureDate>2025-12-19T10:31:46.3010973+00:00</d2p1:LastPasswordFailureDate>
    <d2p1:LastSecurityFailureDate>2025-12-19T10:31:46.3010973+00:00</d2p1:LastSecurityFailureDate>
    <d2p1:LoginToken>sample string 19</d2p1:LoginToken>
    <d2p1:LoginTokenExpirationDate>2025-12-19T10:31:46.3010973+00:00</d2p1:LoginTokenExpirationDate>
    <d2p1:Password>sample string 8</d2p1:Password>
    <d2p1:PasswordChangedDate>2025-12-19T10:31:46.3010973+00:00</d2p1:PasswordChangedDate>
    <d2p1:PasswordFailuresSinceLastSuccess>7</d2p1:PasswordFailuresSinceLastSuccess>
    <d2p1:PasswordSalt>sample string 10</d2p1:PasswordSalt>
    <d2p1:PasswordVerificationToken>sample string 11</d2p1:PasswordVerificationToken>
    <d2p1:PasswordVerificationTokenExpirationDate>2025-12-19T10:31:46.3010973+00:00</d2p1:PasswordVerificationTokenExpirationDate>
    <d2p1:SecurityAnswer>sample string 14</d2p1:SecurityAnswer>
    <d2p1:SecurityFailuresSinceLastSuccess>15</d2p1:SecurityFailuresSinceLastSuccess>
    <d2p1:SecurityQuestion>sample string 13</d2p1:SecurityQuestion>
    <d2p1:UserID>1</d2p1:UserID>
    <d2p1:Username>sample string 2</d2p1:Username>
  </UserAccount>
  <UserdID xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">8</UserdID>
  <VerificationKey xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Domain">sample string 3</VerificationKey>
  <ExcludeNeedsWarehouseAllocation>true</ExcludeNeedsWarehouseAllocation>
  <Items>
    <PimInventoryLookupController.InventoryLookupItemDetails>
      <EAN>sample string 4</EAN>
      <InventoryFeedName>sample string 1</InventoryFeedName>
      <JAN>sample string 5</JAN>
      <NodeCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </NodeCodes>
      <SKU>sample string 6</SKU>
      <SiteCode>sample string 2</SiteCode>
      <UPC>sample string 3</UPC>
    </PimInventoryLookupController.InventoryLookupItemDetails>
    <PimInventoryLookupController.InventoryLookupItemDetails>
      <EAN>sample string 4</EAN>
      <InventoryFeedName>sample string 1</InventoryFeedName>
      <JAN>sample string 5</JAN>
      <NodeCodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </NodeCodes>
      <SKU>sample string 6</SKU>
      <SiteCode>sample string 2</SiteCode>
      <UPC>sample string 3</UPC>
    </PimInventoryLookupController.InventoryLookupItemDetails>
  </Items>
</PimInventoryLookupController.InventoryLookupApiRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InventoryLookupResponse

Name	Description	Type	Additional Information
Items	Item level detail of inventory lookup	Collection of InventoryLookupItemResponse	None.
ResponseCode	Overall response code for API	APIResponseCodes	None.
Message	Response message used in case of an exception	string	None.
CorrelationId		string	None.

Response Formats

application/json, text/json

Sample:

{
  "Items": [
    {
      "TotalAvailableQuantity": 1,
      "TotalAvailablePreorderQuantity": 2,
      "DeckSKU": "sample string 3",
      "GTIN": "sample string 4",
      "Details": [
        {
          "InventoryFeedName": "sample string 1",
          "ProtectedQuantity": 2,
          "SafetyQuantity": 3,
          "TotalQuantity": 4,
          "InventoryAllocation": 5,
          "WarehouseCode": "sample string 6",
          "PreBackOrderQuantity": 7,
          "PreBackOrderInventoryAllocation": 8,
          "InStockDate": "2025-12-19T10:31:46.3166551+00:00"
        },
        {
          "InventoryFeedName": "sample string 1",
          "ProtectedQuantity": 2,
          "SafetyQuantity": 3,
          "TotalQuantity": 4,
          "InventoryAllocation": 5,
          "WarehouseCode": "sample string 6",
          "PreBackOrderQuantity": 7,
          "PreBackOrderInventoryAllocation": 8,
          "InStockDate": "2025-12-19T10:31:46.3166551+00:00"
        }
      ]
    },
    {
      "TotalAvailableQuantity": 1,
      "TotalAvailablePreorderQuantity": 2,
      "DeckSKU": "sample string 3",
      "GTIN": "sample string 4",
      "Details": [
        {
          "InventoryFeedName": "sample string 1",
          "ProtectedQuantity": 2,
          "SafetyQuantity": 3,
          "TotalQuantity": 4,
          "InventoryAllocation": 5,
          "WarehouseCode": "sample string 6",
          "PreBackOrderQuantity": 7,
          "PreBackOrderInventoryAllocation": 8,
          "InStockDate": "2025-12-19T10:31:46.3166551+00:00"
        },
        {
          "InventoryFeedName": "sample string 1",
          "ProtectedQuantity": 2,
          "SafetyQuantity": 3,
          "TotalQuantity": 4,
          "InventoryAllocation": 5,
          "WarehouseCode": "sample string 6",
          "PreBackOrderQuantity": 7,
          "PreBackOrderInventoryAllocation": 8,
          "InStockDate": "2025-12-19T10:31:46.3166551+00:00"
        }
      ]
    }
  ],
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:

<PimInventoryLookupController.InventoryLookupResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.WebApi.Controllers.PIM">
  <CorrelationId>sample string 2</CorrelationId>
  <Items>
    <PimInventoryLookupController.InventoryLookupItemResponse>
      <DeckSKU>sample string 3</DeckSKU>
      <Details>
        <PimInventoryLookupController.InventoryLookupItemResponseDetail>
          <InStockDate>2025-12-19T10:31:46.3166551+00:00</InStockDate>
          <InventoryAllocation>5</InventoryAllocation>
          <InventoryFeedName>sample string 1</InventoryFeedName>
          <NeedsWarehouseInventoryAllocation>9</NeedsWarehouseInventoryAllocation>
          <PreBackOrderInventoryAllocation>8</PreBackOrderInventoryAllocation>
          <PreBackOrderQuantity>7</PreBackOrderQuantity>
          <ProtectedQuantity>2</ProtectedQuantity>
          <SafetyQuantity>3</SafetyQuantity>
          <TotalQuantity>4</TotalQuantity>
          <WarehouseCode>sample string 6</WarehouseCode>
        </PimInventoryLookupController.InventoryLookupItemResponseDetail>
        <PimInventoryLookupController.InventoryLookupItemResponseDetail>
          <InStockDate>2025-12-19T10:31:46.3166551+00:00</InStockDate>
          <InventoryAllocation>5</InventoryAllocation>
          <InventoryFeedName>sample string 1</InventoryFeedName>
          <NeedsWarehouseInventoryAllocation>9</NeedsWarehouseInventoryAllocation>
          <PreBackOrderInventoryAllocation>8</PreBackOrderInventoryAllocation>
          <PreBackOrderQuantity>7</PreBackOrderQuantity>
          <ProtectedQuantity>2</ProtectedQuantity>
          <SafetyQuantity>3</SafetyQuantity>
          <TotalQuantity>4</TotalQuantity>
          <WarehouseCode>sample string 6</WarehouseCode>
        </PimInventoryLookupController.InventoryLookupItemResponseDetail>
      </Details>
      <ExcludeNeedsWarehouseAllocation>true</ExcludeNeedsWarehouseAllocation>
      <GTIN>sample string 4</GTIN>
      <NeedsWarehouseInventoryAllocation>5</NeedsWarehouseInventoryAllocation>
      <TotalAvailablePreorderQuantity>2</TotalAvailablePreorderQuantity>
      <TotalAvailableQuantity>1</TotalAvailableQuantity>
    </PimInventoryLookupController.InventoryLookupItemResponse>
    <PimInventoryLookupController.InventoryLookupItemResponse>
      <DeckSKU>sample string 3</DeckSKU>
      <Details>
        <PimInventoryLookupController.InventoryLookupItemResponseDetail>
          <InStockDate>2025-12-19T10:31:46.3166551+00:00</InStockDate>
          <InventoryAllocation>5</InventoryAllocation>
          <InventoryFeedName>sample string 1</InventoryFeedName>
          <NeedsWarehouseInventoryAllocation>9</NeedsWarehouseInventoryAllocation>
          <PreBackOrderInventoryAllocation>8</PreBackOrderInventoryAllocation>
          <PreBackOrderQuantity>7</PreBackOrderQuantity>
          <ProtectedQuantity>2</ProtectedQuantity>
          <SafetyQuantity>3</SafetyQuantity>
          <TotalQuantity>4</TotalQuantity>
          <WarehouseCode>sample string 6</WarehouseCode>
        </PimInventoryLookupController.InventoryLookupItemResponseDetail>
        <PimInventoryLookupController.InventoryLookupItemResponseDetail>
          <InStockDate>2025-12-19T10:31:46.3166551+00:00</InStockDate>
          <InventoryAllocation>5</InventoryAllocation>
          <InventoryFeedName>sample string 1</InventoryFeedName>
          <NeedsWarehouseInventoryAllocation>9</NeedsWarehouseInventoryAllocation>
          <PreBackOrderInventoryAllocation>8</PreBackOrderInventoryAllocation>
          <PreBackOrderQuantity>7</PreBackOrderQuantity>
          <ProtectedQuantity>2</ProtectedQuantity>
          <SafetyQuantity>3</SafetyQuantity>
          <TotalQuantity>4</TotalQuantity>
          <WarehouseCode>sample string 6</WarehouseCode>
        </PimInventoryLookupController.InventoryLookupItemResponseDetail>
      </Details>
      <ExcludeNeedsWarehouseAllocation>true</ExcludeNeedsWarehouseAllocation>
      <GTIN>sample string 4</GTIN>
      <NeedsWarehouseInventoryAllocation>5</NeedsWarehouseInventoryAllocation>
      <TotalAvailablePreorderQuantity>2</TotalAvailablePreorderQuantity>
      <TotalAvailableQuantity>1</TotalAvailableQuantity>
    </PimInventoryLookupController.InventoryLookupItemResponse>
  </Items>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</PimInventoryLookupController.InventoryLookupResponse>