GET
/
ecommerce
/
customers
curl --request GET \
  --url https://api.rootfi.dev/v3/ecommerce/customers \
  --header 'api_key: <api-key>'
{
  "data": [
    {
      "address": {
        "city": "New York",
        "country": "USA",
        "locality": "Main Street",
        "pincode": "123456",
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "rootfi_id": 278264,
        "state": "New York",
        "street": "123 Main Street"
      },
      "created_at": "2024-01-22T05:07:31.465Z",
      "currency_id": "1234567890",
      "email": "",
      "name": "John Doe",
      "phone": "1234567890",
      "platform_id": "123456",
      "rootfi_company_id": 1089,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_id": 157,
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "status": "ACTIVE",
      "updated_at": "2024-01-22T05:07:31.465Z"
    }
  ],
  "next": "eyJyb291ZmlfaWQiOjQ0MDA2MX0=",
  "prev": "eyJyb290ZmlfaWQiOjQ0MDA2MX0=",
  "total_count": 123
}

The Customers Data Model is designed to streamline the management and retrieval of account-related information across various ecommerce platforms.

Authorizations

api_key
string
headerrequired

Query Parameters

limit
integer | null

The number of customers you want to retrieve

next
string | null

The next page of objects to retrieve

prev
string | null

The previous page of objects to retrieve

select
string | null

Comma separated fields to select. Supported values are raw_data, data_hash

rootfi_company_id[eq]
integer | null

Filter by rootfi_company_id

return_count
boolean | null

Return the count of the objects

sort[rootfi_created_at]
enum<string>

Sort by rootfi_created_at

Available options:
ASC,
DESC
sort[rootfi_updated_at]
enum<string>

Sort by rootfi_updated_at

Available options:
ASC,
DESC

Response

200 - application/json
next
string | null

The next page of objects to retrieve

prev
string | null

The previous page of objects to retrieve

total_count
integer | null

The total count of the objects

data
object[]
required