Path Parameters
The ID of the order to update
Request Body Parameters
Total amount for the order
Subtotal amount for the order
Tax amount for the order
Discount amount for the order
Coupon code applied to the order
Order status. Valid values:
open
, cancelled
, completed
Payment status. Valid values:
not_paid
, partially_paid
, fully_paid
, processing
, refunded
, partially_refunded
Fulfillment status. Valid values:
not_fulfilled
, partially_fulfilled
, fulfilled
Customer comment or notes for the order
Internal notes for the order
Discount amount from coupon
IP address of the customer
Source identifier for tracking
Source URL for tracking
Custom confirmation code
Customer ID (can be updated to transfer order to different customer)
Invoice Management
Orders can contain invoices that track payment obligations. When updating orders, you may also need to manage associated invoices.Valid Invoice Statuses
open
- Invoice is open and awaiting paymentpaid
- Invoice has been fully paidpartially_paid
- Invoice has been partially paiddraft
- Invoice is in draft statusvoid
- Invoice has been voideduncollectible
- Invoice is marked as uncollectible
Invoice Update Example
To update an invoice within an order, you can use the dedicated invoice endpoint:When updating invoice status to
paid
, ensure that the corresponding payment transactions are properly recorded in the system.