OrderEdit
Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.
Properties
id
stringRequiredThe order edit's ID
created_at
DateRequiredThe date with timezone at which the resource was created.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
order_id
stringRequiredThe ID of the order that is edited
The details of the order that this order edit was created for.
The details of all the changes on the original order's line items.
created_by
stringRequiredThe unique identifier of the user or customer who created the order edit.
The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.
payment_collection_id
stringRequiredThe ID of the payment collection
The details of the payment collection used to authorize additional payment if necessary.
shipping_total
numberRequiredThe total of the shipping amount
discount_total
numberRequiredThe total of discount
tax_total
null | numberRequiredThe total of tax
total
numberRequiredThe total amount of the edited order.
subtotal
numberRequiredThe total of subtotal
gift_card_total
numberRequiredThe total of the gift card amount
gift_card_tax_total
numberRequiredThe total of the gift card tax amount
difference_due
numberRequiredThe difference between the total amount of the order and total amount of edited order.
The status of the order edit.
internal_note
stringAn optional note with additional details about the order edit.
requested_by
stringThe unique identifier of the user or customer who requested the order edit.
requested_at
DateThe date with timezone at which the edit was requested.
confirmed_by
stringThe unique identifier of the user or customer who confirmed the order edit.
confirmed_at
DateThe date with timezone at which the edit was confirmed.
declined_by
stringThe unique identifier of the user or customer who declined the order edit.
declined_reason
stringAn optional note why the order edit is declined.
declined_at
DateThe date with timezone at which the edit was declined.
canceled_by
stringThe unique identifier of the user or customer who cancelled the order edit.
canceled_at
DateThe date with timezone at which the edit was cancelled.
Was this section helpful?