Endpoints Specifications

Type Name Description Function Auth Parameters
GET /orders/get/:id Retrieves the order from the database with the given ID. GetOrder API Key Order ID
Type: Integer
GET /orders/all/:user_id Retrieves all orders for a user from the database. GetOrders API Key User ID
Type: Integer
GET /orders/items/get/:id Retrieves the order item from the database with the given ID. GetOrderItem API Key Order Item ID
Type: Integer
GET /orders/items/all/:order_id Retrieves all order items for an order from the database. GetOrderItems API Key Order ID
Type: Integer
GET /orders/detailed/get/:order_id Retrieves the order with order items from the database with the given ID. GetDetailedOrder API Key Order ID
Type: Integer
GET /orders/detailed/all/:user_id Retrieves all orders with order items for a user from the database. GetDetailedOrders API Key User ID
Type: Integer
POST /orders/detailed/add Adds a new order with order items to the database. AddDetailedOrder API Key Detailed Order object
POST /orders/add Inserts an order into the database. AddOrder API Key Order object
POST /orders/items/add Inserts an order item into the database. AddOrderItem API Key Order Item object
PUT /orders/update Updates an order in the database. UpdateOrder API Key Order object
PUT /orders/items/update Updates an order item in the database. UpdateOrderItem API Key Order Item object
DELETE /orders/items/delete/:id Deletes an order item from the database. DeleteOrderItem API Key Order Item ID
Type: Integer
DELETE /orders/delete/:id/user/:user_id Deletes an order from the database. DeleteOrder API Key Order ID
Type: Integer

Endpoints Return Data Specifications

For endpoints that return details of a single order

For endpoints that return details of multiple orders

For endpoints that return a single order item

For endpoints that return multiple order items

For endpoints that return detailed order (order + order items)

For endpoints that return multiple detailed orders

Endpoints Request Parameter Specifications

For deleting or updating order

For adding new order

For deleting or updating order item

For adding new order item

For adding new order with order items (detailed order)