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 __Host-bottle.session_token=<__Host-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
contacts
Array<object>
object
key
additional properties
deliveryAddresses
required
Array<object>
object
key
additional properties
agreedPrices
required
Array<object>
object
key
additional properties
priceRules
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
workReports
Array<object>
object
key
additional properties
deliveryNotes
Array<object>
object
key
additional properties
partnerDeliveries
Array<object>
object
key
additional properties
cashTakings
required
Array<object>
object
key
additional properties
emails
required
Array<object>
object
key
additional properties
shopperAccounts
Array<object>
object
key
additional properties
depositRefunds
Array<object>
object
key
additional properties
marketingConsent
object
channels
required
Array<object>
object
channel
required
string
Allowed values: email sms phone post
state
required
string
Allowed values: granted withdrawn never_asked other_address unconfirmed
changedAt
required
string | null format: date-time
source
required
string | null
Allowed values: shop_signup shop_checkout shop_account office import api
by
required
string | null
email
required
string | null
history
required
Array<object>
object
id
required

UUID v7

string format: uuid
channel
required
string
Allowed values: email sms phone post
state
required
string
Allowed values: granted withdrawn unconfirmed
source
required
string
Allowed values: shop_signup shop_checkout shop_account office import api
method
required
string | null
Allowed values: phone in_person in_writing email other
by
required
string
byKind
required
string
Allowed values: staff customer system
wording
required
string | null
note
required
string | null
email
required
string | null
at
required
string format: date-time
usualDriverRecord
object
found
required
boolean
sampleSize
required
integer
refitAt
required
string format: date-time
usualOrderRecord
object
pairs
required
integer
refitAt
required
string format: date-time
plans
required
Array<object>
object
key
additional properties
memories
required
Array<object>
object
key
additional properties
memoryEvidence
required
Array<object>
object
key
additional properties
questions
required
Array<object>
object
key
additional properties
questionAnswers
required
Array<object>
object
key
additional properties

Example 

{
  "business": {
    "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
  },
  "marketingConsent": {
    "channels": [
      {
        "channel": "email",
        "state": "granted",
        "source": "shop_signup"
      }
    ],
    "history": [
      {
        "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
        "channel": "email",
        "state": "granted",
        "source": "shop_signup",
        "method": "phone",
        "byKind": "staff"
      }
    ]
  }
}

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"
    }
  ]
}