Retrieve Customer Information

GET 
/customers

(🚧 in development) This endpoint retrieves information about customers in the system.

The system searches for customers based on the provided customerIds[], and optionally shopId. If shopId is not provided, the system searches for customers linked directly to the company.

Request

Query Parameters

customerIds[] string[]required

An array of customer identifiers in the merchant's system.

shopId string

The unique identifier of the shop within the merchant company. If not provided, the system searches for customers linked directly to the company.

Responses

200

Customer information retrieved successfully.

application/json

Schema

Schema

shopId stringnullable

Shop identifier. If this is null instead of a shop ID, it means the customer is associated with the company rather than a specific shop.

customers object[]required
List of customer information.
Array [
customerId stringrequired
The unique identifier of the customer, either provided by the merchant's system or generated by our system if the customerId was not specified in the request.
firstName stringrequired
The first name of the customer.
lastName stringrequired
The last name of the customer.
middleName stringnullable
The middle name of the customer, if provided.
phone stringnullable
The customer's phone number.
email stringrequired
The customer's email address.
]

Example (from schema)

{
  "shopId": "456",
  "customers": [
    {
      "customerId": "cust789",
      "firstName": "John",
      "lastName": "Doe",
      "middleName": "A",
      "phone": "+1234567890",
      "email": "john.doe@example.com"
    }
  ]
}

Loading...