sales_order.md

Sales Order

addComment

Allows you to add a new comment to the order.

magento.salesOrder.addComment({
  orderIncrementId: val,
  status:           val,
  comment:          val,  /* optional */
  notify:           val   /* optional */
}, callback);

cancel

Allows you to cancel the required order.

magento.salesOrder.cancel({
  orderIncrementId: val
}, callback);

hold

Allows you to place the required order on hold.

magento.salesOrder.hold({
  orderIncrementId: val
}, callback);

info

Allows you to retrieve the required order information.

magento.salesOrder.info({
  orderIncrementId: val
}, callback);

list

Allows you to retrieve the list of orders. Additional filters can be applied.

magento.salesOrder.list(callback);

// or 

magento.salesOrder.list({
  filters: { key: 'val' }
}, callback);

unhold

Allows you to unhold the required order.

magento.salesOrder.unhold({
  orderIncrementId: val
}, callback);