Sales Order
Manage sales orders. Use action=“create” to create a sales record and optionally an order. Use action=“update” to update an order. Use action=“list” to search orders. Use action=“delete” to remove an order.
Input Schema
| Parameter | Type | Description |
|---|---|---|
| action | string | Action to perform on sales orders. Enum: create, list, update, delete |
| customer_id | string | Customer UUID |
| order_id | string | Order UUID (required for update/delete) |
| product_ids | array | Array of product UUIDs (for create) |
| payment_method | string | Payment method (e.g. card, transfer) |
| total_amount | number | Total amount |
| create_order | boolean | Create full order record |
| status | string | pending, completed, etc. |
| notes | string | Order notes |
| discount | number | Discount amount |
| tax | number | Tax amount |
| shipping_address | object | Shipping address |
| order_details | object | Additional order details |
| delivery_date | string | Delivery date (for update) |
| shipping_method | string | Shipping method (for update) |
| priority | string | Priority: low, medium, high (for update) |
| sale_id | string | Sale UUID (for list) |
| site_id | string | Site UUID (for list) |
| limit | number | Limit results |
| offset | number | Offset results |
REST Endpoint
Actions map to sub-routes: create → /create, list → /get, update → /update, delete → /delete.
POST /api/agents/tools/sales-order/create
POST /api/agents/tools/sales-order/get
POST /api/agents/tools/sales-order/update
POST /api/agents/tools/sales-order/deletePOST /api/agents/tools/sales-order/create
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"site_id": "YOUR_SITE_ID",
"customer_id": "CUSTOMER_UUID",
"product_ids": ["PRODUCT_UUID"],
"total_amount": 499.00,
"payment_method": "transfer",
"create_order": true
}Response:
{
"success": true,
"order": { "id": "...", "status": "pending", "total_amount": 499.00 }
}Last updated on