Skip to content
Bottle

Export a customer's data

GET
/customers/{id}/data
curl --request GET \
  --url https://example.com/customers/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/data \
  --cookie bottle.session_token=<bottle.session_token>

What a subject access request asks for: the customer, their addresses, their agreed rates and every order, as held. Readable by anything that can already read customers, since it adds no access, only convenience.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Responses

Section titled “Responses”

200

Section titled “200”

The file

Media typeapplication/json
object
exportedAt
required
string format: date-time
business
required
object
id
required

UUID v7

string format: uuid
name
required
string
customer
required
object
key
additional properties
deliveryAddresses
required
Array<object>
object
key
additional properties
agreedPrices
required
Array<object>
object
key
additional properties
orders
required
Array<object>
object
key
additional properties
invoices
required
Array<object>
object
key
additional properties
deliveries
required
Array<object>
object
key
additional properties
deliveryProofs
required
Array<object>
object
key
additional properties
cashTakings
required
Array<object>
object
key
additional properties
emails
required
Array<object>
object
key
additional properties
Example
{
  "business": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  }
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}