🛍️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
Authorizations
HTTPRequired
Header parameters
API_KEYstringOptionalExample:
API_KEYBody
objectOptionalExample:
{"order_id":"#A12345XYZ","client_id":1024,"description":"Office Chair - Brown","amount":239.99,"status":"Processing"}Responses
200
Successful response
application/json
post
/api/v1/orders/create200
Successful response
No content
Update an order
PUThttps://app.ninjapipe.com/api/v1/orders/update
Authorizations
HTTPRequired
Header parameters
API_KEYstringOptionalExample:
API_KEYBody
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
/api/v1/orders/update200
Successful response
No content
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
Last updated