POST api/OmsReporting/backorder-dashboard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional Information
SiteId	integer	None.
BucketType	AgingBucketType	None.
MaxBuckets	integer	None.
Refresh	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "BucketType": 1,
  "MaxBuckets": 2,
  "Refresh": true
}

application/xml, text/xml

Sample:

<BackorderDashboardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <BucketType>Day</BucketType>
  <MaxBuckets>2</MaxBuckets>
  <Refresh>true</Refresh>
  <SiteId>1</SiteId>
</BackorderDashboardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BackorderDashboardModelResponse

Name	Type	Additional Information
ResponseCode	APIResponseCodes	None.
Message	string	None.
CorrelationId	string	None.
Model	BackorderDashboardModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "CacheRefreshTimeUTC": "2026-08-04T14:56:50.3331837+00:00",
    "TotalBackorders": 2,
    "AggregatedData": null,
    "CurrentSiteID": 3,
    "BucketType": 1
  }
}

application/xml, text/xml

Sample:

<BackorderDashboardModelResponse 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:AggregatedData xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:BucketType>Day</d2p1:BucketType>
    <d2p1:CacheRefreshTimeUTC>2026-08-04T14:56:50.3331837+00:00</d2p1:CacheRefreshTimeUTC>
    <d2p1:CurrentSiteID>3</d2p1:CurrentSiteID>
    <d2p1:TotalBackorders>2</d2p1:TotalBackorders>
  </Model>
  <ResponseCode>Success</ResponseCode>
</BackorderDashboardModelResponse>