API referenceAdmin data requests

Admin data requests

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

Data requests shops forwarded: the queue.

Internal-admin. Requests a buyer made to a Drops shop and the shop passed on, newest first: what they asked for, the shop, the name and address on their account, when it is due and whether the support inbox was told. A request for someone since erased is gone: the erasure takes it with them.

Parameters

viewenumqueryoptional

open (the default), closed or all.

openclosedall

Response, 200

requestsarray of objectrequired

Newest first, 200 at most.

14 child fields
idstringrequired
referencestringrequired

What the shop was shown, e.g. DR-1A2B3C4D.

kindenumrequired

copy: a copy of their details. remove: to be removed.

copyremove
statusenumrequired
heldcompletedrejectedcancelled
forwarded_atstringrequired
asked_onstring, nullablerequired

The day the buyer asked the shop, as the shop gave it.

answer_bystringrequired

YYYY-MM-DD: one month from the day they asked (or it was forwarded).

overduebooleanrequired

Still held after its answer-by day.

storeobjectrequired
2 child fields
idstringrequired
namestring, nullablerequired
customer_idstringrequired
personobjectrequired

The name and address on their Membber account when it was forwarded.

2 child fields
namestring, nullablerequired
emailstring, nullablerequired
emailedbooleanrequired

Whether the support inbox was told.

closed_atstring, nullablerequired
review_notestring, nullablerequired
open_countintegerrequired

How many are held, whatever the view.

curl -G "https://www.membber.com/api/v1/admin-data-requests" \
  -H "Authorization: Bearer $MEMBBER_TOKEN"
Response, 200
{
  "requests": [
    {
      "id": "00000d1b-0000-4000-8000-d0c500000000",
      "reference": "<reference>",
      "kind": "copy",
      "status": "held",
      "forwarded_at": "<forwarded_at>",
      "asked_on": "<asked_on>",
      "answer_by": "<answer_by>",
      "overdue": true,
      "store": {
        "id": "00000d1b-0000-4000-8000-d0c500000000",
        "name": "Example name"
      },
      "customer_id": "96607d1c-0000-4000-8000-d0c500000096",
      "person": {
        "name": "Example name",
        "email": "alex@example.com"
      },
      "emailed": true,
      "closed_at": "<closed_at>",
      "review_note": "Added at the front desk"
    }
  ],
  "open_count": 1
}

Data requests shops forwarded: close one.

Internal-admin. Records the outcome of a held request once a person has worked it. It runs nothing: the export or the erasure is done by hand first. Closing a request that is already closed answers it as it is. Audited.

Parameters

requestIdstringpathrequired

Request body

outcomeenumrequired

completed: answered (the copy was sent, or they were erased). rejected: it could not be verified.

completedrejected
notestringoptional

What was done, for the record.

Response, 200

requestobjectrequired
14 child fields
idstringrequired
referencestringrequired

What the shop was shown, e.g. DR-1A2B3C4D.

kindenumrequired

copy: a copy of their details. remove: to be removed.

copyremove
statusenumrequired
heldcompletedrejectedcancelled
forwarded_atstringrequired
asked_onstring, nullablerequired

The day the buyer asked the shop, as the shop gave it.

answer_bystringrequired

YYYY-MM-DD: one month from the day they asked (or it was forwarded).

overduebooleanrequired

Still held after its answer-by day.

storeobjectrequired
2 child fields
idstringrequired
namestring, nullablerequired
customer_idstringrequired
personobjectrequired

The name and address on their Membber account when it was forwarded.

2 child fields
namestring, nullablerequired
emailstring, nullablerequired
emailedbooleanrequired

Whether the support inbox was told.

closed_atstring, nullablerequired
review_notestring, nullablerequired
curl -X POST "https://www.membber.com/api/v1/admin-data-requests/295c940a-0000-4000-8000-d0c500000029/close" \
  -H "Authorization: Bearer $MEMBBER_TOKEN" \
  -H "Idempotency-Key: 1f0e2d3c-4b5a-4678-9abc-def012345678" \
  -H "Content-Type: application/json" \
  -d '{
    "outcome": "completed"
  }'
Response, 200
{
  "request": {
    "id": "00000d1b-0000-4000-8000-d0c500000000",
    "reference": "<reference>",
    "kind": "copy",
    "status": "held",
    "forwarded_at": "<forwarded_at>",
    "asked_on": "<asked_on>",
    "answer_by": "<answer_by>",
    "overdue": true,
    "store": {
      "id": "00000d1b-0000-4000-8000-d0c500000000",
      "name": "Example name"
    },
    "customer_id": "96607d1c-0000-4000-8000-d0c500000096",
    "person": {
      "name": "Example name",
      "email": "alex@example.com"
    },
    "emailed": true,
    "closed_at": "<closed_at>",
    "review_note": "Added at the front desk"
  }
}
WhatsApp
Book a Call
Start Free