GET
api/v1/get-all-zipcode-order-summary?clientId={clientId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId | integer |
Required |
Response Information
Description:
Return type: ZipCodeOrderSummaryResponse
Response Formats
application/json, text/json
{
"Summary": [
{
"ZipCode": "sample string 1",
"TotalOrderAmount": 2.0,
"CurrencySymbol": "sample string 3"
},
{
"ZipCode": "sample string 1",
"TotalOrderAmount": 2.0,
"CurrencySymbol": "sample string 3"
}
],
"TopNames": [
{
"ZipCode": "sample string 1",
"FirstName": "sample string 2",
"TotalOrderAmount": 3.0
},
{
"ZipCode": "sample string 1",
"FirstName": "sample string 2",
"TotalOrderAmount": 3.0
}
]
}
text/html
{"Summary":[{"ZipCode":"sample string 1","TotalOrderAmount":2.0,"CurrencySymbol":"sample string 3"},{"ZipCode":"sample string 1","TotalOrderAmount":2.0,"CurrencySymbol":"sample string 3"}],"TopNames":[{"ZipCode":"sample string 1","FirstName":"sample string 2","TotalOrderAmount":3.0},{"ZipCode":"sample string 1","FirstName":"sample string 2","TotalOrderAmount":3.0}]}
application/xml, text/xml
<ZipCodeOrderSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FDCMSAdminAPI.Models.Report">
<Summary>
<ZipCodeOrderSummary>
<CurrencySymbol>sample string 3</CurrencySymbol>
<TotalOrderAmount>2</TotalOrderAmount>
<ZipCode>sample string 1</ZipCode>
</ZipCodeOrderSummary>
<ZipCodeOrderSummary>
<CurrencySymbol>sample string 3</CurrencySymbol>
<TotalOrderAmount>2</TotalOrderAmount>
<ZipCode>sample string 1</ZipCode>
</ZipCodeOrderSummary>
</Summary>
<TopNames>
<ZipCodeTopNames>
<FirstName>sample string 2</FirstName>
<TotalOrderAmount>3</TotalOrderAmount>
<ZipCode>sample string 1</ZipCode>
</ZipCodeTopNames>
<ZipCodeTopNames>
<FirstName>sample string 2</FirstName>
<TotalOrderAmount>3</TotalOrderAmount>
<ZipCode>sample string 1</ZipCode>
</ZipCodeTopNames>
</TopNames>
</ZipCodeOrderSummaryResponse>