POST Stats/Stats

Get Statistics for the Dashboard

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Lang": "sample string 1",
  "StoreID": 2
}

application/xml, text/xml

Sample:

<BaseRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">
  <Lang>sample string 1</Lang>
  <StoreID>2</StoreID>
</BaseRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Stats

Name	Type	Additional information
OrderStats	Collection of OrderStatusWithPaymentMeans	None.
CustomerStats	Collection of Concept	None.
ShippingStats	Collection of Concept	None.
ProductStats	integer	None.
ClassificationStats	integer	None.
CustomerQueryStats	integer	None.
UnreadCustomerQueryStats	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderStats": [
    {
      "StatusID": 1,
      "TypeName": "sample string 2",
      "Count": 3,
      "ByPaymentMeans": [
        {
          "MeansID": 1,
          "Name": "sample string 2",
          "CashOnDelivery": true,
          "QuickPayment": true,
          "PrePayment": true,
          "BankTransfer": true,
          "Count": 7
        },
        {
          "MeansID": 1,
          "Name": "sample string 2",
          "CashOnDelivery": true,
          "QuickPayment": true,
          "PrePayment": true,
          "BankTransfer": true,
          "Count": 7
        }
      ]
    },
    {
      "StatusID": 1,
      "TypeName": "sample string 2",
      "Count": 3,
      "ByPaymentMeans": [
        {
          "MeansID": 1,
          "Name": "sample string 2",
          "CashOnDelivery": true,
          "QuickPayment": true,
          "PrePayment": true,
          "BankTransfer": true,
          "Count": 7
        },
        {
          "MeansID": 1,
          "Name": "sample string 2",
          "CashOnDelivery": true,
          "QuickPayment": true,
          "PrePayment": true,
          "BankTransfer": true,
          "Count": 7
        }
      ]
    }
  ],
  "CustomerStats": [
    {
      "TypeID": 1,
      "TypeName": "sample string 2",
      "Count": 3
    },
    {
      "TypeID": 1,
      "TypeName": "sample string 2",
      "Count": 3
    }
  ],
  "ShippingStats": [
    {
      "TypeID": 1,
      "TypeName": "sample string 2",
      "Count": 3
    },
    {
      "TypeID": 1,
      "TypeName": "sample string 2",
      "Count": 3
    }
  ],
  "ProductStats": 1,
  "ClassificationStats": 2,
  "CustomerQueryStats": 3,
  "UnreadCustomerQueryStats": 4
}

application/xml, text/xml

Sample:

<Stats xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Stats">
  <ClassificationStats>2</ClassificationStats>
  <CustomerQueryStats>3</CustomerQueryStats>
  <CustomerStats>
    <Concept>
      <Count>3</Count>
      <TypeID>1</TypeID>
      <TypeName>sample string 2</TypeName>
    </Concept>
    <Concept>
      <Count>3</Count>
      <TypeID>1</TypeID>
      <TypeName>sample string 2</TypeName>
    </Concept>
  </CustomerStats>
  <OrderStats>
    <OrderStatusWithPaymentMeans>
      <ByPaymentMeans>
        <PaymentMean>
          <BankTransfer>true</BankTransfer>
          <CashOnDelivery>true</CashOnDelivery>
          <Count>7</Count>
          <MeansID>1</MeansID>
          <Name>sample string 2</Name>
          <PrePayment>true</PrePayment>
          <QuickPayment>true</QuickPayment>
        </PaymentMean>
        <PaymentMean>
          <BankTransfer>true</BankTransfer>
          <CashOnDelivery>true</CashOnDelivery>
          <Count>7</Count>
          <MeansID>1</MeansID>
          <Name>sample string 2</Name>
          <PrePayment>true</PrePayment>
          <QuickPayment>true</QuickPayment>
        </PaymentMean>
      </ByPaymentMeans>
      <Count>3</Count>
      <StatusID>1</StatusID>
      <TypeName>sample string 2</TypeName>
    </OrderStatusWithPaymentMeans>
    <OrderStatusWithPaymentMeans>
      <ByPaymentMeans>
        <PaymentMean>
          <BankTransfer>true</BankTransfer>
          <CashOnDelivery>true</CashOnDelivery>
          <Count>7</Count>
          <MeansID>1</MeansID>
          <Name>sample string 2</Name>
          <PrePayment>true</PrePayment>
          <QuickPayment>true</QuickPayment>
        </PaymentMean>
        <PaymentMean>
          <BankTransfer>true</BankTransfer>
          <CashOnDelivery>true</CashOnDelivery>
          <Count>7</Count>
          <MeansID>1</MeansID>
          <Name>sample string 2</Name>
          <PrePayment>true</PrePayment>
          <QuickPayment>true</QuickPayment>
        </PaymentMean>
      </ByPaymentMeans>
      <Count>3</Count>
      <StatusID>1</StatusID>
      <TypeName>sample string 2</TypeName>
    </OrderStatusWithPaymentMeans>
  </OrderStats>
  <ProductStats>1</ProductStats>
  <ShippingStats>
    <Concept>
      <Count>3</Count>
      <TypeID>1</TypeID>
      <TypeName>sample string 2</TypeName>
    </Concept>
    <Concept>
      <Count>3</Count>
      <TypeID>1</TypeID>
      <TypeName>sample string 2</TypeName>
    </Concept>
  </ShippingStats>
  <UnreadCustomerQueryStats>4</UnreadCustomerQueryStats>
</Stats>