NinjaPipe Docs
API Documentation
Using NinjaPipeAPI Documentation
API Documentation
Using NinjaPipeAPI Documentation
  • 👋Welcome!
  • Quick Start
  • Reference
    • API Reference
      • 👥Contacts
      • ✅Tasks
        • ☑️Subtasks
      • 🛒Sales
        • 👤Order Customer
        • 🛍️Orders
      • Pipelines
Powered by GitBook
On this page
  1. Reference
  2. API Reference
  3. Sales

Orders

Create/Update/Get orders

PreviousOrder CustomerNextPipelines

Last updated 1 month ago

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

Update an order

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

Get order

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

Get all orders

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

Delete order

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

🛒
🛍️

Get Order

get
Authorizations
Query parameters
idintegeroptionalExample: 67
Header parameters
API_KEYstringoptionalExample: API_KEY
Responses
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

get
Authorizations
Header parameters
API_KEYstringoptionalExample: API_KEY
Responses
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
  • Before you start
  • Create order
  • POSTCreate Order
  • Update an order
  • PUTUpdate Order
  • Get order
  • GETGet Order
  • Get all orders
  • GETGet All Orders
  • Delete order

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

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
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
Create Customer API