👤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

POSThttps://app.ninjapipe.com/api/v1/customers/create

Authorization

noauthAuth

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/customers/create', {
    method: 'POST',
    headers: {
      "Authorization": "noauth <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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]"
    }),
});
const data = await response.json();

Update a customer

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

Update Order Customer

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

Authorization

noauthAuth

Header parameters

Body

application/json

object

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/customers/update', {
    method: 'PUT',
    headers: {
      "Authorization": "noauth <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "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]"
    }),
});
const data = await response.json();

Get customer

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

Get Customer

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

Authorization

noauthAuth

Query parameters

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/customers/get', {
    method: 'GET',
    headers: {
      "Authorization": "noauth <token>"
    },
});
const data = await response.json();

Get all customers

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

Get All Order Customers

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

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://app.ninjapipe.com/api/v1/customers/getall', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Delete customer

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