README

This is an extension for Magento2 which facilitates efficient inventory, order and tracking info synchronization between Magento2/Magento and the ShipStream Magento2/Magento Plugin. This extension will have no effect until the corresponding plugin subscription has been configured in ShipStream.

What functionality does this extension add to my Magento2/Magento store?

Adds a Stores-> Settings-> Configuration-> (section) Services > ShipStream Sync
- General > Enable Real-Time Order Sync
- General > Send New Shipment Email
Adds three new order statuses: "Ready to Ship", "Failed to Submit" and "Submitted"
Adds API endpoint shipStreamSyncShipStreamInfoV1Infos:shipStreamSyncShipStreamInfoV1
Adds API endpoint shipStreamSyncShipStreamManagementV1SetConfig:shipStreamSyncShipStreamManagementV1
Adds API endpoint shipStreamSyncShipStreamManagementV1SyncInventory:shipStreamSyncShipStreamManagementV1
Adds API endpoint shipStreamSyncShipStreamStockAdjustV1StockAdjust:shipStreamSyncShipStreamStockAdjustV1
Adds API endpoint shipStreamSyncShipOrderInfoV1Info:shipStreamSyncShipOrderInfoV1
Adds API endpoint shipStreamSyncShipStreamOrderShipmentV1CreateWithTracking:shipStreamSyncShipStreamOrderShipmentV1
Adds an event observer for sales_order_save_commit_after to trigger an order sync when an order is saved
Adds a cron job to do a full inventory sync every hour (with a short random sleep time)
Stores the ShipStream remote url in the core_flag table

Why is this required? Doesn't Magento2/Magento already have an API?

Yes, but there are several shortcomings that this extension addresses:

When syncing remote systems over basic HTTP protocol there is no locking between when the inventory amount is known and when it is updated, so setting an exact quantity for inventory levels is prone to race conditions. Adding the "adjust" method allows ShipStream to push stock adjustments (e.g. +20 or -10) rather than absolute values which are far less susceptible to race condition-induced errors.
The Magento2 Catalog Inventory API does not use proper database-level locking so is also prone to local race conditions.
This module implements a "pull" mechanism so that Magento2 can lock the inventory locally and remotely, take a snapshot of local inventory and remote inventory, then sync the inventory amounts all inside of one database transaction. This ensures that inventory does not drift or hop around due to race conditions. For a high-volume store these issues are much more frequent than you might imagine.
The Magento2 API shipment.info method returns SKUs that do not reflect the simple product SKU which is used by ShipStream. This extension returns SKUs that are appropriate for the WMS to use.
Four or more API calls can be cut down to one with the shipStreamSyncShipStreamOrderShipmentV1CreateWithTracking:shipStreamSyncShipStreamOrderShipmentV1 method which also allows for easy customization (e.g. receiving and storing serial numbers or lot data).

The API endpoints are implemented using Magento's provided SOAP/XML-RPC API so these endpoints do not create any additional security vulnerability exposure.

What is the point of the new statuses?

Without a state between "Processing" and "Complete" it is otherwise difficult to tell if an order is ready to be submitted to the warehouse, if it has been successfully submitted to the warehouse, or if the order has been processed at the warehouse.

The "Ready to Ship" status can be set manually or programmatically (using some custom code with your own business logic) to indicate when an order is ready to be shipped. If you don't want to use this status simply ignore it and configure ShipStream to pull orders in "Processing" status instead.

The "Failed to Submit" status indicates that there was an error when trying to create the order at the warehouse.

The "Submitted" status indicates that it was successfully submitted to the warehouse, but that it has not yet been fully shipped. Once it is fully shipped the order status will automatically advance to "Complete".

Note: Feel free to change the status labels of these new statuses but do not change the status codes to avoid breaking the integration.

If the ShipStream plugin is configured to sync orders that are in "Ready to Ship" status the order status progression will work as depicted below. Note that this requires a user or some custom code to advance the order status from "Processing" to "Ready to Ship" before the sync will occur.

If the ShipStream plugin is configured to sync orders that are in "Processing" status the order status progression will work as depicted below. This configuration will result in automatic order sync without any user interaction once payment is received.

It is also possible to configure the ShipStream plugin to use any other status in the event that you would like to create a custom workflow.

Installation

Use composer to install this extension:

composer require shipstream/magento2-shipstream-sync
bin/magento module:enable ShipStream_Sync
bin/magento setup:upgrade

Setup

Once this extension is installed and the Magento cache has been refreshed you have only three steps:

Configure the plugin in Magento2/Magento
Create an API Role and API User
Set up the plugin subscription in ShipStream

More details for each step are provided below.

Configuration

Adjust configuration in System > Configuration > Services > ShipStream Sync > General section to your needs.

Create API User

This extension does not require any setup other than to create an API Role and API User for the ShipStream plugin.

Create a User in Magento 2 Go to System > Permissions > All Users to manage admin users. Add a New Shipstream User:

Assign User Role: System > Permissions > User Roles. Copy Shipstream Role user admin/pass to local.xml <admin_login>shipstream_user</admin_login> <admin_pass>shipstream_pass</admin_pass>

Role Resource: Stores->Settings->Configuration->ShipStream Sync

To get AuthToken:

Navigate to System > Integrations > Add New Integration
Enter name "ShipStream Sync" and your email address
Click the "API" tab on the left and check the following resources:
- Sales > Operations > Orders > Actions > View
- Sales > Operations > Orders > Actions > Ship
- Sales > Operations > Orders > Actions > Comment
- Sales > Operations > Shipments
- Catalog > Inventory > Products
Back on the Integrations grid click "Activate" on the new integration and "Accept" the confirmation
Copy the tokens for the integration and paste them into the ShipStream plugin configuration

Get the Access token and copy the same to Shipstream plugin local.xml <access_token>Access Token</access_token> <api_login>Consumer Key</api_login> <api_password>Access Token Secret</api_password>

Required API Role Resources

The following Role Resources are required for best operation with the ShipStream plugin:

Sales / Order / Change status, add comments
- required to set the order status to Complete after fulfillment
Sales / Order / Retrieve orders info
- required to get basic order information pertinent to fulfillment
ShipStream Sync
- use the custom API methods added by this extension

ShipStream Setup

The ShipStream plugin will need the following information:

The API URL of your store which should be the Magento2 admin site base url plus /soap/default/
The API User and API Password (created in the step above)
The Admin User and Password (created in the step above)
Access Token (created in the step above)
The name of the order status to use for automatic import (e.g. "Processing" or "Ready to Ship")

Assign Source/Stock

We should assign the new source and stock created by module as base at the backend.

Customization

Feel free to modify this source code to fit your specific needs.

Support

For help just email us at help@shipstream.io!

shipstream / magento2-shipstream-sync

Maintainers

Details