🛍️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/api/v1/orders/create
Creates a new sales order in your tenant.
Request Body
API_KEY{"order_id":"#A12345XYZ","client_id":1024,"description":"Office Chair - Brown","amount":239.99,"status":"Processing"}Successful response
POST /api/v1/orders/create HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 117
{
"order_id": "#A12345XYZ",
"client_id": 1024,
"description": "Office Chair - Brown",
"amount": 239.99,
"status": "Processing"
}Successful response
No content
Update an order
PUThttps://app.ninjapipe.com/api/v1/orders/update
API_KEY{"id":7,"order_id":"#A12345XYZ","client_id":1024,"description":"Office Chair - Brown","amount":239.99,"status":"Processing"}Successful response
PUT /api/v1/orders/update HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"id": 7,
"order_id": "#A12345XYZ",
"client_id": 1024,
"description": "Office Chair - Brown",
"amount": 239.99,
"status": "Processing"
}Successful response
No content
Get order
GEThttps://app.ninjapipe.com/api/v1/orders/get?id={order_id}
67API_KEYSuccessful response
GET /api/v1/orders/get HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
Successful response
No content
Get all orders
GEThttps://app.ninjapipe.com/api/v1/orders/getall
API_KEYSuccessful response
GET /api/v1/orders/getall HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
Successful response
No content
Delete order
Last updated