This request allows you to update existing orders in an Ecwid store. When updating order information, you can omit unchanged fields – they will be ignored so the resulting order will keep the corresponding information unchanged.
However, please mind that if you want to update the ordered items, you should submit all the items in the request. The omitted items will be removed. This is done this way to let you remove some purchased items from the order.
Access scopes required: read_orders and update_orders
oAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.
A JSON object of type 'Order' with the following fields:
Order subtotal. Includes the sum of all products' cost in the order (item's price x quantity)
Order total cost. Includes shipping, taxes, discounts, etc.
Customer email address
Payment method name
Payment processor name
Tax total for order. Sum of all tax in order items, unless they were modified after order was placed
true if customer is tax exempt, false otherwise. Learn more
Customer tax ID
true if customer tax ID is valid, false otherwise
true if order tax was set to 0 because customer specified their valid tax ID in checkout process. false otherwise
Order type: business-to-business (b2b) or business-to-consumer (b2c)
true if customer requested an invoice, false otherwise
URL of the page when order was placed (without hash (#) part)
Customer's order comments, specified at checkout
Sum of discounts based on subtotal. Is included into the discount field
Unique customer internal ID (if the order is placed by a registered user)
Determines if the order is hidden (removed from the list). Applies to unfinished orders only.
Sum of discounts based on customer group. Is included into the discount field
The sum of discount based on subtotal AND customer group. Is included into the discount field
The sum of all applied discounts except for the coupon discount. To get the total order discount, take the sum of couponDiscount and discount field values. Total order discount is a sum of all discounts applied to items (both regular discount and discount coupons) unless they were modified after order was placed
URL that the customer came to the store from
The name of group (membership) the customer belongs to
Information about applied coupon
Name and billing address of the customer
Name and address of the person entered in shipping information
Information about selected shipping option
Handling fee details
Additional order information if any (reserved for future use)
Additional payment parameters entered by customer on checkout, e.g. PO number in "Purchase order" payments
Information about applied discounts (coupons are not included)
Shipping tracking code
Message from the payment processor if any. It is present and visible in order details only if order status is not paid. When order becomes paid, paymentMessage is cleared
Transaction ID / invoice number of the order in the payment system (e.g. PayPal transaction ID)
The status of credit card payment
Private note about the order from store owner
Information about order extra fields, both internal and custom fields added from Control Panel or by applications
Order pickup time in the store date format, e.g.: "2017-10-17 05:00:00 +0000"
Taxes applied to shipping. null for old orders,  for orders with taxes applied to subtotal only. Are not recalculated if order is updated later manually. Is calculated like: (shippingRate + handlingFee)*(taxValue/100)
true if customer has accepted email marketing and you can use their email for promotions. If value is false, you can't use this email for promotions
Referer identifier. Can be set in storefront via JS or by creating / updating an order with REST API
true if no email notifications are sent to customer. If false or empty, then email notifications are sent to customer according to store mail notification settings. This field does not influence admin email notifications
Set true if order is fulfilled in an external system; Ecwid will hide fulfillment status change feature and ability to set tracking number within Ecwid Control Panel in order details. Set false to manage order fulfillment within Ecwid Control Panel
UTM parameters tracked for the order. See more details in Help Center
Corresponding order number in an external system where order is fulfilled. Use together with the externalFulfillment field
true if the tax rate is included in order price. More details: Taxes in Ecwid
ID of the category this product belongs to. If the product belongs to many categories, categoryID will return the ID of the default product category. If the product doesn't belong to any category, 0 is returned
Price of ordered item in the cart
Basic product price without options markups, wholesale discounts etc.
Product description truncated to 120 characters
Tax amount applied to the item
The ID of a chosen combination. If not specified, it will be calculated automatically
Order item shipping cost
The number of products in stock in the store
true/false: shows whether the item requires shipping
true/false: shows whether the store admin set to track the quantity of this product and get low stock notifications
true/false: shows whether the fixed shipping rate is set for the product
Fixed shipping rate for the product
true/false: shows whether the item has downloadable files attached
true/false: shows whether a discount coupon is applied for this item
Product options values selected by the customer
Taxes applied to this order item
true if price for the ordered product was set up by a customer ("Pay What You Want" feature is enabled). false otherwise.
true if the product is pre-ordered because it was out of stock. Learn more about Accepting pre-orders. Otherwise the field should not be passed.
Tax value in percent
Tax amount for the item
true if the tax rate is included in product prices. More details: Taxes in Ecwid