Customers

Get stats for a single customer across the whole organisation

Use this endpoint to retrieve high-level stats for a single customer.

get/shop/customers/{customerId}/stats

Response

Contains the customer stats.

Example response

{
  "data": {
    "totals": {
      "total_order_value": 38500,
      "average_order_value": 19250,
      "num_orders": 2
    },
    "recent_orders": [
      {
        "num_items": 2,
        "customer": {
          "email": "jane@example.com",
          "first_name": "Jane",
          "last_name": "Jones"
        },
        "sales_channel": {
          "name": "Website"
        },
        "totals": {
          "subtotal": 15000,
          "total": 15000
        },
        "site": {
          "name": "Palm Tree Spa"
        }
      }
    ]
  },
  "meta": {
    "currency": "gbp"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.