POST api/InventoryLookupReport/results

Request Information

URI Parameters

None.

Body Parameters

InventoryLookupRequest

NameDescriptionTypeAdditional Information
SearchValue

string

None.

LastUpdatedStartDate

string

None.

LastUpdatedEndDate

string

None.

SearchType

ProductIdentifierType

None.

ExactValueQuery

boolean

None.

SiteID

integer

None.

LocaleId

integer

None.

IsEcommerce

boolean

None.

WarehouseCodes

Collection of string

None.

InventoryTypes

Collection of InventoryType

None.

UserName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SearchValue": "sample string 1",
  "LastUpdatedStartDate": "sample string 2",
  "LastUpdatedEndDate": "sample string 3",
  "SearchType": 1,
  "ExactValueQuery": true,
  "SiteID": 5,
  "LocaleId": 6,
  "IsEcommerce": true,
  "WarehouseCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "InventoryTypes": [
    1,
    1
  ],
  "UserName": "sample string 8"
}

application/xml, text/xml

Sample:
<InventoryLookupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.PIM.Domain.Models">
  <ExactValueQuery>true</ExactValueQuery>
  <InventoryTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts">
    <d2p1:InventoryType>InStock</d2p1:InventoryType>
    <d2p1:InventoryType>InStock</d2p1:InventoryType>
  </InventoryTypes>
  <IsEcommerce>true</IsEcommerce>
  <LastUpdatedEndDate>sample string 3</LastUpdatedEndDate>
  <LastUpdatedStartDate>sample string 2</LastUpdatedStartDate>
  <LocaleId>6</LocaleId>
  <SearchType>SKU</SearchType>
  <SearchValue>sample string 1</SearchValue>
  <SiteID>5</SiteID>
  <UserName>sample string 8</UserName>
  <WarehouseCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarehouseCodes>
</InventoryLookupRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

InventoryLookupResultResponse

NameDescriptionTypeAdditional Information
Result

InventoryLookupResultExternal

None.

ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "ErrorMessage": "sample string 1",
    "Model": {
      "Inventory": null,
      "InventoryTypeValues": {
        "sample string 1": 2,
        "sample string 3": 4
      },
      "ProductIdentifierTypeValues": {
        "sample string 1": 2,
        "sample string 3": 4
      },
      "CurrentSite": null,
      "Sites": null,
      "SearchValue": "sample string 1",
      "SearchType": 1,
      "ExactValueQuery": true,
      "SingleInventoryIdentifier": true,
      "SiteInventoryTypeList": null,
      "HasCommerceNonCommerceOptions": 4,
      "WarehouseCodes": [
        "sample string 1",
        "sample string 2"
      ],
      "InventoryTypes": [
        1,
        1
      ],
      "LastUpdatedStartDate": "sample string 5",
      "LastUpdatedStartDateDay": "sample string 6",
      "LastUpdatedStartDateMonth": "sample string 7",
      "LastUpdatedStartDateYear": "sample string 8",
      "LastUpdatedEndDate": "sample string 9",
      "LastUpdatedEndDateDay": "sample string 10",
      "LastUpdatedEndDateMonth": "sample string 11",
      "LastUpdatedEndDateYear": "sample string 12",
      "SiteInventoryEcommerce": [
        {
          "SiteID": 1,
          "InventoryType": 2
        },
        {
          "SiteID": 1,
          "InventoryType": 2
        }
      ],
      "EcommerceOptions": {
        "sample string 1": true,
        "sample string 3": true
      }
    },
    "InfoMessage": "sample string 2"
  },
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.