Skip to main content

List Customers

GET 

/api/storefront/instances/:id/customers

List the store's buyers. The Store API has no customers endpoint, so customers are mirrored from the customer block of every imported order: one row per store customer id (or per email for a guest checkout), with contact details and address taken from the buyer's most recent order.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Each row carries the buyer's order count, total spent (cancelled and refunded orders excluded), first and last order dates, and their SKU.io customer (sku_customer_id): the one on their latest SKU.io sales order, or, before any exists, the SKU.io customer with the same email (null when there is none yet).

Authentication: Bearer token.

Paginated (default 10 per page, max 200). Default sort: most recent order first.

Request​

Responses​

OK

Response Headers
    Content-Type