Get patron

GET 
/patrons/:id

Get patron

Request

Path Parameters

idstringrequired
Example: guest

Query Parameters

currencystring
Example: usd
emailstring
Example: guest-buyer@example.com

200

Returns patron by UUID

objectstringrequired

idstringnullablerequired

emailstringrequired

firstNamestringrequired

lastNamestringrequired

totalAmountnumber<float>required

currencystringrequired

orderCountintegerrequired

createdAtstringrequired

updatedAtstringrequired

memberSincenullablerequired

metaobjectrequired

requestIdstringrequired

Example: returns_patron_by_uuid

{
  "object": "patron",
  "id": "cecceccd-ce9f-4b08-aa2f-8df7eccb0d70",
  "email": "jane-customer@example.com",
  "firstName": "Jane",
  "lastName": "Customer",
  "totalAmount": 75,
  "currency": "usd",
  "orderCount": 1,
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "memberSince": null,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

404

Returns 404 for non-existent patron

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_404_for_non-existent_patron

{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}