POST api/OmsReporting/financials/order-gmv
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| SiteId | integer |
None. |
|
| SearchByInvoiceDate | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"StartDate": "2025-12-20T18:41:55.9829601+00:00",
"EndDate": "2025-12-20T18:41:55.9829601+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-20T18:41:55.9829601+00:00</EndDate> <SearchByInvoiceDate>true</SearchByInvoiceDate> <SiteId>1</SiteId> <StartDate>2025-12-20T18:41:55.9829601+00:00</StartDate> </SiteStartEndDateRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
| Name | Description | Type | Additional Information |
|---|---|---|---|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
|
| CorrelationId | string |
None. |
|
| Model | OrderGmvReportModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 0,
"Message": "sample string 1",
"CorrelationId": "sample string 2",
"Model": {
"Data": null,
"StartDateLocal": "sample string 1",
"EndDateLocal": "sample string 2",
"SiteTimeZone": "sample string 3",
"SiteId": 4,
"Sites": null,
"CurrentSite": null,
"EnableExport": true,
"ErrorMessages": [
"sample string 1",
"sample string 2"
],
"ValidationError": true
}
}
application/xml, text/xml
Sample:
<OrderGmvReportModelResponse 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:CurrentSite i:nil="true" />
<d2p1:Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<d2p1:EnableExport>true</d2p1:EnableExport>
<d2p1:EndDateLocal>sample string 2</d2p1:EndDateLocal>
<d2p1:ErrorMessages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</d2p1:ErrorMessages>
<d2p1:SiteId>4</d2p1:SiteId>
<d2p1:SiteTimeZone>sample string 3</d2p1:SiteTimeZone>
<d2p1:Sites xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
<d2p1:StartDateLocal>sample string 1</d2p1:StartDateLocal>
<d2p1:ValidationError>true</d2p1:ValidationError>
</Model>
<ResponseCode>Success</ResponseCode>
</OrderGmvReportModelResponse>