public class

AxisMagentoOrderClient

extends AbstractMagentoClient
implements MagentoOrderClient<ExceptionType extends Exception>
java.lang.Object
   ↳ org.mule.module.magento.api.AbstractMagentoClient
     ↳ org.mule.module.magento.api.order.AxisMagentoOrderClient

Summary

[Expand]
Inherited Fields
From class org.mule.module.magento.api.AbstractMagentoClient
Public Constructors
AxisMagentoOrderClient(AxisPortProvider provider)
Public Methods
void addOrderComment(String orderId, String status, String comment, boolean sendEmail)
Adds a comment to the given order id
void addOrderInvoiceComment(String invoiceId, String comment, boolean sendEmail, boolean includeCommentInEmail)
Adds a comment to the given order's invoice
void addOrderShipmentComment(String shipmentId, String comment, boolean sendEmail, boolean includeCommentInEmail)
Adds a comment to the shipment
int addOrderShipmentTrack(String shipmentId, String carrier, String title, String trackNumber)
Adds a new tracking number
void cancelOrder(String orderId)
Cancels an order
void cancelOrderInvoice(String invoiceId)
Cancels an order's invoice
void captureOrderInvoice(String invoiceId)
Captures and invoice
String createOrderInvoice(String orderId, List<OrderItemIdQty> itemsQuantities, String comment, boolean sendEmail, boolean includeCommentInEmail)
Creates an invoice for the given order
String createOrderShipment(String orderId, List<OrderItemIdQty> itemsQuantities, String comment, boolean sendEmail, boolean includeCommentInEmail)
Creates a shipment for order
int deleteOrderShipmentTrack(String shipmentId, String trackId)
Deletes the given track of the given order's shipment
SalesOrderEntity getOrder(String orderId)
Answers the order properties for the given orderId
SalesOrderInvoiceEntity getOrderInvoice(String invoiceId)
Retrieves order invoice information
SalesOrderShipmentEntity getOrderShipment(String shipmentId)
Retrieves order shipment information
List<Carrier> getOrderShipmentCarriers(String orderId)
Returns a list of carriers for the given order id
void holdOrder(String orderId)
Puts order on hold
List<SalesOrderListEntity> listOrders(String filter)
Lists order attributes that match the given filtering expression
List<SalesOrderInvoiceEntity> listOrdersInvoices(String filter)
Lists order invoices that match the given filtering expression
List<SalesOrderShipmentEntity> listOrdersShipments(String filter)
Lists order shipment atrributes that match the given optional filtering expression
void unholdOrder(String orderId)
Releases order
void voidOrderInvoice(String invoiceId)
Voids an invoice
[Expand]
Inherited Methods
From class org.mule.module.magento.api.AbstractMagentoClient
From class java.lang.Object
From interface org.mule.module.magento.api.order.MagentoOrderClient

Public Constructors

public AxisMagentoOrderClient (AxisPortProvider provider)

Parameters
provider

Public Methods

public void addOrderComment (String orderId, String status, String comment, boolean sendEmail)

Adds a comment to the given order id

Parameters
orderId The order id
status
comment
sendEmail If an email must be sent after shipment creation
Throws
RemoteException

public void addOrderInvoiceComment (String invoiceId, String comment, boolean sendEmail, boolean includeCommentInEmail)

Adds a comment to the given order's invoice

Parameters
invoiceId The invoice id
comment The comment to add
sendEmail If an email must be sent after shipment creation
includeCommentInEmail If the comment must be sent in the email
Throws
RemoteException

public void addOrderShipmentComment (String shipmentId, String comment, boolean sendEmail, boolean includeCommentInEmail)

Adds a comment to the shipment

Parameters
shipmentId The shipment's increment id
comment The comment to add
sendEmail If an email must be sent after shipment creation
includeCommentInEmail If the comment must be sent in the email
Throws
RemoteException

public int addOrderShipmentTrack (String shipmentId, String carrier, String title, String trackNumber)

Adds a new tracking number

Parameters
shipmentId The shipment id
carrier The new track's carrier code
title The new track's title
trackNumber The new track's number
Returns
  • the new track's id
Throws
RemoteException

public void cancelOrder (String orderId)

Cancels an order

Parameters
orderId The order to cancel
Throws
RemoteException

public void cancelOrderInvoice (String invoiceId)

Cancels an order's invoice

Parameters
invoiceId The invoice id
Throws
RemoteException

public void captureOrderInvoice (String invoiceId)

Captures and invoice

Parameters
invoiceId The invoice to capture
Throws
RemoteException

public String createOrderInvoice (String orderId, List<OrderItemIdQty> itemsQuantities, String comment, boolean sendEmail, boolean includeCommentInEmail)

Creates an invoice for the given order

Parameters
orderId
itemsQuantities A map containing an entry per each (orderItemId, quantity) pair
comment An optional comment
sendEmail If an email must be sent after shipment creation
includeCommentInEmail If the comment must be sent in the email
Returns
  • the new invoice's id
Throws
RemoteException

public String createOrderShipment (String orderId, List<OrderItemIdQty> itemsQuantities, String comment, boolean sendEmail, boolean includeCommentInEmail)

Creates a shipment for order

Parameters
orderId The order increment id
itemsQuantities A map containing an entry per each (orderItemId, quantity) pair
comment An optional comment
sendEmail If an email must be sent after shipment creation
includeCommentInEmail If the comment must be sent in the email
Returns
  • the new shipment's id
Throws
RemoteException

public int deleteOrderShipmentTrack (String shipmentId, String trackId)

Deletes the given track of the given order's shipment

Parameters
shipmentId The target shipment id
trackId The id of the track to delete
Returns
  • if the tracking number is removed from the shipment
Throws
RemoteException

public SalesOrderEntity getOrder (String orderId)

Answers the order properties for the given orderId

Parameters
orderId
Returns
  • the order properties
Throws
RemoteException

public SalesOrderInvoiceEntity getOrderInvoice (String invoiceId)

Retrieves order invoice information

Parameters
invoiceId
Returns
  • the invoice attributes
Throws
RemoteException

public SalesOrderShipmentEntity getOrderShipment (String shipmentId)

Retrieves order shipment information

Parameters
shipmentId
Returns
  • sales order shipment information
Throws
RemoteException

public List<Carrier> getOrderShipmentCarriers (String orderId)

Returns a list of carriers for the given order id

Parameters
orderId
Returns
  • list of carriers
Throws
RemoteException

public void holdOrder (String orderId)

Puts order on hold

Parameters
orderId
Throws
RemoteException

public List<SalesOrderListEntity> listOrders (String filter)

Lists order attributes that match the given filtering expression

Parameters
filter
Returns
  • a list of order attributes
Throws
RemoteException

public List<SalesOrderInvoiceEntity> listOrdersInvoices (String filter)

Lists order invoices that match the given filtering expression

Parameters
filter
Returns
  • list of string-object maps order attributes
Throws
RemoteException

public List<SalesOrderShipmentEntity> listOrdersShipments (String filter)

Lists order shipment atrributes that match the given optional filtering expression

Parameters
filter
Returns
  • list of string-object map order shipments attributes
Throws
RemoteException

public void unholdOrder (String orderId)

Releases order

Parameters
orderId
Throws
RemoteException

public void voidOrderInvoice (String invoiceId)

Voids an invoice

Parameters
invoiceId The invoice id
Throws
RemoteException