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
canceled_at
DateThe date with timezone at which the edit was cancelled.
canceled_by
stringThe unique identifier of the user or customer who cancelled the order edit.
The details of all the changes on the original order's line items.
confirmed_at
DateThe date with timezone at which the edit was confirmed.
confirmed_by
stringThe unique identifier of the user or customer who confirmed the order edit.
created_at
DateRequiredThe date with timezone at which the resource was created.
created_by
stringRequiredThe unique identifier of the user or customer who created the order edit.
declined_at
DateThe date with timezone at which the edit was declined.
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.
difference_due
numberRequiredThe difference between the total amount of the order and total amount of edited order.
discount_total
numberRequiredThe total of discount
gift_card_tax_total
numberRequiredThe total of the gift card tax amount
gift_card_total
numberRequiredThe total of the gift card amount
id
stringRequiredThe order edit's ID
internal_note
stringAn optional note with additional details about 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.
The details of the order that this order edit was created for.
order_id
stringRequiredThe ID of the order that is edited
The details of the payment collection used to authorize additional payment if necessary.
payment_collection_id
stringRequiredThe ID of the payment collection
requested_at
DateThe date with timezone at which the edit was requested.
requested_by
stringThe unique identifier of the user or customer who requested the order edit.
shipping_total
numberRequiredThe total of the shipping amount
The status of the order edit.
subtotal
numberRequiredThe total of subtotal
tax_total
null | numberRequiredThe total of tax
total
numberRequiredThe total amount of the edited order.
updated_at
DateRequiredThe date with timezone at which the resource was updated.
Was this section helpful?