Skip to main content
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"
      }
    }
  ]
}
'
import requests

url = "https://api.rootfi.dev/v3/ecommerce/customers"

payload = {
    "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"
            }
        }
    ]
}
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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'
        }
      }
    ]
  })
};

fetch('https://api.rootfi.dev/v3/ecommerce/customers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootfi.dev/v3/ecommerce/customers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.rootfi.dev/v3/ecommerce/customers"

	payload := strings.NewReader("{\n  \"company_id\": 1089,\n  \"data\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"\",\n      \"phone\": \"1234567890\",\n      \"currency_id\": \"1234567890\",\n      \"status\": \"ACTIVE\",\n      \"updated_at\": \"2024-01-22T05:07:31.465Z\",\n      \"created_at\": \"2024-01-22T05:07:31.465Z\",\n      \"address\": {\n        \"rootfi_id\": 278264,\n        \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n        \"street\": \"123 Main Street\",\n        \"locality\": \"Main Street\",\n        \"city\": \"New York\",\n        \"state\": \"New York\",\n        \"pincode\": \"123456\",\n        \"country\": \"USA\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.rootfi.dev/v3/ecommerce/customers")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"company_id\": 1089,\n  \"data\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"\",\n      \"phone\": \"1234567890\",\n      \"currency_id\": \"1234567890\",\n      \"status\": \"ACTIVE\",\n      \"updated_at\": \"2024-01-22T05:07:31.465Z\",\n      \"created_at\": \"2024-01-22T05:07:31.465Z\",\n      \"address\": {\n        \"rootfi_id\": 278264,\n        \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n        \"street\": \"123 Main Street\",\n        \"locality\": \"Main Street\",\n        \"city\": \"New York\",\n        \"state\": \"New York\",\n        \"pincode\": \"123456\",\n        \"country\": \"USA\"\n      }\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.rootfi.dev/v3/ecommerce/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"company_id\": 1089,\n  \"data\": [\n    {\n      \"name\": \"John Doe\",\n      \"email\": \"\",\n      \"phone\": \"1234567890\",\n      \"currency_id\": \"1234567890\",\n      \"status\": \"ACTIVE\",\n      \"updated_at\": \"2024-01-22T05:07:31.465Z\",\n      \"created_at\": \"2024-01-22T05:07:31.465Z\",\n      \"address\": {\n        \"rootfi_id\": 278264,\n        \"platform_id\": \"CONTACTS_1af68894-ea9f-ee11-be36-7c1e520f50bc_ADDRESS\",\n        \"street\": \"123 Main Street\",\n        \"locality\": \"Main Street\",\n        \"city\": \"New York\",\n        \"state\": \"New York\",\n        \"pincode\": \"123456\",\n        \"country\": \"USA\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "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"
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "field": "<string>"
  }
}
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

​
run_async
boolean | null

Run the request asynchronously

Response

​
data
ecommerceCustomerObject · object[]
required

The data of the customer endpoint

​
sync_id
string | null

The sync id of the request