API referenceShop data requests

Shop data requests

5 operations. Every schema and example on this page is generated from the platform contract.

This shop’s open data requests from signed-in shoppers: the card at the top of Home.

Dark behind SHOP_ANSWERS_DATA_REQUESTS (off: 404). Merchant sign-in, this store only. Never cached.

Parameters

store_idstring · uuidqueryrequired

The shop answering (also authorises the merchant).

Response, 200

requestsarray of objectrequired

Open ones, the soonest due first.

6 child fields
idstring · uuidrequired
kindenumrequired

copy: a copy of her data here. delete: delete her details here.

copydelete
nameobjectrequired

How she is named to the shop: never more than her first name and an initial.

2 child fields
firststringrequired

"Kye".

shortstringrequired

"Kye E": her first name and an initial.

sent_atstringrequired
reply_bystringrequired

The day the law says the shop answers by: one month after she asked.

days_leftintegerrequired
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"
Response, 200
{
  "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
    }
  ]
}

One data request: what would go, what would stay, anything still open; or what her copy holds.

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.

Parameters

requestIdstringpathrequired
store_idstring · uuidqueryrequired

The shop answering (also authorises the merchant).

requestIdstringqueryoptional

Supplied by the URL PATH.

Response, 200

requestobjectrequired
12 child fields
idstring · uuidrequired
kindenumrequired

copy: a copy of her data here. delete: delete her details here.

copydelete
statusenumrequired

sent: open, with the shop. answered: done.

sentansweredrefusedwithdrawn
sent_atstringrequired
reply_bystringrequired
days_leftintegerrequired
answered_atstring, nullablerequired
nameobjectrequired

How she is named to the shop: never more than her first name and an initial.

2 child fields
firststringrequired

"Kye".

shortstringrequired

"Kye E": her first name and an initial.

not_yetobjectrequired

The shop’s last "I can’t yet". The request stays open.

3 child fields
reasonenumrequired
open_orderopen_disputeother
notestring, nullablerequired
atstringrequired
recordsobjectrequired

What this shop holds about her, counted from the same records her copy is made of.

6 child fields
detailsobjectrequired
4 child fields
namebooleanrequired
emailbooleanrequired
phonebooleanrequired
addressbooleanrequired
ordersintegerrequired
paidOrdersintegerrequired

Orders she paid for: these stay, without her name, for the accounts.

messagesintegerrequired
stampsintegerrequired
notesintegerrequired

The shop’s own notes on her.

deleteobjectrequired

An open delete request: whether her details can go now, and why not.

3 child fields
can_deletebooleanrequired
blockenumrequired
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_records
openanyrequired

Something of hers still to happen here.

send_tostring, nullablerequired

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"
Response, 200
{
  "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>"
  }
}

Delete her details at this shop only, answer her request, and email her that it’s done.

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.

Parameters

requestIdstringpathrequired

Request body

store_idstring · uuidrequired

The shop answering (also authorises the merchant).

requestIdstringoptional

Supplied by the URL PATH.

Response, 200

outcomeenumrequired

done: this press did it. already: it was done. refused: it can’t be now.

donealreadyrefused
requestobjectrequired
12 child fields
idstring · uuidrequired
kindenumrequired

copy: a copy of her data here. delete: delete her details here.

copydelete
statusenumrequired

sent: open, with the shop. answered: done.

sentansweredrefusedwithdrawn
sent_atstringrequired
reply_bystringrequired
days_leftintegerrequired
answered_atstring, nullablerequired
nameobjectrequired

How she is named to the shop: never more than her first name and an initial.

2 child fields
firststringrequired

"Kye".

shortstringrequired

"Kye E": her first name and an initial.

not_yetobjectrequired

The shop’s last "I can’t yet". The request stays open.

3 child fields
reasonenumrequired
open_orderopen_disputeother
notestring, nullablerequired
atstringrequired
recordsobjectrequired

What this shop holds about her, counted from the same records her copy is made of.

6 child fields
detailsobjectrequired
4 child fields
namebooleanrequired
emailbooleanrequired
phonebooleanrequired
addressbooleanrequired
ordersintegerrequired
paidOrdersintegerrequired

Orders she paid for: these stay, without her name, for the accounts.

messagesintegerrequired
stampsintegerrequired
notesintegerrequired

The shop’s own notes on her.

deleteobjectrequired

An open delete request: whether her details can go now, and why not.

3 child fields
can_deletebooleanrequired
blockenumrequired
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_records
openanyrequired

Something of hers still to happen here.

send_tostring, nullablerequired

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"
  }'
Response, 200
{
  "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>"
  }
}

I can’t yet: tell her why, and that she can complain to the ICO. The request stays open.

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.

Parameters

requestIdstringpathrequired

Request body

store_idstring · uuidrequired

The shop answering (also authorises the merchant).

requestIdstringoptional

Supplied by the URL PATH.

reasonenumrequired

Only reasons the law accepts.

open_orderopen_disputeother
notestringoptional

Something else: say why in a line (160 characters kept).

Response, 200

requestobjectrequired
12 child fields
idstring · uuidrequired
kindenumrequired

copy: a copy of her data here. delete: delete her details here.

copydelete
statusenumrequired

sent: open, with the shop. answered: done.

sentansweredrefusedwithdrawn
sent_atstringrequired
reply_bystringrequired
days_leftintegerrequired
answered_atstring, nullablerequired
nameobjectrequired

How she is named to the shop: never more than her first name and an initial.

2 child fields
firststringrequired

"Kye".

shortstringrequired

"Kye E": her first name and an initial.

not_yetobjectrequired

The shop’s last "I can’t yet". The request stays open.

3 child fields
reasonenumrequired
open_orderopen_disputeother
notestring, nullablerequired
atstringrequired
recordsobjectrequired

What this shop holds about her, counted from the same records her copy is made of.

6 child fields
detailsobjectrequired
4 child fields
namebooleanrequired
emailbooleanrequired
phonebooleanrequired
addressbooleanrequired
ordersintegerrequired
paidOrdersintegerrequired

Orders she paid for: these stay, without her name, for the accounts.

messagesintegerrequired
stampsintegerrequired
notesintegerrequired

The shop’s own notes on her.

deleteobjectrequired

An open delete request: whether her details can go now, and why not.

3 child fields
can_deletebooleanrequired
blockenumrequired
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_records
openanyrequired

Something of hers still to happen here.

send_tostring, nullablerequired

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"
  }'
Response, 200
{
  "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>"
  }
}

Send her copy (this shop’s records of her only) to the email she proved, and answer her request.

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.

Parameters

requestIdstringpathrequired

Request body

store_idstring · uuidrequired

The shop answering (also authorises the merchant).

requestIdstringoptional

Supplied by the URL PATH.

Response, 200

outcomeenumrequired

done: this press did it. already: it was done. refused: it can’t be now.

donealreadyrefused
requestobjectrequired
12 child fields
idstring · uuidrequired
kindenumrequired

copy: a copy of her data here. delete: delete her details here.

copydelete
statusenumrequired

sent: open, with the shop. answered: done.

sentansweredrefusedwithdrawn
sent_atstringrequired
reply_bystringrequired
days_leftintegerrequired
answered_atstring, nullablerequired
nameobjectrequired

How she is named to the shop: never more than her first name and an initial.

2 child fields
firststringrequired

"Kye".

shortstringrequired

"Kye E": her first name and an initial.

not_yetobjectrequired

The shop’s last "I can’t yet". The request stays open.

3 child fields
reasonenumrequired
open_orderopen_disputeother
notestring, nullablerequired
atstringrequired
recordsobjectrequired

What this shop holds about her, counted from the same records her copy is made of.

6 child fields
detailsobjectrequired
4 child fields
namebooleanrequired
emailbooleanrequired
phonebooleanrequired
addressbooleanrequired
ordersintegerrequired
paidOrdersintegerrequired

Orders she paid for: these stay, without her name, for the accounts.

messagesintegerrequired
stampsintegerrequired
notesintegerrequired

The shop’s own notes on her.

deleteobjectrequired

An open delete request: whether her details can go now, and why not.

3 child fields
can_deletebooleanrequired
blockenumrequired
open_orderopen_balancepaid_membershipopen_giftnot_linkedtwo_records
openanyrequired

Something of hers still to happen here.

send_tostring, nullablerequired

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"
  }'
Response, 200
{
  "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>"
  }
}
WhatsApp
Book a Call
Get Started
Shop data requests API | Membber Developers