5 operations. Every schema and example on this page is generated from the platform contract.
Dark behind SHOP_ANSWERS_DATA_REQUESTS (off: 404). Merchant sign-in, this store only. Never cached.
The shop answering (also authorises the merchant).
Open ones, the soonest due first.
copy: a copy of her data here. delete: delete her details here.
copydeleteHow she is named to the shop: never more than her first name and an initial.
"Kye".
"Kye E": her first name and an initial.
The day the law says the shop answers by: one month after she asked.
curl -G "https://www.membber.com/api/v1/shop-data-requests" \
-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/shop-data-requests", {
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.listShopDataRequests(
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"requests": [
{
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "copy",
"name": {
"first": "<first>",
"short": "<short>"
},
"sent_at": "<sent_at>",
"reply_by": "<reply_by>",
"days_left": 0
}
]
}Dark behind SHOP_ANSWERS_DATA_REQUESTS (off: 404; a delete also needs SHOP_FORGET_ENABLED). Merchant sign-in; another store’s request is a 404. A delete is looked at with the one-shop delete’s dry run, which changes nothing.
The shop answering (also authorises the merchant).
Supplied by the URL PATH.
copy: a copy of her data here. delete: delete her details here.
copydeletesent: open, with the shop. answered: done.
sentansweredrefusedwithdrawnHow she is named to the shop: never more than her first name and an initial.
"Kye".
"Kye E": her first name and an initial.
The shop’s last "I can’t yet". The request stays open.
open_orderopen_disputeotherWhat this shop holds about her, counted from the same records her copy is made of.
Orders she paid for: these stay, without her name, for the accounts.
The shop’s own notes on her.
An open delete request: whether her details can go now, and why not.
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_recordsSomething of hers still to happen here.
A copy goes only here: her proved email, masked.
curl -G "https://www.membber.com/api/v1/shop-data-requests/295c940a-0000-4000-8000-d0c500000029" \
-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/shop-data-requests/{requestId}", {
params: { path: { requestId: "295c940a-0000-4000-8000-d0c500000029" }, 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.getShopDataRequest(
path: .init(requestId: "295c940a-0000-4000-8000-d0c500000029"),
query: .init(storeId: "6659c139-0000-4000-8000-d0c500000066")
).ok.body.json
print(response){
"request": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "copy",
"status": "sent",
"sent_at": "<sent_at>",
"reply_by": "<reply_by>",
"days_left": 0,
"answered_at": "<answered_at>",
"name": {
"first": "<first>",
"short": "<short>"
},
"not_yet": {
"reason": "open_order",
"note": "Added at the front desk",
"at": "<at>"
},
"records": {
"details": {
"name": true,
"email": true,
"phone": true,
"address": true
},
"orders": 0,
"paidOrders": 0,
"messages": 0,
"stamps": 0,
"notes": 0
},
"delete": {
"can_delete": true,
"block": "open_order",
"open": "<open>"
},
"send_to": "<send_to>"
}
}Dark behind SHOP_ANSWERS_DATA_REQUESTS and SHOP_FORGET_ENABLED (off: 404). Merchant sign-in, same origin; another store’s request is a 404. Through the one-shop delete (customer_forget_at_store), which refuses while something of hers is still open here. A second press answers the request as it is: one delete, one email, one audit row.
The shop answering (also authorises the merchant).
Supplied by the URL PATH.
done: this press did it. already: it was done. refused: it can’t be now.
donealreadyrefusedcopy: a copy of her data here. delete: delete her details here.
copydeletesent: open, with the shop. answered: done.
sentansweredrefusedwithdrawnHow she is named to the shop: never more than her first name and an initial.
"Kye".
"Kye E": her first name and an initial.
The shop’s last "I can’t yet". The request stays open.
open_orderopen_disputeotherWhat this shop holds about her, counted from the same records her copy is made of.
Orders she paid for: these stay, without her name, for the accounts.
The shop’s own notes on her.
An open delete request: whether her details can go now, and why not.
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_recordsSomething of hers still to happen here.
A copy goes only here: her proved email, masked.
curl -X POST "https://www.membber.com/api/v1/shop-data-requests/295c940a-0000-4000-8000-d0c500000029/delete" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"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.POST("/api/v1/shop-data-requests/{requestId}/delete", {
params: { path: { requestId: "295c940a-0000-4000-8000-d0c500000029" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
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.deleteShopDataRequest(
path: .init(requestId: "295c940a-0000-4000-8000-d0c500000029"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066"
))
).ok.body.json
print(response){
"outcome": "done",
"request": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "copy",
"status": "sent",
"sent_at": "<sent_at>",
"reply_by": "<reply_by>",
"days_left": 0,
"answered_at": "<answered_at>",
"name": {
"first": "<first>",
"short": "<short>"
},
"not_yet": {
"reason": "open_order",
"note": "Added at the front desk",
"at": "<at>"
},
"records": {
"details": {
"name": true,
"email": true,
"phone": true,
"address": true
},
"orders": 0,
"paidOrders": 0,
"messages": 0,
"stamps": 0,
"notes": 0
},
"delete": {
"can_delete": true,
"block": "open_order",
"open": "<open>"
},
"send_to": "<send_to>"
}
}Dark behind SHOP_ANSWERS_DATA_REQUESTS and SHOP_FORGET_ENABLED (off: 404). Merchant sign-in, same origin; another store’s request is a 404. It never closes the request: the clock keeps running and it stays on Home.
The shop answering (also authorises the merchant).
Supplied by the URL PATH.
Only reasons the law accepts.
open_orderopen_disputeotherSomething else: say why in a line (160 characters kept).
copy: a copy of her data here. delete: delete her details here.
copydeletesent: open, with the shop. answered: done.
sentansweredrefusedwithdrawnHow she is named to the shop: never more than her first name and an initial.
"Kye".
"Kye E": her first name and an initial.
The shop’s last "I can’t yet". The request stays open.
open_orderopen_disputeotherWhat this shop holds about her, counted from the same records her copy is made of.
Orders she paid for: these stay, without her name, for the accounts.
The shop’s own notes on her.
An open delete request: whether her details can go now, and why not.
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_recordsSomething of hers still to happen here.
A copy goes only here: her proved email, masked.
curl -X POST "https://www.membber.com/api/v1/shop-data-requests/295c940a-0000-4000-8000-d0c500000029/not-yet" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"store_id": "6659c139-0000-4000-8000-d0c500000066",
"reason": "open_order"
}'import { createMembberClient } from "@membber/sdk-ts";
const membber = createMembberClient({
getAccessToken: () => process.env.MEMBBER_TOKEN,
});
const { data, error } = await membber.raw.POST("/api/v1/shop-data-requests/{requestId}/not-yet", {
params: { path: { requestId: "295c940a-0000-4000-8000-d0c500000029" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066",
reason: "open_order"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
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.notYetShopDataRequest(
path: .init(requestId: "295c940a-0000-4000-8000-d0c500000029"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066",
reason: .openOrder
))
).ok.body.json
print(response){
"request": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "copy",
"status": "sent",
"sent_at": "<sent_at>",
"reply_by": "<reply_by>",
"days_left": 0,
"answered_at": "<answered_at>",
"name": {
"first": "<first>",
"short": "<short>"
},
"not_yet": {
"reason": "open_order",
"note": "Added at the front desk",
"at": "<at>"
},
"records": {
"details": {
"name": true,
"email": true,
"phone": true,
"address": true
},
"orders": 0,
"paidOrders": 0,
"messages": 0,
"stamps": 0,
"notes": 0
},
"delete": {
"can_delete": true,
"block": "open_order",
"open": "<open>"
},
"send_to": "<send_to>"
}
}Dark behind SHOP_ANSWERS_DATA_REQUESTS (off: 404). Merchant sign-in, same origin; another store’s request is a 404. It goes only to the address she proved, never one the shop can type. A second press sends nothing more.
The shop answering (also authorises the merchant).
Supplied by the URL PATH.
done: this press did it. already: it was done. refused: it can’t be now.
donealreadyrefusedcopy: a copy of her data here. delete: delete her details here.
copydeletesent: open, with the shop. answered: done.
sentansweredrefusedwithdrawnHow she is named to the shop: never more than her first name and an initial.
"Kye".
"Kye E": her first name and an initial.
The shop’s last "I can’t yet". The request stays open.
open_orderopen_disputeotherWhat this shop holds about her, counted from the same records her copy is made of.
Orders she paid for: these stay, without her name, for the accounts.
The shop’s own notes on her.
An open delete request: whether her details can go now, and why not.
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_recordsSomething of hers still to happen here.
A copy goes only here: her proved email, masked.
curl -X POST "https://www.membber.com/api/v1/shop-data-requests/295c940a-0000-4000-8000-d0c500000029/send-copy" \
-H "Authorization: Bearer $MEMBBER_TOKEN" \
-H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
-H "Content-Type: application/json" \
-d '{
"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.POST("/api/v1/shop-data-requests/{requestId}/send-copy", {
params: { path: { requestId: "295c940a-0000-4000-8000-d0c500000029" } },
body: {
store_id: "6659c139-0000-4000-8000-d0c500000066"
},
headers: { "Idempotency-Key": crypto.randomUUID() },
});
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.sendShopDataRequestCopy(
path: .init(requestId: "295c940a-0000-4000-8000-d0c500000029"),
body: .json(.init(
storeId: "6659c139-0000-4000-8000-d0c500000066"
))
).ok.body.json
print(response){
"outcome": "done",
"request": {
"id": "00000d1b-0000-4000-8000-d0c500000000",
"kind": "copy",
"status": "sent",
"sent_at": "<sent_at>",
"reply_by": "<reply_by>",
"days_left": 0,
"answered_at": "<answered_at>",
"name": {
"first": "<first>",
"short": "<short>"
},
"not_yet": {
"reason": "open_order",
"note": "Added at the front desk",
"at": "<at>"
},
"records": {
"details": {
"name": true,
"email": true,
"phone": true,
"address": true
},
"orders": 0,
"paidOrders": 0,
"messages": 0,
"stamps": 0,
"notes": 0
},
"delete": {
"can_delete": true,
"block": "open_order",
"open": "<open>"
},
"send_to": "<send_to>"
}
}