Update an order

Update an existing ecommerce order/cart resource.

🚧

Note: Order Products Behavior

When updating an order, if you include an array of order products, all previously existing order products for this order will be deleted and replaced with the array provided.

{ "ecomOrder": { "externalid": "3246315237", "email": "alice@example.com", "orderUrl": "https://example.com/orders/3246315233", "orderProducts": [ { "externalid": "PROD12345", "name": "Pogo Stick", "price": 4900, "quantity": 1, "category": "Toys", "sku": "POGO-12", "description": "lorem ipsum...", "imageUrl": "https://example.com/product.jpg", "productUrl": "https://store.example.com/product12345" }, { "externalid": "PROD23456", "name": "Skateboard", "price": 3000, "quantity": 1, "category": "Toys", "sku": "SK8BOARD145", "description": "lorem ipsum...", "imageUrl": "https://example.com/product.jpg", "productUrl": "https://store.example.com/product45678" } ], "orderDiscounts": [ { "name": "1OFF", "type": "order", "discountAmount": 100 } ], "externalUpdatedDate": "2016-09-15T17:41:39-04:00", "shippingMethod": "UPS Ground", "totalPrice": 9111, "shippingAmount": 200, "taxAmount": 500, "discountAmount": 100, "currency": "USD", "orderNumber":"12345-1" } }
{ "ecomOrderProducts": [ { "orderid": "1", "connectionid": "1", "externalid": "PROD12345", "sku": "POGO-12", "name": "Pogo Stick", "description": "lorem ipsum...", "price": "4900", "quantity": "1", "category": "Toys", "imageUrl": "https://example.com/product.jpg", "productUrl": "https://store.example.com/product12345", "createdDate": "2019-09-05T13:55:37-05:00", "updatedDate": "2019-09-05T13:55:37-05:00", "tstamp": "2019-09-05T13:55:37-05:00", "links": { "ecomOrder": "https://youraccounthere.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder" }, "id": "3", "ecomOrder": "1" }, { "orderid": "1", "connectionid": "1", "externalid": "PROD23456", "sku": "SK8BOARD145", "name": "Skateboard", "description": "lorem ipsum...", "price": "3000", "quantity": "1", "category": "Toys", "imageUrl": "https://example.com/product.jpg", "productUrl": "https://store.example.com/product45678", "createdDate": "2019-09-05T13:55:37-05:00", "updatedDate": "2019-09-05T13:55:37-05:00", "tstamp": "2019-09-05T13:55:37-05:00", "links": { "ecomOrder": "https://youraccounthere.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder" }, "id": "4", "ecomOrder": "1" } ], "ecomOrderDiscounts": [ { "name": "1OFF", "type": "order", "orderid": "5355", "discountAmount": "100", "id": "1", "createdDate": "2019-09-05T12:16:18-05:00", "updatedDate": "2019-09-05T12:16:18-05:00" } ], "ecomOrder": { "customerid": "1", "connectionid": "1", "state": "1", "source": "1", "externalid": "3246315237", "orderNumber": "", "email": "alice@example.com", "totalPrice": 9111, "discountAmount": 100, "shippingAmount": 200, "taxAmount": 500, "totalProducts": 2, "currency": "USD", "shippingMethod": "UPS Ground", "orderUrl": "https://example.com/orders/3246315233", "externalCreatedDate": "2016-09-13T16:41:39-05:00", "externalUpdatedDate": "2016-09-15T16:41:39-05:00", "createdDate": "2019-09-05T12:52:13-05:00", "updatedDate": "2019-09-05T13:55:37-05:00", "orderProducts": [ "3", "4" ], "orderDiscounts": [ "1" ], "customer": "1", "orderDate": "2016-09-13T16:41:39-05:00", "tstamp": "2019-09-05T13:55:37-05:00", "links": { "connection": "https://youraccounthere.api-us1.com/api/3/ecomOrders/1/connection", "customer": "https://youraccounthere.api-us1.com/api/3/ecomOrders/1/customer", "orderProducts": "https://youraccounthere.api-us1.com/api/3/ecomOrders/1/orderProducts", "orderDiscounts": "https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderDiscounts", "orderActivities": "https://youraccounthere.api-us1.com/api/3/ecomOrders/1/orderActivities" }, "id": "1", "connection": "1" } }
Path Params
string
required

The ID of the order to update

Body Params
ecomOrder
object
Response

Language
Credentials
URL
Choose an example:
application/json