GetStatistics (to be deprecated)
Definition
Use this call to get product and order statistics for a specified period.
Request URI: https://api.sellercenter.lazada.sg?Action=GetStatistics
Parameters
| Field | Type | Description |
|---|---|---|
| Action | string | GetStatistics Name of the API that is to be called. Mandatory. |
| Format | string | The response format, with XML as the default. Can be XML or JSON. Optional. |
| Timestamp | datetime | The current time in ISO8601 format (e.g., Timestamp=2016-04-01T10:00:00+02:00 for Berlin). Mandatory. |
| UserID | string | The ID of the user making the call. Mandatory. |
| Version | string | The API version against which this call is to be executed. The current version is "1.0". Mandatory. |
| Signature | string | The cryptographic signature, authenticating the request. You 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. |
Code sample
# GetStatistics cURL example
# to run, update Timestamp and recompute Signature
#
url = "https://api.sg.ali-lazada.com/"
get
data-urlencode Action=GetStatistics
data-urlencode Timestamp=2015-07-01T11:11+0000
data-urlencode [email protected]
data-urlencode Version=1.0
data-urlencode Signature=d4ff93cccb165295ed8357fe42082208b781a3b576bbb7d3fe7a624270b047b9
GetStatistics request = new GetStatistics();
try {
GetStatisticsResponse response = request.execute();
SellerStatics statics = response.getBody();
System.out.println(statics);
} catch (LazadaException e) {
System.out.println(e.getResponseStr());
}
Response
The statistics are returned in the response as follows.
| Name | Type | Description |
|---|---|---|
| PRODUCTS | ||
| Active | integer | Number of active products |
| All | integer | Number of all products |
| Deleted | integer | Number of deleted products |
| ImageMissing | integer | Number of products with image missing |
| Inactive | integer | Number of inactive products |
| Live | integer | Number of live products |
| Pending | integer | Number of product pending |
| PoorQuality | integer | Number of products with poor quality |
| SoldOut | integer | Number of sold out products |
| Total | integer | Total number of products |
| ORDERS | ||
| Canceled | integer | Number of canceled orders |
| Delivered | integer | Number of delivered orders |
| Economy | integer | Number of orders with Economy shipping type status |
| Express | integer | Number of orders with Express shipping type status |
| Failed | integer | Number of failed orders |
| NoExtInvoiceKey | integer | Number of orders with no external invoice key |
| NotPrintedPending | integer | Number of not printed pending orders |
| NotPrintedReadyToShip | integer | Number of not printed ready to ship orders |
| Pending | integer | Number of pending orders |
| Processing | integer | Number of orders in processing |
| ReadyToShip | integer | Number of ready to ship orders |
| ReturnRejected | integer | Number of orders with return rejected |
| ReturnShippedByCustomer | integer | Number of orders shipped by the customer |
| ReturnWaitingForApproval | integer | Number of orders with return waiting for approval status |
| Returned | integer | Number of returned orders |
| Shipped | integer | Number of shipped orders |
| Standard | integer | Number of orders with Standard shipping type |
| Total | integer | Total number of orders |
| ORDER ITEMS PENDING | ||
| Today | integer | Number of order items pending in the last 24 hours |
| Yesterday | integer | Number of order items pending in the last 48 hours |
| Older | integer | Number of order items pending for more than 48 hours |
| ACCOUNT HEALTH | *Statistics grouped by Day, Week, Month and Alltime* | Gives the values for: TwoDaysShippedPercentage - Percent of orders shipped within 48 hours ReturnPercentage - Percent of orders returned CancellationPercentage - Percent of orders canceled* |
| Percentage | decimal | Percentage for the statistic |
| Text | string | A text label for the percentage grade |
Result sample
<SuccessResponse>
<Head>
<RequestId/>
<RequestAction>GetStatistics</RequestAction>
<ResponseType/>
<Timestamp>2015-08-03T13:39:34+0000</Timestamp>
</Head>
<Body>
<Products>
<Status>
<Active>10</Active>
<All>20</All>
<Deleted>5</Deleted>
<ImageMissing>0</ImageMissing>
<Inactive>5</Inactive>
<Live>10</Live>
<Pending>0</Pending>
<PoorQuality>0</PoorQuality>
<SoldOut>0</SoldOut>
</Status>
<Total>20</Total>
</Products>
<Orders>
<Status>
<Canceled>5</Canceled>
<Delivered>2</Delivered>
<Economy>0</Economy>
<Express>2</Express>
<Failed>0</Failed>
<NoExtInvoiceKey>0</NoExtInvoiceKey>
<NotPrintedPending>0</NotPrintedPending>
<NotPrintedReadyToShip>0</NotPrintedReadyToShip>
<Pending>0</Pending>
<Processing>0</Processing>
<ReadyToShip>0</ReadyToShip>
<ReturnRejected>0</ReturnRejected>
<ReturnShippedByCustomer>0</ReturnShippedByCustomer>
<ReturnWaitingForApproval>0</ReturnWaitingForApproval>
<Returned>0</Returned>
<Shipped>0</Shipped>
<Standard>0</Standard>
</Status>
<Total>9</Total>
</Orders>
<OrdersItemsPending>
<Today>0</Today>
<Yesterday>0</Yesterday>
<Older>12</Older>
</OrdersItemsPending>
<AccountHealth>
<Day>
<TwoDaysShippedPercentage>
<Percentage>0.00</Percentage>
<Text>bad</Text>
</TwoDaysShippedPercentage>
<ReturnPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</ReturnPercentage>
<CancellationPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</CancellationPercentage>
</Day>
<Week>
<TwoDaysShippedPercentage>
<Percentage>0.00</Percentage>
<Text>bad</Text>
</TwoDaysShippedPercentage>
<ReturnPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</ReturnPercentage>
<CancellationPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</CancellationPercentage>
</Week>
<Month>
<TwoDaysShippedPercentage>
<Percentage>0.00</Percentage>
<Text>bad</Text>
</TwoDaysShippedPercentage>
<ReturnPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</ReturnPercentage>
<CancellationPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</CancellationPercentage>
</Month>
<Alltime>
<TwoDaysShippedPercentage>
<Percentage>0.00</Percentage>
<Text>bad</Text>
</TwoDaysShippedPercentage>
<ReturnPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</ReturnPercentage>
<CancellationPercentage>
<Percentage>0.00</Percentage>
<Text>excellent</Text>
</CancellationPercentage>
</Alltime>
</AccountHealth>
</Body>
</SuccessResponse>
Error messages
No specific errors.
Updated over 6 years ago