Metorik Docs

Products

Product sales

Returns products from your store together with product-level sales metrics,
refunds, and sold date ranges for the selected period.

GET /api/v1/store/products

Product sales

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/products' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "product_id": 4821,
      "title": "Metorik Hoodie",
      "sku": "MTK-HOODIE-BLK-M",
      "type": "simple",
      "status": "publish",
      "current_price": 79,
      "regular_price": 79,
      "sale_price": 0,
      "stock_quantity": 24,
      "in_stock": true,
      "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,
      "first_sold": "2025-11-04T09:15:00Z",
      "last_sold": "2026-03-25T18:42:00Z",
      "product_created_at": "2025-10-21T14:00:00Z",
      "product_updated_at": "2026-03-12T07:30:00Z"
    }
  ],
  "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: product_created_at

  • order_dir string enum

    Sort direction. Example: desc

  • order_filters string

    Optional JSON-encoded array of order-level filters applied before calculating product 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 products per page. Min 1, max 100. Example: 10

  • search string

    Search term to filter products. Example: hoodie

  • 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
    • product_id integer
    • title string
    • sku string
    • type string
    • status string
    • current_price integer
    • regular_price integer
    • sale_price integer
    • stock_quantity integer
    • in_stock boolean
    • 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
    • first_sold string
    • last_sold string
    • product_created_at string
    • product_updated_at string
  • pagination object
    + Show Child Attributes
    • current_page integer
    • per_page integer
    • has_more_pages boolean