Get Customer
v1.0.0queriesQuery to fetch a single customer by their identifier.
1{
2 "$schema": "http://json-schema.org/draft-07/schema#",
3 "title": "GetCustomer",
4 "description": "Query to fetch a single customer by their identifier, and the customer returned",
5 "type": "object",
6 "properties": {
7 "request": {
8 "description": "Parameters used to look up the customer",
9 "type": "object",
10 "properties": {
11 "customerId": {
12 "description": "Unique identifier of the customer to fetch",
13 "type": "string",
14 "format": "uuid"
15 }
16 },
17 "required": ["customerId"]
18 },
19 "response": {
20 "description": "The customer returned by the query",
21 "type": "object",
22 "properties": {
23 "customerId": {
24 "type": "string",
25 "format": "uuid"
26 },
27 "email": {
28 "type": "string",
29 "format": "email"
30 },
31 "name": {
32 "type": "string"
33 },
34 "status": {
35 "type": "string",
36 "enum": ["ACTIVE", "SUSPENDED", "CLOSED"]
37 },
38 "registeredAt": {
39 "type": "string",
40 "format": "date-time"
41 }
42 },
43 "required": ["customerId", "email", "status"]
44 }
45 },
46 "required": ["request", "response"]
47}
48Details
- Format
- JSON Schema
- Resource
- queries
- Filename
- schema.json