POST Reports/SalesAmountByCustomer

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AmountFrom	decimal number	None.
AmountTo	decimal number	None.
Resolution	Period	None.
Step	integer	None.
DateFrom	date	None.
DateUntil	date	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AmountFrom": 1.0,
  "AmountTo": 1.0,
  "Resolution": 0,
  "Step": 2,
  "DateFrom": "2025-12-06T09:16:20.9386656+01:00",
  "DateUntil": "2025-12-06T09:16:20.9386656+01:00",
  "Lang": "sample string 5",
  "StoreID": 6
}

application/xml, text/xml

Sample:

<GetSalesAmountByCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Reports">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 5</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">6</StoreID>
  <DateFrom xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">2025-12-06T09:16:20.9386656+01:00</DateFrom>
  <DateUntil xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">2025-12-06T09:16:20.9386656+01:00</DateUntil>
  <AmountFrom>1</AmountFrom>
  <AmountTo>1</AmountTo>
  <Resolution>Hour</Resolution>
  <Step>2</Step>
</GetSalesAmountByCustomerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SalesAmountByCustomer

Name	Description	Type	Additional information
Sales		Collection of SalesAmounts	None.

Response Formats

application/json, text/json

Sample:

{
  "Sales": [
    {
      "CustomerID": "sample string 1",
      "Contact": {
        "ID": 1,
        "IsIntraCommunitaryOperator": true,
        "Alias": "sample string 3",
        "Name": "sample string 4",
        "Surnames": "sample string 5",
        "VatIdentifier": "sample string 6",
        "Email": "sample string 7",
        "WebURL": "sample string 8",
        "Phone": "sample string 9",
        "Addressee": "sample string 10",
        "Street": "sample string 11",
        "PostalCode": "sample string 12",
        "Place": {
          "ID": 1,
          "Name": "sample string 2",
          "PostalCode": "sample string 3",
          "LocalityID": 4
        },
        "Country": {
          "ID": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      },
      "Amounts": [
        {
          "Day": 1,
          "Month": 2,
          "Year": 3,
          "Amount": 4.0,
          "OrdersCount": 5
        },
        {
          "Day": 1,
          "Month": 2,
          "Year": 3,
          "Amount": 4.0,
          "OrdersCount": 5
        }
      ],
      "TotalAmount": 2.0,
      "TotalOrderCount": 3
    },
    {
      "CustomerID": "sample string 1",
      "Contact": {
        "ID": 1,
        "IsIntraCommunitaryOperator": true,
        "Alias": "sample string 3",
        "Name": "sample string 4",
        "Surnames": "sample string 5",
        "VatIdentifier": "sample string 6",
        "Email": "sample string 7",
        "WebURL": "sample string 8",
        "Phone": "sample string 9",
        "Addressee": "sample string 10",
        "Street": "sample string 11",
        "PostalCode": "sample string 12",
        "Place": {
          "ID": 1,
          "Name": "sample string 2",
          "PostalCode": "sample string 3",
          "LocalityID": 4
        },
        "Country": {
          "ID": 1,
          "Name": "sample string 2",
          "Code": "sample string 3"
        }
      },
      "Amounts": [
        {
          "Day": 1,
          "Month": 2,
          "Year": 3,
          "Amount": 4.0,
          "OrdersCount": 5
        },
        {
          "Day": 1,
          "Month": 2,
          "Year": 3,
          "Amount": 4.0,
          "OrdersCount": 5
        }
      ],
      "TotalAmount": 2.0,
      "TotalOrderCount": 3
    }
  ]
}

application/xml, text/xml

Sample:

<SalesAmountByCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Reports">
  <Sales>
    <SalesAmounts>
      <Amounts>
        <AmountTick>
          <Amount>4</Amount>
          <Day>1</Day>
          <Month>2</Month>
          <OrdersCount>5</OrdersCount>
          <Year>3</Year>
        </AmountTick>
        <AmountTick>
          <Amount>4</Amount>
          <Day>1</Day>
          <Month>2</Month>
          <OrdersCount>5</OrdersCount>
          <Year>3</Year>
        </AmountTick>
      </Amounts>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
        <Addressee xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 10</Addressee>
        <Country xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
          <d5p1:Code>sample string 3</d5p1:Code>
          <d5p1:ID>1</d5p1:ID>
          <d5p1:Name>sample string 2</d5p1:Name>
        </Country>
        <Place xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
          <d5p1:ID>1</d5p1:ID>
          <d5p1:LocalityID>4</d5p1:LocalityID>
          <d5p1:Name>sample string 2</d5p1:Name>
          <d5p1:PostalCode>sample string 3</d5p1:PostalCode>
        </Place>
        <PostalCode xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 12</PostalCode>
        <Street xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 11</Street>
        <Email xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 7</Email>
        <Phone xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 9</Phone>
        <WebURL xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 8</WebURL>
        <Alias xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 3</Alias>
        <Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 4</Name>
        <Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 5</Surnames>
        <VatIdentifier xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 6</VatIdentifier>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsIntraCommunitaryOperator>true</d4p1:IsIntraCommunitaryOperator>
      </Contact>
      <CustomerID>sample string 1</CustomerID>
      <TotalAmount>2</TotalAmount>
      <TotalOrderCount>3</TotalOrderCount>
    </SalesAmounts>
    <SalesAmounts>
      <Amounts>
        <AmountTick>
          <Amount>4</Amount>
          <Day>1</Day>
          <Month>2</Month>
          <OrdersCount>5</OrdersCount>
          <Year>3</Year>
        </AmountTick>
        <AmountTick>
          <Amount>4</Amount>
          <Day>1</Day>
          <Month>2</Month>
          <OrdersCount>5</OrdersCount>
          <Year>3</Year>
        </AmountTick>
      </Amounts>
      <Contact xmlns:d4p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
        <Addressee xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 10</Addressee>
        <Country xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
          <d5p1:Code>sample string 3</d5p1:Code>
          <d5p1:ID>1</d5p1:ID>
          <d5p1:Name>sample string 2</d5p1:Name>
        </Country>
        <Place xmlns:d5p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Location" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">
          <d5p1:ID>1</d5p1:ID>
          <d5p1:LocalityID>4</d5p1:LocalityID>
          <d5p1:Name>sample string 2</d5p1:Name>
          <d5p1:PostalCode>sample string 3</d5p1:PostalCode>
        </Place>
        <PostalCode xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 12</PostalCode>
        <Street xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 11</Street>
        <Email xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 7</Email>
        <Phone xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 9</Phone>
        <WebURL xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 8</WebURL>
        <Alias xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 3</Alias>
        <Name xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 4</Name>
        <Surnames xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 5</Surnames>
        <VatIdentifier xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Base">sample string 6</VatIdentifier>
        <d4p1:ID>1</d4p1:ID>
        <d4p1:IsIntraCommunitaryOperator>true</d4p1:IsIntraCommunitaryOperator>
      </Contact>
      <CustomerID>sample string 1</CustomerID>
      <TotalAmount>2</TotalAmount>
      <TotalOrderCount>3</TotalOrderCount>
    </SalesAmounts>
  </Sales>
</SalesAmountByCustomer>