7 September 2018
Orders
You can now apply financial changes after an Order has been placed with OrderEdits.
OrderEdits are wrappers that capture OrderUpdateActions which can create a preview of changes and apply them to the Order.
This feature is in beta BETA so we do not guarantee that the API is in its final shape.
- [API] New types OrderEdit, OrderEditDraft, StagedOrderUpdateAction, OrderEditResult, OrderExcerpt and OrderMessagePayload
- [API] New OrderEdit endpoint with functionality to create, update by ID, update by key, query, get by ID, get by key, apply, delete by ID and delete by key.
- [API] New OrderUpdateActions which only be performed via OrderEdits: setCountry, setShippingMethod, setCustomShippingMethod, addDiscountCode, removeDiscountCode, setCustomerGroup, setShippingMethodTaxRate, setShippingMethodTaxAmount, setOrderTotalTax, changeTaxMode, changeTaxRoundingMode, setShippingRateInput, changeTaxCalculationMode, addShoppingList, setShippingAddressAndShippingMethod, setShippingAddressAndCustomShippingMethod, addLineItem, removeLineItem, changeLineItemQuantity, setLineItemTaxRate, setLineItemTaxAmount, setLineItemTotalPrice, addCustomLineItem, removeCustomLineItem, setCustomLineItemTaxAmount, setCustomLineItemTaxRate, changeCustomLineItemQuantity, changeCustomLineItemMoney
- [API] New error code EditPreviewFailed
- [API] New Scopes
manage_order_edits:{projectKey}andview_order_edits:{projectKey} - [API] Get ShippingMethods for an OrderEdit