🛍️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

Create Order

post
Authorizations
Header parameters
API_KEYstringOptionalExample: API_KEY
Body
objectOptionalExample: {"order_id":"#A12345XYZ","client_id":1024,"description":"Office Chair - Brown","amount":239.99,"status":"Processing"}
Responses
200
Successful response
application/json
post
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"
}
200

Successful response

No content

Update an order

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

Update Order

put
Authorizations
Header parameters
API_KEYstringOptionalExample: API_KEY
Body
objectOptionalExample: {"id":7,"order_id":"#A12345XYZ","client_id":1024,"description":"Office Chair - Brown","amount":239.99,"status":"Processing"}
Responses
200
Successful response
application/json
put
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"
}
200

Successful response

No content

Get order

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

Get Order

get
Authorizations
Query parameters
idintegerOptionalExample: 67
Header parameters
API_KEYstringOptionalExample: API_KEY
Responses
200
Successful response
application/json
get
GET /api/v1/orders/get HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content

Get all orders

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

Get All Orders

get
Authorizations
Header parameters
API_KEYstringOptionalExample: API_KEY
Responses
200
Successful response
application/json
get
GET /api/v1/orders/getall HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content

Delete order

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

PreviousOrder CustomerNextPipelines

Last updated