Retrieve a Consumer

curl --request GET \
  --url https://commerce.driv.ly/api/consumers/{id}

{
  "data": {
    "id": "<string>",
    "birthDate": "2023-12-25",
    "phoneNumber": "<string>",
    "lastName": "<string>",
    "firstName": "<string>",
    "addresses": [
      "<string>"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "email": "<string>",
    "ssn": "<string>"
  },
  "success": true
}

GET

consumers

{id}

Retrieve a Consumer

curl --request GET \
  --url https://commerce.driv.ly/api/consumers/{id}

{
  "data": {
    "id": "<string>",
    "birthDate": "2023-12-25",
    "phoneNumber": "<string>",
    "lastName": "<string>",
    "firstName": "<string>",
    "addresses": [
      "<string>"
    ],
    "phoneNumbers": [
      "<string>"
    ],
    "email": "<string>",
    "ssn": "<string>"
  },
  "success": true
}

Path Parameters

string

required

Customer is uniquely identified by id

Query Parameters

depth

integer

The number of levels of related objects to include in the response

Response

Consumer Found

data

Consumer · object

Show child attributes

data.id

string

required

Customer is uniquely identified by id

data.birthDate

string<date>

required

Consumer has Birth Date

data.phoneNumber

string

required

Consumer has Phone Number

data.lastName

string

required

Consumer has Last Name

data.firstName

string

required

Consumer has First Name

data.addresses

(string | Address · object)[]

Customer is located at Addresses

data.phoneNumbers

string[]

Customer has Phone Number

data.email

string<idn-email>

Consumer has Email

data.ssn

string

Consumer has SSN

success

boolean

Create a new Consumer Update an existing Consumer

⌘I

Services

Guides

API Reference

Retrieve a Consumer

Path Parameters

Query Parameters

Response