ShipStation's integration with Miva Connect uses the latest ShipEngine Connect APIs to import your Miva orders and communicate shipment information back to Miva.
Miva Connect is available for integration, but it is still in a Beta testing phase. This means some features may not be fully available or behave as expected.
New Miva Integration
ShipStation has updated its integration with Miva to support its most up-to-date features for Miva Connect. Follow our Miva Connect migration guide to update your current Miva integration.
Connection Requirements:
-
An active account with Miva Connect on Miva 10.01.00 or higher.
-
Details of your Miva Connect account:
-
Store Code
-
JSON API Endpoint
-
JSON API Access Token
-
JSON API Signature
-
Order Workflow Queue Code (See Order Import Requirements for details)
-
Currency Code
-
Main Image Type Code
-
Order Custom Field Mapping (optional)
-
Order Import Requirements:
-
Your Miva Order Workflow Queue Code is an XML configuration file that ShipStation uses to import your orders. You can customize your Order Workflow Queue to determine when an order is put into the "queue" from which ShipStation imports orders.
See Miva's ShipStation integration guide for more details.
Scope of Support
Installing the Miva ShipStation configuration file and creating a new API token in Miva are beyond the ShipStation scope of support.
Contact Miva Support for assistance with the ShipStation configuration process, as it may differ based on your unique account configuration. See Miva's ShipStation integration guide for more details.
To connect your Miva Connect store to ShipStation:
-
Download the Miva Shipstation configuration file from the Miva app store at apps.miva.com/shipstation.html.
-
Go to your Miva Settings > Data Management > Import Data and Settings in XML Provisioning Format.
-
Upload the ShipStation configuration file to your Miva store by clicking Choose File and selecting shipstation_setup.xml from your file explorer.
When the file has been successfully uploaded, you will see the message: "Import of shipstation_setup.xml complete"
-
Go to your Miva Settings > Users Management > API Tokens, and click Add API Token.
-
Create a new API token for use with ShipStation, then click Save.
Take note of the following fields, as you will need to enter these in ShipStation later:
-
Endpoint URL
-
Access Token
-
Signature (Select the option Require Signature with Key)
-
-
Select your new ShipStation API Token from your list of Users, then click Functions.
-
Select the following eight functions to give permissions for this API token:
-
Module:orderworkflow:OrderList_Acknowledge
-
Module:orderworkflow:QueueOrderList_Load_Query
-
OrderCustomFields_Update
-
OrderItemList_CreateShipment
-
OrderList_Load_Query
-
OrderShipmentList_Update
-
ProductList_Load_Query
-
Store_Load
When you click Add Function, the first column will let you select if the function operates at the domain level or store level. All these functions are store level functions. You will need to select your store.
-
-
Select the Miva Connect tile.
-
Enter your Miva Store Code, JSON API Endpoint (Endpoint URL), JSON API Access Token, JSON API Signature, Order Workflow Queue Code, Currency Code, and Main Image Type Code into the corresponding fields.
-
OPTIONAL: Click Add Item under Order Custom Field Mapping to map your Miva custom fields to one of the available custom field options in ShipStation.
-
Click Connect.
After you've completed the connection steps, your store will be connected to ShipStation. You'll be taken to the store's Settings page to adjust the store-specific settings like branding, notification preferences, and product handling.
-
If all items in an order are canceled in Miva before the order is sent to ShipStation, the order will not be sent. If all items are canceled in Miva for an order that has already been sent to ShipStation, the order will be moved to the Cancelled status.
-
For Miva merchants who sell kits (where one SKU contains multiple product SKUs that make up the kit), the singular kit SKU will import with the order into ShipStation. The product SKUs will be listed in the order's item details in ShipStation.
-
Splitting and combining Miva Connect orders is not currently supported.