Integration Touchpoints¶

This section describes the individual touchpoints available through the connector.

The connector uses a combination of the native Magento REST APIs and custom endpoints provided by the extensions covered in Setup.

Querying Magento¶

Order Download
- Downloads orders from Magento by status, complete with customer, payment, line item and option data.
Credit Memo Download
- Downloads credit memos, and tracks which have already been integrated.
Customer Download
- Downloads customer records with any custom attributes, complete with their address records.
Item Download
- Downloads products with their attributes, optionally including tier pricing as child records.
Shipment, Invoice & Return Downloads
- Limited downloads of the shipment, invoice and return documents. All three share one set of query criteria.

Item Batch Upload (RAPID Web Sync)
- Bulk uploads product data through the RAPID Web Sync extension. This is also where category assignment and tier pricing are handled.
Item Upload
- Superseded. Use the Item Batch upload instead.

Inventory Source Upload
- Creates and modifies inventory sources — the locations stock is held against.
Inventory Source Item Upload
- Updates available inventory by SKU and quantity against a named inventory source.

Customer Batch Upload
- An optimised, batch sync of customer data, with addresses mapped either flat or as child records.

Sales Order Update
- Flips an order's status and adds comments once it has been processed into the target system. Typically used with the Order Download.
Invoice Upload
- Creates an invoice against an order and optionally captures the authorised payment.
Shipment Upload
- Creates shipments against an order, with tracking information and optional part shipment.

When creating transactions it is recommended to use this manual in conjunction with the Magento developer documentation.

The Magento documentation describes the function of each of the fields exposed by IMan. This manual describes the insert and update semantics.