This project is a plugin for ShipStream which is designed to communicate with the ShipStream OpenMage Sync Extension and operate within the ShipStream Merchant Plugin Middleware environment.
- Follow the instruction to install the middleware environment
- Run
$ bin/modman init
to initialize the root directory - Run
$ bin/modman clone https://github.com/shipstream/plugin-openmage.git
to clone this project
This plugin requires that you create an API key in the Magento store which you wish to connect with and then provide the API key credentials to the plugin configuration.
Example local.xml file for the middleware environment:
<?xml version="1.0"?>
<config>
<default>
<middleware>
...
</middleware>
<plugin>
<ShipStream_Magento1>
<api_url>https://example.com/api/soap/</api_url>
<api_login>shipstream</api_login>
<api_password>###</api_password>
<auto_fulfill_status>ready_to_ship</auto_fulfill_status>
<auto_fulfill_custom/>
<shipping_method_config>[{"shipping_method":"cheapest_GROUND","field":"shipping_method","operator":"=","pattern":"flatrate_flatrate"},{"shipping_method":"fedex_FEDEX_2_DAY","field":"shipping_description","operator":"=","pattern":"Expedited"}]</shipping_method_config>
<sync_orders_since>###</sync_orders_since>
</ShipStream_Magento1>
</plugin>
</default>
</config>
Notes
<auto_fulfill_status>
The order status for filtering orders which are ready for fulfillment.<sync_orders_since>
The order last update date which are ready for syncing; valid format:YYYY-MM-DD
.