Module: Mage_Sales
The Mage_Sales module allows you to manage sales orders, invoices, shipments, and credit memos.
Order
Allows you to manage orders.
Resource Name: sales_order
Aliases:
- order
Methods:
- sales_order.list - Retrieve the list of orders using filters
- sales_order.info - Retrieve the order information
- sales_order.addComment - Add a comment to an order
- sales_order.hold - Hold an order
- sales_order.unhold - Unhold an order
- sales_order.cancel - Cancel an order
Invoice
Allows you to manage invoices.
Resource Name: sales_order_invoice
Aliases:
- order_invoice
Methods:
- sales_order_invoice.list - Retrieve a list of invoices using filters
- sales_order_invoice.info - Retrieve information about the invoice
- sales_order_invoice.create - Create a new invoice for an order
- sales_order_invoice.addComment - Add a new comment to an invoice
- sales_order_invoice.capture - Capture an invoice
- sales_order_invoice.cancel - Cancel an invoice
Shipment
Allows you to manage shipments and tracking numbers.
Resource Name: sales_order_shipment
Aliases:
- order_shipment
Methods:
- sales_order_shipment.list - Retrieve a list of shipments using filters
- sales_order_shipment.info - Retrieve information about the shipment
- sales_order_shipment.create - Create a new shipment for an order
- sales_order_shipment.addComment - Add a new comment to a shipment
- sales_order_shipment.addTrack - Add a new tracking number to a shipment
- sales_order_shipment.removeTrack - Remove tracking number from a shipment
- sales_order_shipment.getCarriers - Retrieve a list of allowed carriers for an order
Credit Memo
Allows you to manage order credit memos.
Resource Name: sales_order_creditmemo
Aliases:
- order_creditmemo
Methods:
- sales_order_creditmemo.list - Retrieve the list of credit memos by filters
- sales_order_creditmemo.info - Retrieve the credit memo information
- sales_order_creditmemo.create - Create a new credit memo for order
- sales_order_creditmemo.addComment - Add a new comment to the credit memo
- sales_order_creditmemo.cancel - Cancel the credit memo