Update an order

PUT  https://:account.api-us1.com/api/3/ecomOrders/id

• JSON

{
	"ecomOrder": {
		"shippingMethod": "Expedited Shipping",
		"totalPrice": "11111"
	}
}

 

200 OK

{
  "ecomOrder": {
    "customerid": "1",
    "connectionid": "1",
    "externalid": "3246315233",
    "source": "1",
    "orderNumber": "1057",
    "email": "[e-mail]",
    "totalPrice": "11111",
    "totalProducts": "2",
    "currency": "USD",
    "shippingMethod": "Expedited Shipping",
    "orderUrl": "https://example.com/orders/3246315233",
    "orderDate": "2016-09-13 17:41:39",
    "tstamp": "2017-02-07T11:36:38-06:00",
    "customer": "1",
    "links": {
      "customer": "/api/3/ecomOrders/1/customer",
      "orderProducts": "/api/3/ecomOrders/1/orderProducts"
    },
    "id": "1"
  }
}

PATH PARAMS

id                                                      REQUIRED

int32                                                The id of the order to update

 

BODY PARAMS

ecomOrder

object

 

ecomOrder.totalPrice

int32                                                The total price of the order including tax and shipping charges.

 

ecomOrder.currency

string                                               The currency of the order (3-digit ISO code, e.g., 'USD').

 

ecomOrder.orderNumber

string                                               The order number in the external system (this may differ from the externalid).

 

ecomOrder.orderUrl

string                                               The URL for the order in the external service.

 

ecomOrder.orderDate

string                                               The date the order was placed.

 

ecomOrder.shippingMethod

string                                               The shipping method of the order.

 

ecomOrder.email

string                                               The email address of the customer who placed the order.

 

ecomOrder.orderProducts

array of mixed types                          A list of product objects, each containing information about a product included in the order (see params specified for creating an order.

 

! Updating products for an order

When including the orderProducts field in an update request, bear in mind that an order's products will be replaced with whatever is specified.