README.md

ShipStream Plugin for OpenMage / Magento 1

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.

Development Environment Installation

1. Follow the instruction to install the middleware environment
2. Run $ bin/modman init to initialize the root directory
3. Run $ bin/modman clone https://github.com/shipstream/plugin-openmage.git to clone this project

Setup

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.

Production Configuration

Development 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>[{&quot;shipping_method&quot;:&quot;cheapest_GROUND&quot;,&quot;field&quot;:&quot;shipping_method&quot;,&quot;operator&quot;:&quot;=&quot;,&quot;pattern&quot;:&quot;flatrate_flatrate&quot;},{&quot;shipping_method&quot;:&quot;fedex_FEDEX_2_DAY&quot;,&quot;field&quot;:&quot;shipping_description&quot;,&quot;operator&quot;:&quot;=&quot;,&quot;pattern&quot;:&quot;Expedited&quot;}]</shipping_method_config>
                <sync_orders_since>###</sync_orders_since>
            </ShipStream_Magento1>
        </plugin>
    </default>
</config>

Notes

1. <auto_fulfill_status> The order status for filtering orders which are ready for fulfillment.
2. <sync_orders_since> The order last update date which are ready for syncing; valid format: YYYY-MM-DD.