Create Customer

curl --request POST \
  --url https://api.rootfi.dev/v3/ecommerce/customers \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1089,
  "data": [
    {
      "name": "John Doe",
      "email": "",
      "phone": "1234567890",
      "currency_id": "1234567890",
      "status": "ACTIVE",
      "updated_at": "2024-01-22T05:07:31.465Z",
      "created_at": "2024-01-22T05:07:31.465Z",
      "address": {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "street": "123 Main Street",
        "locality": "Main Street",
        "city": "New York",
        "state": "New York",
        "pincode": "123456",
        "country": "USA"
      }
    }
  ]
}
'

{
  "data": [
    {
      "rootfi_id": 157,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "rootfi_company_id": 1089,
      "platform_id": "123456_1",
      "platform_unique_id": "123456",
      "name": "John Doe",
      "email": "",
      "phone": "1234567890",
      "currency_id": "1234567890",
      "status": "ACTIVE",
      "updated_at": "2024-01-22T05:07:31.465Z",
      "created_at": "2024-01-22T05:07:31.465Z",
      "address": {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "street": "123 Main Street",
        "locality": "Main Street",
        "city": "New York",
        "state": "New York",
        "pincode": "123456",
        "country": "USA"
      }
    }
  ],
  "sync_id": "1234567890"
}

POST

ecommerce

customers

Create Customer

curl --request POST \
  --url https://api.rootfi.dev/v3/ecommerce/customers \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "company_id": 1089,
  "data": [
    {
      "name": "John Doe",
      "email": "",
      "phone": "1234567890",
      "currency_id": "1234567890",
      "status": "ACTIVE",
      "updated_at": "2024-01-22T05:07:31.465Z",
      "created_at": "2024-01-22T05:07:31.465Z",
      "address": {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "street": "123 Main Street",
        "locality": "Main Street",
        "city": "New York",
        "state": "New York",
        "pincode": "123456",
        "country": "USA"
      }
    }
  ]
}
'

{
  "data": [
    {
      "rootfi_id": 157,
      "rootfi_deleted_at": null,
      "rootfi_created_at": "2024-01-22T05:07:31.465Z",
      "rootfi_updated_at": "2024-01-22T05:07:31.000Z",
      "rootfi_company_id": 1089,
      "platform_id": "123456_1",
      "platform_unique_id": "123456",
      "name": "John Doe",
      "email": "",
      "phone": "1234567890",
      "currency_id": "1234567890",
      "status": "ACTIVE",
      "updated_at": "2024-01-22T05:07:31.465Z",
      "created_at": "2024-01-22T05:07:31.465Z",
      "address": {
        "rootfi_id": 278264,
        "platform_id": "CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS",
        "street": "123 Main Street",
        "locality": "Main Street",
        "city": "New York",
        "state": "New York",
        "pincode": "123456",
        "country": "USA"
      }
    }
  ],
  "sync_id": "1234567890"
}

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

Authorizations

api_key

string

header

required

Body

application/json

company_id

integer

required

The ID of the company in the accounting platform

data

ecommerceCustomersFields · object[]

required

The data of the customer endpoint

Show child attributes

data.name

string | null

The name of the customer

data.email

string | null

The email of the customer

data.phone

string | null

The phone of the customer

data.currency_id

string | null

The currency of the customer

data.status

enum<string> | null

The status of the customer

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.updated_at

string | null

The updated_at of the customer

data.created_at

string | null

The created_at of the customer

data.address

ecommerceAddressObject · object

The address of the customer

Show child attributes

data.address.rootfi_id

integer | null

The RootFi ID of the customer

data.address.platform_id

string | null

The platform ID of the customer

data.address.street

string | null

The street of the address

data.address.locality

string | null

The locality of the address

data.address.city

string | null

The city of the address

data.address.state

string | null

The state of the address

data.address.pincode

string | null

The pincode of the address

data.address.country

string | null

The country of the address

run_async

boolean | null

Run the request asynchronously

Response

data

ecommerceCustomerObject · object[]

required

The data of the customer endpoint

Show child attributes

data.rootfi_id

number<double>

required

The unique ID we assign for that data's information

Example:

157

data.rootfi_created_at

string<date-time>

required

The date at which RootFi first synced this data

Example:

"2024-01-22T05:07:31.465Z"

data.rootfi_updated_at

string<date-time>

required

The latest date at which RootFi updated this data

Example:

"2024-01-22T05:07:31.000Z"

data.rootfi_company_id

number<double>

required

The ID of the company in the accounting platform

Example:

1089

data.platform_id

string

required

An unique custom RootFi ID made from platform's unique_id.

Example:

"123456"

data.rootfi_deleted_at

string<date-time> | null

The date at which the data was deleted in the accounting platform

data.platform_unique_id

string | null

The ID of the data in the accounting platform.

data.raw_data

object

A JSON containing fields that you can directly get from the accounting platform.

data.data_hash

string | null

The hash of the data

data.name

string | null

The name of the customer

data.email

string | null

The email of the customer

data.phone

string | null

The phone of the customer

data.currency_id

string | null

The currency of the customer

data.status

enum<string> | null

The status of the customer

Available options:

ACTIVE,

ARCHIVED,

UNKNOWN

data.updated_at

string | null

The updated_at of the customer

data.created_at

string | null

The created_at of the customer

data.address

ecommerceAddressObject · object

The address of the customer

Show child attributes

data.address.rootfi_id

integer | null

The RootFi ID of the customer

data.address.platform_id

string | null

The platform ID of the customer

data.address.street

string | null

The street of the address

data.address.locality

string | null

The locality of the address

data.address.city

string | null

The city of the address

data.address.state

string | null

The state of the address

data.address.pincode

string | null

The pincode of the address

data.address.country

string | null

The country of the address

sync_id

string | null

The sync id of the request

Get All Customers Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Create Customer

Authorizations

Body

Response