Customers
List a segment's customers
The customers in a segment right now (a segment is a saved filter, so it changes as customers do). In id order.
Path parameters
- segment_idstringRequired
starts with seg_
Query parameters
- limitinteger
How many objects to return, 1–100. Default 25.
1–100
- cursorstring
The
next_cursorfrom the previous page. Repeat the same filters with it.up to 512 characters
Returns
200 OK · A page of customers. CustomerList
- objectstringRequired
always "list"
- has_morebooleanRequired
- next_cursorstring or nullRequired
Pass as
cursorto get the next page.nullon the last page. - dataarray of CustomersRequired
21 child fields
- idstring
starts with cus_
- objectstring
always "customer"
- namestring or null
- phonestring or null
E.164.
- emailstring or null
- statusstring
do_not_contact: blocked by the merchant.
One of
active,needs_followup,do_not_contact - reliabilityobject
The delivery score: how likely this customer is to accept a COD parcel, from their delivered, returned and cancelled orders here and (at half weight) at other Ordexs stores.
2 child fields
- scoreinteger or null
Percentage, null with no delivered, returned or cancelled order yet.
0–100
- tierstring
reliable: 75 and up. uncertain: 50-74. risky: under 50. new: no finished orders.
One of
new,reliable,uncertain,risky
- whatsapp_opt_inboolean
- whatsapp_opt_in_atstring or null
ISO 8601 date-time, UTC
- tagsarray of strings
- notestring or null
- orders_countinteger
- delivered_countinteger
- returned_countinteger
- cancelled_countinteger
- total_spentMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- first_order_atstring or null
ISO 8601 date-time, UTC
- last_order_atstring or null
ISO 8601 date-time, UTC
- livemodeboolean
- created_atstring
ISO 8601 date-time, UTC
- updated_atstring
ISO 8601 date-time, UTC
Errors
Every error has the same shape. This endpoint can answer with:
