Skip to content

Get a customer's order counts and recent activity

Open .md

GET/v1/api/store/{team_slug}/customer/{hash_id}/activity_summary

v1Operation ID v1_public_customer_activity_summary

Counts the customer's published sales orders, quotes and invoices, whatever their status (completed ones included), and lists its 10 newest sales orders and quotes.

  • counts.orders: published sales orders that are not deleted, in any status.
  • counts.quotes: published quotes that are not deleted, in any status.
  • counts.invoices: invoices that are not deleted, on those sales orders.
  • recent_activity: the same sales orders and quotes, newest created first, at most 10, each with id, type (sales_order or quote), number, status_name, created_at and total. With 10 or fewer, it has counts.orders + counts.quotes rows.

Drafts are left out everywhere. For open work only, use the customer's totals instead (unpaid_amount, quote_amount).

Permission

Needs the Manage Customers permission. At "Manage Assigned to User" only customers assigned to you are allowed; other customers answer 403.

Path parameters

  • team_slugstringrequired

    Your team slug, shown as Team ID next to your API key in Profile.

    • Example your-team
  • hash_idstringrequired

    The customer's id (id from List customers) or the customer's unique key.

    • Example EDhVUaC6jbLbed

Request body

This operation takes no request body.

Response

200Successful response.

  • dataobjectrequired
    Child fields (3)
    • countsobjectrequired
      Child fields (3)
      • invoicesintegerrequired

        Invoices on those sales orders that are not deleted.

      • ordersintegerrequired

        Published sales orders, any status.

      • quotesintegerrequired

        Published quotes, any status.

    • customer_idstringrequired
    • recent_activityarray of objectsrequired
      Fields of each item (6)
      • idstringrequired
      • numberstringrequired

        The sales order or quote number people see, such as SO1001.

      • typestring | nullrequired
        • One of: "sales_order", "quote"
      • created_atstring (date-time) | null
      • status_namestring | null
      • totalinteger | number | string

        The order total. Thousandths, an older encoding: 125000 is 125.00. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities.

  • statusintegerrequired
  • successbooleanrequired

Errors

  • 401The API key is missing or wrong (unauthenticated).

  • 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

    When
    Your role has no Manage Customers permission, or it manages only customers assigned to you and this one is not. This 403 has a short body, {"message": "You do not have permission to view customer"}.
    Fix
    Ask for Manage Customers "Manage All", or to be assigned to the customer.
  • 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

    When
    No live, non-system customer with this id. error.code is null and error.message names the record type.
    Fix
    Check the id. Deleted customers have no summary.