POST api/OmsOrderRoutingSummary/order-status-visualization

Request Information

URI Parameters

None.

Body Parameters

OrderItemStatusVisualizationSearchRequest

NameDescriptionTypeAdditional Information
SiteId

integer

None.

DeliveryTypeId

integer

None.

ItemTypeId

integer

None.

StartingOrderItemStatusId

integer

None.

LocaleId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteId": 1,
  "DeliveryTypeId": 2,
  "ItemTypeId": 3,
  "StartingOrderItemStatusId": 4,
  "LocaleId": 5
}

application/xml, text/xml

Sample:
<OrderItemStatusVisualizationSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <DeliveryTypeId>2</DeliveryTypeId>
  <ItemTypeId>3</ItemTypeId>
  <LocaleId>5</LocaleId>
  <SiteId>1</SiteId>
  <StartingOrderItemStatusId>4</StartingOrderItemStatusId>
</OrderItemStatusVisualizationSearchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderItemStatusVisualizationResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Model

OrderItemStatusVisualizationModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "Roots": null
  }
}

application/xml, text/xml

Sample:
<OrderItemStatusVisualizationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <Model xmlns:d2p1="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
    <d2p1:Roots i:nil="true" />
  </Model>
  <ResponseCode>Success</ResponseCode>
</OrderItemStatusVisualizationResponse>