GetStatistics

Returns sales and orders metrics for a specified period.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The statistics are returned in the response as follows:

PRODUCTS
ActiveIntegerNumber of active products
AllIntegerNumber of all products
DeletedIntegerNumber of deleted products
ImageMissingIntegerNumber of products with image missing
InactiveIntegerNumber of inactive products
LiveIntegerNumber of live products
PendingIntegerNumber of product pending
PoorQualityIntegerNumber of products with poor quality
SoldOutIntegerNumber of sold out products
TotalIntegerTotal number of products
ORDERS
CanceledIntegerNumber of canceled orders
DeliveredIntegerNumber of delivered orders
EconomyIntegerNumber of Economy shipping type status orders
ExpressIntegerNumber of Express shipping type status orders
FailedIntegerNumber of failed orders
NoExtInvoiceKeyIntegerNumber of orders with no external invoice key
NotPrintedPendingIntegerNumber of not printed pending orders
NotPrintedReadyToShipIntegerNumber of not printed ready to ship orders
PendingIntegerNumber of pending orders
ProcessingIntegerNumber of orders in processing
ReadyToShipIntegerNumber of ready to ship orders
ReturnRejectedIntegerNumber of orders with return rejected
ReturnShippedByCustomerIntegerNumber of orders shipped by the customer
ReturnWaitingForApprovalIntegerNumber of orders with return waiting for approval
ReturnedIntegerNumber of returned orders
ShippedIntegerNumber of shipped orders
StandardIntegerNumber of orders with Standard shipping type
TotalIntegerTotal number of orders
ORDER ITEMS PENDING
TodayIntegerNumber of order items pending in the last 24h
YesterdayIntegerNumber of order items pending in the last 48h
OlderIntegerNumber of order items pending for more than 48h
ACCOUNT HEALTH*Statistics grouped by Day, Week, Month and Alltime*
  • Gives the values for:
  • *TwoDaysShippedPercentage** - Percent of orders shipped within 48h
  • ReturnPercentage- Percent of orders returned
*CancellationPercentage*- Percent of order canceled
PercentageDecimalPercentage for the statistic
TextStringA text label for the percentage grade

Errors

No specific errors.

Query Params
string
Defaults to GetStatistics

Name of the function that is to be called. Mandatory and must be 'GetStatistics' in this case. If omitted, an 'E001: Parameter Action is mandatory' error is returned. If an unknown function string is supplied, an 'E008: Invalid Action' error message is returned.

string
Defaults to XML

If supplied, must be either 'JSON' or 'XML'. If not supplied, 'XML' is assumed.

date

The current time in ISO8601 format relative to UTC (e.g., Timestamp=2015-04-01T10:00:00+02:00 for Berlin), so that calls cannot be replayed by an eaves-dropping third party (i.e., those calls too far into the past or future yield an error message). Mandatory. If not supplied, an 'E001: Parameter Timestamp is mandatory' error message results. If the timestamp is too old or in the future, an 'E003: Timestamp has expired' error message is returned.

string

The ID of the user making the call. The list of authorized users is maintained in Seller Center web interface under Settings/Manage Users.

string

The API version against which this call is to be executed, in major-dot-minor format. Must currently be 1.0, even though the actual version of the API is 2.6.20. If omitted, an ‘E001: Parameter Version is mandatory’ error message is returned.

string

The cryptographic signature, authenticating the request. A caller must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory. If omitted, an ‘E001: Parameter Signature is mandatory’ error message is returned. If the signature is incorrect, an ‘E007: Login failed. Signature mismatch’ error message is returned.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
LoadingLoading…
Response
Choose an example:
application/xml
application/json