Order Drafts API Overview

Order drafts let you make incremental modifications to the order without immediately committing those changes. You can use order drafts to make order item adjustments, change item quantities, or apply additional coupons or discounts. You cannot make changes to an order payment, package, shipment, or pickup using order drafts.

Kibo eCommerce stores the order draft separately from the original order, but the draft maintains a link to the original order. When performing the GetOrder operation, you can choose to retrieve the draft or the original using the draft parameter.

After either you or a shopper create an order, you can use the following Kibo eCommerce API order operations to create or update an order draft:

When you update an order draft, you can perform any of the following actions:

Apply to draft This action saves and applies any modifications made to the existing draft. If the draft includes previously saved modifications, the new modifications are added to the draft.

To perform this action, run the UpdateOrder operation and set the updateMode parameter to ApplyToDraft.
Apply to original This action saves and applies any modifications made to the draft to the original order and deletes the existing draft. If the draft included any previously saved modifications, these modifications are lost.

To perform this action, run the UpdateOrder operation and set the updateMode parameter to ApplyToOriginal.
Apply and commit This action applies all new and prior modifications associated with the draft to the original order and deletes the existing draft.

To perform this action, run the UpdateOrder operation and set the updateMode parameter to ApplyAndCommit.

Each time you save an order draft as the original, or apply and commit the order draft, Kibo eCommerce creates a new version of the order and increments the version number by one. If multiple users make simultaneous modifications to an order draft, Kibo eCommerce applies the modifications to the draft based on the first user to save or commit the changes.