POST Stats/SalesHeatmap

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DateFrom	date	None.
DateUntil	date	None.
Filter	Filter	None.
Range	AdminFilterRange	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetSalesHeatmapResponse

Name	Type	Additional information
DateFrom	date	None.
DateUntil	date	None.
Week	Collection of HourStep	None.

Response Formats

application/json, text/json

Sample:

{
  "DateFrom": "2025-12-06T05:40:35.2730313+01:00",
  "DateUntil": "2025-12-06T05:40:35.2730313+01:00",
  "Week": [
    {
      "name": "sample string 1",
      "data": [
        {
          "x": "sample string 1",
          "y": 2.0
        },
        {
          "x": "sample string 1",
          "y": 2.0
        }
      ]
    },
    {
      "name": "sample string 1",
      "data": [
        {
          "x": "sample string 1",
          "y": 2.0
        },
        {
          "x": "sample string 1",
          "y": 2.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<GetSalesHeatmapResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Stats">
  <DateFrom>2025-12-06T05:40:35.2730313+01:00</DateFrom>
  <DateUntil>2025-12-06T05:40:35.2730313+01:00</DateUntil>
  <Week>
    <HourStep>
      <data>
        <xy>
          <x>sample string 1</x>
          <y>2</y>
        </xy>
        <xy>
          <x>sample string 1</x>
          <y>2</y>
        </xy>
      </data>
      <name>sample string 1</name>
    </HourStep>
    <HourStep>
      <data>
        <xy>
          <x>sample string 1</x>
          <y>2</y>
        </xy>
        <xy>
          <x>sample string 1</x>
          <y>2</y>
        </xy>
      </data>
      <name>sample string 1</name>
    </HourStep>
  </Week>
</GetSalesHeatmapResponse>