Metorik Docs

Orders

Order data

Returns orders from your store together with billing details and order
totals. All returned *_at timestamps are in UTC.

GET /api/v1/store/orders

Order data

curl --request GET \
  --url 'https://{baseUrl}/api/v1/store/orders' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": [
    {
      "order_id": 1001,
      "customer_id": 482,
      "order_number": "1001",
      "order_name": "#1001",
      "status": "completed",
      "order_created_at": "2026-03-25T18:42:00Z",
      "order_updated_at": "2026-03-25T18:42:00Z",
      "order_paid_at": "2026-03-25T18:42:00Z",
      "order_completed_at": "2026-03-25T18:42:00Z",
      "currency": "USD",
      "billing_address_first_name": "Tony",
      "billing_address_last_name": "Stark",
      "billing_address_company": "Stark Industries",
      "billing_address_phone": "5551234567",
      "billing_address_address_1": "10880 Malibu Point",
      "billing_address_address_2": "Suite 1",
      "billing_address_city": "Malibu",
      "billing_address_state": "CA",
      "billing_address_postcode": "90265",
      "billing_address_country": "US",
      "billing_address_email": "[email protected]",
      "shipping_address_first_name": "Pepper",
      "shipping_address_last_name": "Potts",
      "shipping_address_company": "Stark Industries",
      "shipping_address_phone": "5551234567",
      "shipping_address_address_1": "200 Park Ave",
      "shipping_address_address_2": "Floor 2",
      "shipping_address_city": "New York",
      "shipping_address_state": "NY",
      "shipping_address_postcode": "10166",
      "shipping_address_country": "US",
      "payment_method": "stripe",
      "payment_method_title": "Credit Card (Stripe)",
      "shipping_method_title": "Flat rate",
      "customer_note": "Leave at front desk",
      "created_via": "checkout",
      "total": 120,
      "total_items": 3,
      "total_refunds": 15,
      "net": 105,
      "net_original": 105,
      "cogs": 42.5,
      "product_cogs": 36.25,
      "shipping_cogs": 3.5,
      "transaction_cogs": 1.75,
      "extra_cogs": 1,
      "gross_profit": 77.5,
      "resource_link": "https://app.metorik.com/orders/1001"
    }
  ],
  "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

  • filters string

    Optional JSON-encoded filter array. See Order Filters Reference. Example: [{"field":"total","operator":"gte","value":100},{"field":"status","operator":"eq","value":"completed"}]

  • order_by string enum

    Sort field. Example: order_created_at

  • order_dir string enum

    Sort direction. Example: desc

  • page integer

    Page number for pagination. Example: 1

  • per_page integer

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

  • search string

    Search term to filter orders. Example: 1001

Headers

  • Accept string required

    Response format header. Example: application/json

Response

application/json
  • data[] object array
    + Show Child Attributes
    • order_id integer
    • customer_id integer
    • order_number string
    • order_name string
    • status string
    • order_created_at string
    • order_updated_at string
    • order_paid_at string
    • order_completed_at string
    • currency string
    • billing_address_first_name string
    • billing_address_last_name string
    • billing_address_company string
    • billing_address_phone string
    • billing_address_address_1 string
    • billing_address_address_2 string
    • billing_address_city string
    • billing_address_state string
    • billing_address_postcode string
    • billing_address_country string
    • billing_address_email string
    • shipping_address_first_name string
    • shipping_address_last_name string
    • shipping_address_company string
    • shipping_address_phone string
    • shipping_address_address_1 string
    • shipping_address_address_2 string
    • shipping_address_city string
    • shipping_address_state string
    • shipping_address_postcode string
    • shipping_address_country string
    • payment_method string
    • payment_method_title string
    • shipping_method_title string
    • customer_note string
    • created_via string
    • total integer
    • total_items integer
    • total_refunds integer
    • net integer
    • net_original integer
    • cogs number
    • product_cogs number
    • shipping_cogs number
    • transaction_cogs number
    • extra_cogs integer
    • gross_profit number
    • resource_link string
  • pagination object
    + Show Child Attributes
    • current_page integer
    • per_page integer
    • has_more_pages boolean