👤Order Customer

Create/Update/Get orders

Before you start

Orders are any sales-related orders placed by your customers that you would like to track in NinjaPipe Sales dashboard.

You can also import your existing contacts from the CRM as customers. Contacts in the CRM and the customers in your sales are two separate entities. However, you can always import contacts from the CRM as a customer via the import API.

Import from CRM

Use this API to import an existing contact from the CRM to the sales dashboard as a sales customer.

POST https://app.ninjapipe.com/v1/customers/import

Create customer

POST https://app.ninjapipe.com/v1/customers/create

Creates a new sales order customer in your tenant.

Request Body

Create Order Customer

post

/api/v1/customers/create

Authorizations

Header parameters

API_KEYstring

Example: API_KEY

Body

object

Example: {"full_name":"Emily Johnson","gender":"Female","picture_url":"https://cdn.pixabay.com/photo/2016/03/31/19/57/avatar-1295404_1280.png","email":"[e-mail]","organization":"Tech Solutions Inc.","phone_number":"[phone]"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.ninjapipe.com/api/v1/customers/create' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"full_name":"Emily Johnson","gender":"Female","picture_url":"https://cdn.pixabay.com/photo/2016/03/31/19/57/avatar-1295404_1280.png","email":"[e-mail]","organization":"Tech Solutions Inc.","phone_number":"[phone]"}'

200

200

No body

Successful response

Update a customer

PUThttps://app.ninjapipe.com/v1/customers/update

Update Order Customer

put

/api/v1/customers/update

Authorizations

Header parameters

API_KEYstring

Example: API_KEY

Body

object

Example: {"id":919,"tenant_id":1,"full_name":"Emily Johnson","gender":"Female","picture_url":"https://cdn.pixabay.com/photo/2016/03/31/19/57/avatar-1295404_1280.png","email":"[e-mail]","organization":"Tech Solutions Inc.","phone_number":"[phone]"}

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app.ninjapipe.com/api/v1/customers/update' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"id":919,"tenant_id":1,"full_name":"Emily Johnson","gender":"Female","picture_url":"https://cdn.pixabay.com/photo/2016/03/31/19/57/avatar-1295404_1280.png","email":"[e-mail]","organization":"Tech Solutions Inc.","phone_number":"[phone]"}'

200

200

No body

Successful response

Get customer

GEThttps://app.ninjapipe.com/v1/customers/get?id={customer_id}

Get Customer

get

/api/v1/customers/get

Authorizations

Query parameters

idinteger

Example: 919

Header parameters

API_KEYstring

Example: API_KEY

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ninjapipe.com/api/v1/customers/get' \
  --header 'Authorization: noauth YOUR_SECRET_TOKEN'

200

200

No body

Successful response

Get all customers

GEThttps://app.ninjapipe.com/v1/customers/getall

Get All Order Customers

get

/api/v1/customers/getall

Header parameters

API_KEYstring

Example: API_KEY

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.ninjapipe.com/api/v1/customers/getall'

200

200

No body

Successful response

Delete customer

Currently, deleting a customer is not supported via the API. You may use the web or mobile platform to initiate a deletion