Skip to content

List the ids of matching customers

GET
/customers/ids
curl --request GET \
--url 'https://example.com/customers/ids?includeArchived=true&limit=50&offset=0&sort=name&dir=asc&owing=true&kind=commercial&marketing=email&surcharge=add&ordering=stopped&shop=confirmed&activity=returning' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Every match for the same filters as GET /customers, in the same order, up to 5000, with the full count: for selecting all of them across pages.

q

Search trading name

string
<= 100 characters

Search trading name

includeArchived
string
default: false
Allowed values: true false
limit
integer
default: 50 >= 1 <= 200
offset
integer | null
0
sort
string
default: name
Allowed values: name owed overdue
dir
string
Allowed values: asc desc
owing
string
default: false
Allowed values: true false
kind
string
Allowed values: commercial domestic
rateSet
Any of:

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
marketing

Only customers whose consent on this channel is granted.

string
Allowed values: email sms phone post

Only customers whose consent on this channel is granted.

surcharge

Add: on the chosen list for the business surcharge. exclude: on the excluded list.

string
Allowed values: add exclude

Add: on the chosen list for the business surcharge. exclude: on the excluded list.

ordering

Stopped: orders or deliveries are stopped now, for money owed. rule: set to stop while unpaid, owing or not.

string
Allowed values: stopped rule

Stopped: orders or deliveries are stopped now, for money owed. rule: set to stop while unpaid, owing or not.

shop

Confirmed: at least one shop sign-in for this customer has a confirmed email. unconfirmed: has a shop sign-in, none confirmed. none: no shop sign-in.

string
Allowed values: confirmed unconfirmed none

Confirmed: at least one shop sign-in for this customer has a confirmed email. unconfirmed: has a shop sign-in, none confirmed. none: no shop sign-in.

createdFrom
string format: date
createdTo
string format: date
activity
string
Allowed values: returning inactive
activityFrom
string format: date
activityTo
string format: date

Ids

Media typeapplication/json
object
ids
required
Array<string>
total
required
integer

Example

{
"ids": [
"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not a member of that tenant

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}