Changes the sale's payment status. The payment status only marks whether money has been received from the customer: it does not affect stock, amounts or the sale status.
v1/orders/update_payment.php
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| order_id | int | Yes | Sale ID |
| status | int | Yes | Payment status: 0 — Unpaid, 1 — Partially paid, 2 — Paid |
The payment status is shown in the sales list if Show sale payment status is on under Settings → General. Via the API it is changed and returned regardless of that setting.
Example request
{
"order_id": 43727,
"status": 2
}
Example response
{
"success": true
}
Errors
| Error | Reason |
|---|---|
| No order_id in input | A required field is missing (instead of order_id, the field's name) |
| Invalid payment status value. Must be one of: 0, 1, 2 | Invalid payment status |
| Order not found or access denied | Sale not found or deleted |