🛍️Orders

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.

Orders require an order customer to be attached to it. If it's a new customer, first create a customer entry via the Create Customer API and then proceed to create a new order for that customer.

Create order

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

Creates a new sales order in your tenant.

Request Body

Create Order

POSThttps://app.ninjapipe.com/api/v1/orders/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/orders/create', {
    method: 'POST',
    headers: {
      "Authorization": "noauth <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "order_id": "#A12345XYZ",
      "client_id": 1024,
      "description": "<p>Office Chair - Brown</p>",
      "amount": 239.99,
      "status": "Processing",
      "__$markdownParsed": true
    }),
});
const data = await response.json();

Update an order

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

Update Order

PUThttps://app.ninjapipe.com/api/v1/orders/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/orders/update', {
    method: 'PUT',
    headers: {
      "Authorization": "noauth <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 7,
      "order_id": "#A12345XYZ",
      "client_id": 1024,
      "description": "<p>Office Chair - Brown</p>",
      "amount": 239.99,
      "status": "Processing",
      "__$markdownParsed": true
    }),
});
const data = await response.json();

Get order

GEThttps://app.ninjapipe.com/v1/orders/get?id={order_id}

Get Order

GEThttps://app.ninjapipe.com/api/v1/orders/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/orders/get', {
    method: 'GET',
    headers: {
      "Authorization": "noauth <token>"
    },
});
const data = await response.json();

Get all orders

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

Get All Orders

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

Authorization

noauthAuth

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

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

Delete order

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