Metorik Docs

Categories

Category sales

Returns product categories from your store together with category-level sales metrics,
refunds, and order counts for the selected period.

GET /api/v1/store/categories

Category sales

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/categories' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "category_id": 221,
      "name": "Hoodies",
      "parent_category_id": null,
      "slug": "hoodies",
      "description": "Sweatshirts and hoodies.",
      "image": "https://app.metorik.com/img/products/hoodie-category.png",
      "products": 12,
      "gross_items_sold": 184,
      "items_refunded": 3,
      "net_items_sold": 181,
      "gross_sales": 14536,
      "total_tax": 1211.33,
      "total_discounted": 210,
      "total_refunds": 237,
      "net_orders": 176,
      "net_sales": 14089
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "has_more_pages": true
  }
}

No response description.

Authorizations

  • Authorization string required header

    Generate a store API key from the store's Metorik API settings in Metorik, and choose the scopes needed for the endpoints you want to call.

Query Parameters

  • end_date string required

    End date in the store timezone using YYYY-MM-DD format. Example: 2026-02-28

  • order_by string enum

    Sort field. Example: name

  • order_dir string enum

    Sort direction. Example: asc

  • order_filters string

    Optional JSON-encoded array of order-level filters applied before calculating category sales. See Order Filters Reference. Example: [{"field":"billing_address_country","operator":"eq","value":"US"}]

  • page integer

    Page number for pagination. Example: 1

  • per_page integer

    Number of categories per page. Min 1, max 100. Example: 10

  • search string

    Search term to filter categories. Example: accessories

  • start_date string required

    Start date in the store timezone using YYYY-MM-DD format. Example: 2026-02-01

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • data[] object array
    + Show Child Attributes
    • category_id integer
    • name string
    • parent_category_id string nullable
    • slug string
    • description string
    • image string
    • products integer
    • gross_items_sold integer
    • items_refunded integer
    • net_items_sold integer
    • gross_sales integer
    • total_tax number
    • total_discounted integer
    • total_refunds integer
    • net_orders integer
    • net_sales integer
  • pagination object
    + Show Child Attributes
    • current_page integer
    • per_page integer
    • has_more_pages boolean