POST api/InventoryLookupReport/allocation-orders

Request Information

URI Parameters

None.

Body Parameters

AllocationOrdersRequest

NameDescriptionTypeAdditional Information
DeckSKU

string

None.

WarehouseCode

string

None.

SiteIDs

Collection of integer

None.

TopN

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "DeckSKU": "sample string 1",
  "WarehouseCode": "sample string 2",
  "SiteIDs": [
    1,
    2
  ],
  "TopN": 3
}

application/xml, text/xml

Sample:
<AllocationOrdersRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.PIM.Domain.Models.API">
  <DeckSKU>sample string 1</DeckSKU>
  <SiteIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </SiteIDs>
  <TopN>3</TopN>
  <WarehouseCode>sample string 2</WarehouseCode>
</AllocationOrdersRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AllocationOrdersResponse

NameDescriptionTypeAdditional Information
Orders

Dictionary of string [key] and integer [value]

None.

TotalCount

integer

None.

ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Orders": {
    "sample string 1": 2,
    "sample string 3": 4
  },
  "TotalCount": 1,
  "ResponseCode": 0,
  "Message": "sample string 2",
  "CorrelationId": "sample string 3"
}

application/xml, text/xml

Sample:
<AllocationOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.PIM.Domain.Models.API">
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 3</CorrelationId>
  <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 2</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
  <Orders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>2</d2p1:Value>
    </d2p1:KeyValueOfstringint>
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>4</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </Orders>
  <TotalCount>1</TotalCount>
</AllocationOrdersResponse>