PUT Modify Order

PUT https://api.swaycharts.io/dxsca-web/accounts/{account code}/orders

Modifies an existing order on an account

This API allows editing order details on an account. Users can always edit orders on their own accounts, but can only edit orders on behalf of other accounts if a special permission is set. Only conditional requests are accepted.

// Request

A Single Order Request or a Order Group Request that has some fields changed. User must submit the whole order request to ensure idempotency of the protocol. Some of the fields cannot be changed after an order is issued; attempt to do so will result in the 409 Conflict error.

The API supports modifications of an order group with a single order or a single order with an order group.

It is impossible to add and remove orders to/from a group in a single request. It's necessary to first remove an order from a group and then add a new one with a separate request.

Authorization header should be included in case of basic authentication
// Path Parameters

accountCode - unique code assigned to an account (URL-encoded, https://en.wikipedia.org/wiki/Percent-encoding). See account code
// Response

Updated Order Response or a list of Order Responses for all orders in a group (if a group was submitted)

The ETag header is sent in response. See conditional updates

Modification of an order group to a single order

It is impossible to add and remove orders to/from a group in a single request. It's necessary to first remove an order from a group and then add a new one with a separate request.

Last updated