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

idstringRequired

The order edit's ID

created_atDateRequired

The date with timezone at which the resource was created.

updated_atDateRequired

The date with timezone at which the resource was updated.

order_idstringRequired

The ID of the order that is edited

orderOrderRequired

The details of the order that this order edit was created for.

changesOrderItemChange[]Required

The details of all the changes on the original order's line items.

created_bystringRequired

The unique identifier of the user or customer who created the order edit.

itemsLineItem[]Required

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_idstringRequired

The ID of the payment collection

payment_collectionPaymentCollectionRequired

The details of the payment collection used to authorize additional payment if necessary.

shipping_totalnumberRequired

The total of the shipping amount

discount_totalnumberRequired

The total of discount

tax_totalnull | numberRequired

The total of tax

totalnumberRequired

The total amount of the edited order.

subtotalnumberRequired

The total of subtotal

gift_card_totalnumberRequired

The total of the gift card amount

gift_card_tax_totalnumberRequired

The total of the gift card tax amount

difference_duenumberRequired

The difference between the total amount of the order and total amount of edited order.

statusOrderEditStatusRequired

The status of the order edit.

internal_notestring

An optional note with additional details about the order edit.

requested_bystring

The unique identifier of the user or customer who requested the order edit.

requested_atDate

The date with timezone at which the edit was requested.

confirmed_bystring

The unique identifier of the user or customer who confirmed the order edit.

confirmed_atDate

The date with timezone at which the edit was confirmed.

declined_bystring

The unique identifier of the user or customer who declined the order edit.

declined_reasonstring

An optional note why the order edit is declined.

declined_atDate

The date with timezone at which the edit was declined.

canceled_bystring

The unique identifier of the user or customer who cancelled the order edit.

canceled_atDate

The date with timezone at which the edit was cancelled.