👤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/api/v1/customers/import

Create customer

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

Creates a new sales order customer in your tenant.

Request Body

Create Order Customer

post

Authorizations

Header parameters

API_KEYstringOptionalExample: API_KEY

Body

objectOptionalExample: {"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

200

Successful response

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/customers/create HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "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

Successful response

No content

Update a customer

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

Update Order Customer

put

Authorizations

Header parameters

API_KEYstringOptionalExample: API_KEY

Body

objectOptionalExample: {"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

200

Successful response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/customers/update HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 263

{
  "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

Successful response

No content

Get customer

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

Get Customer

get

Authorizations

Query parameters

idintegerOptionalExample: 919

Header parameters

API_KEYstringOptionalExample: API_KEY

Responses

200

Successful response

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customers/get HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Get all customers

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

Get All Order Customers

get

Header parameters

API_KEYstringOptionalExample: API_KEY

Responses

200

Successful response

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/customers/getall HTTP/1.1
Host: app.ninjapipe.com
Accept: */*

200

Successful response

No content

Delete customer

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