POST api/OmsReporting/customer-service/return-style

Request Information

URI Parameters

None.

Body Parameters

SiteStartEndDateRequest

NameDescriptionTypeAdditional Information
StartDate

date

None.

EndDate

date

None.

SiteId

integer

None.

SearchByInvoiceDate

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDate": "2025-12-20T13:03:14.2479766+00:00",
  "EndDate": "2025-12-20T13:03:14.2479766+00:00",
  "SiteId": 1,
  "SearchByInvoiceDate": true
}

application/xml, text/xml

Sample:
<SiteStartEndDateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models.API">
  <EndDate>2025-12-20T13:03:14.2479766+00:00</EndDate>
  <SearchByInvoiceDate>true</SearchByInvoiceDate>
  <SiteId>1</SiteId>
  <StartDate>2025-12-20T13:03:14.2479766+00:00</StartDate>
</SiteStartEndDateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReportingReturnStyleModelResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Model

ReportingReturnStyleModel

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2",
  "Model": {
    "CurrentSite": 1,
    "CurrentCulture": null,
    "ReportStartDate": "sample string 2",
    "ReportEndDate": "sample string 3",
    "TimezoneHourOffset": 4,
    "Sites": null,
    "LastStyle": "sample string 5",
    "ReturnReasons": null,
    "Results": null,
    "EnableExport": true
  }
}

application/xml, text/xml

Sample:
<ReportingReturnStyleModelResponse 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:CurrentCulture xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.Globalization" i:nil="true" />
    <d2p1:CurrentSite>1</d2p1:CurrentSite>
    <d2p1:EnableExport>true</d2p1:EnableExport>
    <d2p1:LastStyle>sample string 5</d2p1:LastStyle>
    <d2p1:ReportEndDate>sample string 3</d2p1:ReportEndDate>
    <d2p1:ReportStartDate>sample string 2</d2p1:ReportStartDate>
    <d2p1:Results xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:ReturnReasons xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <d2p1:TimezoneHourOffset>4</d2p1:TimezoneHourOffset>
  </Model>
  <ResponseCode>Success</ResponseCode>
</ReportingReturnStyleModelResponse>