How will orders be imported to Scurri?
You'll mark the orders as "Ready to Import to Scurri" by invoicing and shipping the orders in Magento. Scurri checks Magento 1 every 5 minutes for orders in that state. Scurri will import the orders, check your shipment rules and allocate those shipments to your preferred carrier and service with no need for manual intervention. When you manifest at the end of the day, Scurri will update the orders in Magento to include their tracking information and mark them as shipped.
There are two parts to the Scurri integration with Magento which you will need to do. The first part is a configuration within Magento, the second part is a configuration within Scurri.
Magento Setup
- Log in to your Magento account
- Click System, and then scroll to Web Services
- Click SOAP/XML-RPC - Users
- Click + Add New User
- Create a user name – Please use the below details, this will avoid issues later.
- The admin password is the password you used to log in to Magento Admin back-end
- You must create the API key- this can be any length
- Make sure you note all configuration information for reference later
Now create a role in Magento for the new created above, which determines the permissions the user should have.
- Click System again, and scroll to Web Services
- Click SOAP/XML-RPC - ROLES
- Click +Add new Role
- Create a name - this must also be “scurri”
- You will again be asked for the admin password.
- Once successfully saved, choose Role Resources from the tree on the left of the screen
- It will detail all the access points that can be configured for the user. Tick the boxes as shown in the following screenshots:
- Click Save once all are ticked
- Click System again, and scroll to Web Services
- Click SOAP/XML-RPC - Users and click on the "scurri" user created earlier
- Click User Role from the left-hand panel.
- The new role will be visible in this list. Select it by clicking the check bubble beside it.
- Click Save again - enter the admin password again to confirm.
This now means there is a user with specific permissions which will be used later when configuring in Scurri.
Next, create Order Statuses for Scurri to work from. - Click System, then Order Statuses- To add a new one, click + Create New Status
Create 3 order statuses, we recommend the below for ease of use.
Status CodeStatus Labelready_to_import_scurri Ready to Import to Scurri imported_to_scurri Imported to Scurri shipped_via_scurri Shipped via Scurri - Once created, click + Assign status to State
- Choose the newly created order status in the first drop down and assign it to the Complete order state
- Do this for each of the statuses created in step 19 - they should all be a version of the Complete status
- Make Ready to Import to Scurri the default Complete status
- If using Partial Shipments, set up the following Order Statuses. If not, skip to Scurri Setup.
Status CodeStatus Labelpart_ready_to_import_scurri Partially Ready to Import to Scurri part_imported_to_scurri Partially Imported to Scurri part_shipped_via_scurri Partially Shipped via Scurri - Once created, again click + Assign status to State
- Assign the newly created order statuses to the Processing order state
- N.B. Ensure you do not set these as the default status for the processing state as this will cause us to try to import all your orders at an earlier stage and mark them all as stale, making them impossible to import.
- To import partial shipments to Scurri, you will need to manually change the status of orders to Partially Ready to Import to Scurri status.
- When manifesting partial shipments in Scurri, the order in Magento will be updated to the appropriate status of either Partially Shipped via Scurri, if there are still items pending on the order or Shipped via Scurri if there are no more items to be shipped.
This concludes the Magento side of the integration - now we move to the Scurri side.
Scurri Setup
- Log in to Scurri
- Click Setup, then Integrations
- Click +Add New Integration
- Click +Add beside Magento 1. This will open a configuration page. Most of the details will come from the setup just completed in Magento.
- The first field asks for a WSDL Path - simply use the domain of your Magento store and append "/index.php/api/v2_soap?wsdl=1" to the end, for example, our website address is "https://www.scurri.com" so the WSDL path would be: https://www.scurri.com/index.php/api/v2_soap?wsdl=1
- Fill in all the Magento user name and Order Status details, including the API Key created in Magento.
- In the field Weight Units in Magento, you should choose the unit configured in the Magento setup
- Notify Magento end-users on manifest, when set to yes, upon manifest, Scurri will add a comment (specified in the next section) to the order in Magento which will be sent out to the end consumer.
- The Custom notification message section is used to specify the message sent to end-users upon manifest in Scurri. The available variable parameters are <CARRIER>, <TRACKNO>, <TRACKURL>. When these are used, the correct value for that specific consignment will appear in the notification to the end consumer. For example; <CARRIER> would become Royal Mail, <TRACKNO> would become TS1234567, etc.
- Fix item duplications caused by configurable items should be ticked if you use configurable items in Magento.
- Custom Fields 1 & 2 are used to bring in additional fields to be used in the Shipment Rules.
- For example, if you want to use the "status" field passed by Magento in one or more of your rules, Scurri does not have this field as one of the default rule criteria but as a Magento user, you can define a custom field to pull in this parameter and use that as a condition in your rules.
- N.B. If you intend to use custom fields, let us know and we will check that the Scurri imports the relevant field from your Magento.
- Make sure to tick the box Check Magento periodically. This enables Scurri to poll Magento every 5 minutes, checking for orders in a Ready to Import to Scurri status. Otherwise, you will need to manually sync the integration to import orders.
This concludes the setup of the Scurri-Magento integration! Now when you invoice and ship your orders in Magento, Scurri will import your orders automatically.
Magento Status Page
You can view the Magento status page from the menu bar on the left by clicking Setup, then Integrations, then, beside the Magento 1 integration, Status.
The total number of orders imported is recorded in the Imported to Scurri and Imported sections above.
As orders begin to import, they appear in the Initial section.
Stale orders indicate an issue or a difficulty with the order import.
In the Magento Communication section, if an import is in progress, True will be display beside "in progress".
Last communication indicates how long it has been since Scurri polled Magento. If you have ticked Check magento periodically in the integration screen, this values should always be 5 minutes or less. Anything longer than that being displayed indicates a communication issue. In this case contact support@scurri.com and we will investigate why this has happened.