Get Shop SKU Performance List

GET

/analytics/202509/shop_skus/performance

Returns a paginated list of performance metrics for the shop’s SKUs over the requested date range.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

start_date_ge

required

string format: date

Start time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive.

end_date_lt

required

string format: date

End date of the performance period, exclusive, in the shop’s registered time zone. Use YYYY-MM-DD format. It must be later than start_date_ge.

page_size

integer format: int64

<= 100

Number of records per page. If omitted, defaults to 10. Maximum: 100.

page_token

string

Token that identifies the page to retrieve. Omit it for the first page. For later pages, pass the next_page_token returned by the previous response and reuse the same start_date_ge, end_date_lt, sort_field, sort_order, category_filter, product_status_filter, product_ids, currency, and page_size values.

sort_field

string

Allowed values: gmv sku_orders units_sold

Sort field, possible values:

• gmv (default)
• sku_orders
• units_sold

sort_order

string

Allowed values: DESC ASC

Sort direction, possible values:

• DESC (default)
• ASC

category_filter

Array<string>

List of category IDs used to filter returned SKU performance records.

product_status_filter

string

Allowed values: LIVE INACTIVE ALL

Filter SKUs by product status. Possible values:

• LIVE
• INACTIVE
• ALL (default)

product_ids

Array<string>

Filter SKUs by product IDs. If product_ids are provided, the API will only return SKUs for the given product IDs, otherwise it will return all SKUs for the shop

currency

string

Currency used to report GMV:

• USD: U.S. dollars
• LOCAL (default): Local currency where the shop is located

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

skus

List of SKU performance metrics.

Array<object>

object

id

The ID of the SKU in the returned SKU performance record.

integer format: int64

product_id

The ID of the product that the returned SKU belongs to.

integer format: int64

gmv

Overall Gross Merchandise Value (GMV) for the SKU.

object

amount

GMV amount in the corresponding currency.

string

currency

GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP).

string

sku_orders

Total (sum of all) orders for a SKU

integer format: int64

units_sold

Number of units sold for a SKU

integer format: int64

next_page_token

If nonempty, pass this token unchanged as page_token in the next request and reuse the same start_date_ge, end_date_lt, page_size, sort_field, sort_order, currency, category_filter, product_status_filter, and product_ids values. For optional parameters, preserve whether each parameter was omitted or present. An empty string means there are no more pages.

string

total_count

Total number of SKUs matching the request filters across all pages.

integer format: int64

latest_available_date

Latest date in local timezone where data is ready (ISO 8601 format).

string format: date

Example

{
  "code": 0,
  "data": {
    "skus": [
      {
        "id": 18354627263453,
        "product_id": 123456789,
        "gmv": {
          "amount": "135.42",
          "currency": "USD"
        },
        "sku_orders": 10,
        "units_sold": 10
      }
    ],
    "next_page_token": "cGFnZV9udW1iZXI9MQ==",
    "total_count": 20,
    "latest_available_date": "2024-04-07"
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}