1 operation. Every schema and example on this page is generated from the platform contract.
Merchant overview for the Home / Today screen: visits, stamps, redemptions, and auto-approval rate for the period with a same-time pace comparison versus the previous period, the pending-stamp count, a period-aware sparkline, and the Click & Collect snapshot (today totals, awaiting-accept, upcoming collections).
Store whose overview to summarise (also authorises the merchant).
DEPRECATED legacy window; prefer preset or start_date/end_date. Stats + sparkline window (default today).
todayweekmonthsixmonthstwelvemonthsPreset range (defaults per endpoint). Use "custom" with start_date and end_date for an arbitrary range.
todaylast_7dlast_14dlast_30dlast_90dlast_6mlast_12mcustomCustom range start, store-local YYYY-MM-DD (inclusive). Required when preset is "custom".
Custom range end, store-local YYYY-MM-DD (inclusive). Required when preset is "custom".
The preset/period key resolved for this response (e.g. today, last_30d, custom).
Store-local inclusive start of the window (YYYY-MM-DD).
Store-local inclusive end of the window (YYYY-MM-DD).
Span of the window in days.
curl -G "https://www.membber.com/api/v1/overview" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
--data-urlencode "store_id=6659c139-0000-4000-8000-d0c500000066"import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.GET("/api/v1/overview", {
params: { query: { store_id: "6659c139-0000-4000-8000-d0c500000066" } },
});
if (error) {
// Typed error envelope: { error: { code, message, requestId } }
throw new Error(`${error.error.code}: ${error.error.message}`);
}
console.log(data);import MembberSwift
let client = MembberClient(
serverURL: MembberClient.productionServerURL,
tokenProvider: { session.accessToken }
)
let response = try await client.api.getOverview(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"period": {
"key": "<key>",
"start_date": "<start_date>",
"end_date": "<end_date>",
"days": 1
},
"commerce": {
"today": {
"orders_count": 1,
"revenue_pence": 1500,
"currency": "GBP",
"collections_due_count": 1
},
"awaiting_accept_count": 1,
"next_collection_at": "<next_collection_at>",
"upcoming_collections": [
{
"order_id": "4991ffac-0000-4000-8000-d0c500000049",
"order_number": "<order_number>",
"customer_name": "Alex Example",
"collection_at": "<collection_at>",
"fulfilment_status": "<fulfilment_status>"
}
],
"accepting": true,
"next_slot_at": "<next_slot_at>"
},
"stats": {
"visits": {
"value": 1,
"change": 1
},
"stamps": {
"value": 1,
"change": 1
},
"redemptions": {
"value": 1,
"change": 1
},
"auto_rate": {
"value": 1,
"change": 1
}
},
"pending_count": 1,
"chart_data": [
{
"date": "<date>",
"value": 1
}
],
"chart_data_prev": [
{
"date": "<date>",
"value": 1
}
],
"takings_series": [
{
"date": "<date>",
"value_pence": 1500
}
],
"takings_series_prev": [
{
"date": "<date>",
"value_pence": 1500
}
],
"takings_currency": "GBP",
"takings_orders_count": 1,
"store": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"code": "EXAMPLE10",
"name": "Example name"
}
}