Retrieve customer by id

Prev Next
Get
/customer-gateway/v1/customers/{customerId}

Retrieve a customer by id from the relevant Customer provider.

Security
HTTP
Type bearer
Path parameters
customerId
stringRequired
Responses
200

Requested customer

Expand All
object
data
object

Customer data model, including personal information and associated addresses.

Example{ "id": "01HMBSFWNJPQVTKMQPDEJ5R246", "email": "first.name@email.com", "firstName": "First", "lastName": "Name", "addresses": [ { "id": "01HMBSHYSN0H21ME0N7E8G7R1M", "line1": "Bento House", "line2": "Gousto Lane", "city": "London", "province": "London", "zipcode": "W14 0EE", "country": "United Kingdom" } ], "meta": { "joinedOn": "2022-07-15T00:00:00Z" } }
id
string

Unique customer identifier from the Customer Management System.

email
string

Customer's email address.

firstName
string

Customer's first name. May include multiple names for middle name support.

lastName
string

Customer's last name.

addresses
Array of object

List of addresses associated with the customer.

object
id
string

Unique identifier for the address. It may be unique per customer or per location.

line1
string

Primary address line, typically the building name or street address.

line2
string

Optional second address line, often used for additional street details.

line3
string

Optional third address line, used for specifying an area within a city.

city
string

City where the address is located.

province
string

Region where the address is located (e.g., county in the UK, state in the US, province in France).

zipcode
string

Postal code or ZIP code for the address.

country
string

Country where the address is located.

createdAt
string (date-time)

Timestamp indicating when the address was created.

updatedAt
string (date-time)

Timestamp indicating when the address was last updated.

meta
object

Metadata object for storing additional address-related information.

phone
string

Customer's phone number.

createdAt
string (date-time)

Timestamp indicating when the customer was created.

updatedAt
string (date-time)

Timestamp indicating when the customer was last updated.

meta
object

Metadata object for storing additional customer-related information.

meta
object

Additional information about the resource.

property*
400

Bad Request

Expand All
object
error
Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status
string

The HTTP status code applicable to the problem

title
string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail
string

A human-readable explanation specific to this occurrence of the problem.

401

Unauthorized

Expand All
object
error
Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status
string

The HTTP status code applicable to the problem

title
string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail
string

A human-readable explanation specific to this occurrence of the problem.

403

Forbidden

Expand All
object
error
Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status
string

The HTTP status code applicable to the problem

title
string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail
string

A human-readable explanation specific to this occurrence of the problem.

429

Too Many Requests

Expand All
object
error
Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status
string

The HTTP status code applicable to the problem

title
string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail
string

A human-readable explanation specific to this occurrence of the problem.

500

Internal Server Error

Expand All
object
error
Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status
string

The HTTP status code applicable to the problem

title
string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail
string

A human-readable explanation specific to this occurrence of the problem.

503

Service Unavailable

Expand All
object
error
Array of object

Details of problems encountered processing the request.

object

Details of a problem encountered processing the request.

status
string

The HTTP status code applicable to the problem

title
string

A short-human readable description of the problem, this should not change from occurrence to occurrence.

detail
string

A human-readable explanation specific to this occurrence of the problem.