Skip to main content
POST
/
retailer
/
{retailerId}
/
customers
Manage Customers
curl --request POST \
  --url https://api.example.com/retailer/{retailerId}/customers
Perform bulk customer management operations for a retailer, including search, import, and status updates.

​
Authentication

Requires a valid Retailer JWT or Admin JWT. Bulk operations require the CustomerManagementGuard.

​
Path Parameters

ParameterTypeRequiredDescription
retailerIdstringYesThe retailer’s UUID

​
Request Body

{
  "operation": "search",
  "filters": {
    "email": "customer@example.com"
  },
  "pagination": {
    "page": 1,
    "limit": 50
  }
}
FieldTypeRequiredDescription
operationstringYesOperation type: search, import, update
filtersobjectNoFilter criteria for search
paginationobjectNoPagination options

​
Response

{
  "data": [
    {
      "id": "uuid",
      "email": "customer@example.com",
      "lastPurchaseDate": "2024-02-28T10:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 50,
    "total": 8450
  }
}