sale/order/edit
POST/sale/order/editThis edits an order in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The order ID to edit.
The order customer ID. Use "0" to create a new customer.
The order first name.
The order last name.
The order company.
The order email.
The order telephone.
The order telephone 2.
The date time order placed.
The order address 1.
The order address 2.
The order city.
The order postcode.
The order country.
The order zone.
The order shipping method.
The date time order shipped out.
The order shipping tracking code.
The order currency code. Must be already added into the account.
The order currency value. Enter 0 for auto value.
The order payment method ID.
The order total amount.
The order comment.
The items in the order.
The item ID. 0 is accepted.
The item name.
The item model code. If 0 is used for the item ID, the model code will be matched to search for the correct item ID.
The item sku code.
The item quantity.
The item price.
The item cost if API has view permission.
The item discount amount per quantity.
The item discount amount for the whole line, on top of the discount per unit.
The item line total charges or discounts.
The order line total charges or discounts.
The name for the order line total.
The unique code for the order line total.
The price for the order line total.
The sort order for the order line total to be displayed.
Indicates whether there's multiple payment methods with "1" or "0".
The list of payment methods if split payment is "1".
The payment method name.
The payment method amount.
Set the default order status ID.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"order_id": 0,
"customer_id": 0,
"firstname": "string",
"lastname": "string",
"company": "string",
"email": "string",
"telephone": "string",
"telephone_2": "string",
"date_ordered": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"postcode": "string",
"country": "string",
"zone": "string",
"shipping_method": "string",
"shipping_date": "string",
"shipping_tracking": "string",
"currency": "string",
"currency_value": 0,
"payment_method": 0,
"total": 0,
"comment": "string",
"products": [
{
"item_id": 0,
"name": "string",
"model": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"cost": 0,
"discount": 0,
"discount_total": 0,
"totals": [
{
"name": "string",
"code": "string",
"price": 0,
"sort_order": 0
}
]
}
],
"totals": [
{
"name": "string",
"code": "string",
"price": 0,
"sort_order": 0
}
],
"split_payment": 0,
"payments": [
{
"payment_method": "string",
"total": 0
}
],
"order_status_id": 0
}Responses
Returns only if there is an error.
Returns only if there is no error.
The order edited.
The order ID.
The channel order ID.
The location ID.
The channel ID.
The channel name.
The payment method.
The customer ID.
The order first name.
The order last name.
The order email.
The order first name and last name merged.
The order company.
The order telephone.
The order telephone 2.
The order address 1.
The order address 2.
The order city.
The order postcode.
The order country.
The order zone.
The order status.
The order status ID.
The order shipping label status ID.
The order blacklist ID.
The order currency code.
The order currency value.
The order total.
The order cost if user has view permission.
The order shipping method.
The order shipping tracking.
The order date time shipped.
The order date time placed.
The order date time added.
The order date time last modified.
The order comment.
Indicates if the order is locked from editing.
The order total weight.
The order products.
The order line totals.
The order payout data from its channel.
Additional order data stored.
{
"error": [
"string"
],
"success": true,
"order": {
"order_id": 0,
"imported_order_id": "string",
"location_id": 0,
"channel_id": 0,
"channel": "string",
"payment_method": "string",
"customer_id": 0,
"firstname": "string",
"lastname": "string",
"email": "string",
"name": "string",
"company": "string",
"telephone": "string",
"telephone_2": "string",
"address_1": "string",
"address_2": "string",
"city": "string",
"postcode": "string",
"country": "string",
"zone": "string",
"order_status": "string",
"order_status_id": 0,
"shipping_label_status_id": 0,
"order_blacklist_id": 0,
"currency": "string",
"currency_value": 0,
"total": 0,
"cost": 0,
"shipping_method": "string",
"shipping_tracking": "string",
"shipping_date": "string",
"date_ordered": "string",
"date_added": "string",
"date_modified": "string",
"comment": "string",
"locked": true,
"weight": 0,
"products": [
{
"order_product_id": 0,
"imported_order_product_id": "string",
"item_id": 0,
"thumb": "string",
"name": "string",
"model": "string",
"sku": "string",
"quantity": 0,
"price": 0,
"discount": 0,
"discount_platform": 0,
"total": 0,
"cost": 0,
"order_status": "string",
"order_status_id": 0,
"weight": 0,
"deducted": true
}
],
"payments": [
{
"payment_method": "string",
"total": 0
}
],
"totals": [
{
"code": "string",
"name": "string",
"price": 0,
"sort_order": 0
}
],
"payouts": [
{
"name": "string",
"amount": 0
}
],
"data": [
{
"name": "string",
"value": "string"
}
]
}
}