sales_order_shipment.md

Sales Order Shipment

addComment

Allows you to add a new comment to the order shipment.

magento.salesOrderShipment.addComment({
  shipmentIncrementId:  val,
  comment:              val,  /* optional */
  email:                val,  /* optional */
  includeInEmail:       val   /* optional */
}, callback);

addTrack

Allows you to add a new tracking number to the order shipment.

magento.salesOrderShipment.addTrack({
  shipmentIncrementId:  val,
  carrier:              val,
  title:                val,
  trackNumber:          val
}, callback);

create

Allows you to create a new shipment for an order.

magento.salesOrderShipment.create({
  orderIncrementId: val,
  itemsQty:         val,  /* optional */
  comment:          val,  /* optional */
  email:            val,  /* optional */
  includeComment:   val   /* optional */
}, callback);

getCarriers

Allows you to retrieve the list of allowed carriers for an order.

magento.salesOrderShipment.getCarriers({
  orderIncrementId: val
}, callback);

info

Allows you to retrieve the shipment information.

magento.salesOrderShipment.info({
  shipmentIncrementId: val
}, callback);

list

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

magento.salesOrderShipment.list(callback);

// or 

magento.salesOrderShipment.list({
  filters: [ val, val, val ]
}, callback);

// or a single filter

magento.salesOrderShipment.list({
  filters: val
}, callback);

removeTrack

Allows you to remove a tracking number from the order shipment.

magento.salesOrderShipment.removeTrack({
  shipmentIncrementId:  val,
  trackId:              val
}, callback);