Skip to main content
PUT
Update Order

Path Parameters

integer
required
The ID of the order to update

Request Body Parameters

number
Total amount for the order
number
Subtotal amount for the order
number
Tax amount for the order
number
Discount amount for the order
string
Coupon code applied to the order
string
Order status. Valid values: open, cancelled, completed
string
Payment status. Valid values: not_paid, partially_paid, fully_paid, processing, refunded, partially_refunded
string
Fulfillment status. Valid values: not_fulfilled, partially_fulfilled, fulfilled
string
Customer comment or notes for the order
string
Internal notes for the order
number
Discount amount from coupon
string
IP address of the customer
string
Source identifier for tracking
string
Source URL for tracking
string
Custom confirmation code
integer
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 payment
  • paid - Invoice has been fully paid
  • partially_paid - Invoice has been partially paid
  • draft - Invoice is in draft status
  • void - Invoice has been voided
  • uncollectible - 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.

Example Request

Example Response