📘
Key Takeaways

API Keys are generated from Shipstation

Shipstation does allow for Split Shipments

Connecting your Shipstation

First you will need to get API Credentials from Shipstation
Then you will input those credentials in the the Vrio Shipstation Connection

To generate your API Keys within Shipstation:

Go to Account
Select API Settings
Choose Generate API Keys

These are they Keys that will be input into the Vrio Connection: ShipStation

See additional information for Shipstation here.

🚧
Store ID
If you have multiple stores connected into a single ShipStation Account. You will need to add the Store ID at the time of connecting the ShipStation Connection within Vrio

To add the Shipstation Connection within Vrio:

Navigate to Settings
Scroll down to the Connections Section
Select Add New Connection
Under the Fulfillment Tab, find Shipstation and select Connect Now

Here you will enter your API Keys that you generated from within Shipstation

Shipstation Settings

Within the Shipstation Connection there are additional settings that you can configure for this connection

Connection Value	Description	Uses
API Key	Generated in Shipstation
API Secret	Generated in Shipstation
Parent Partner Key	Generated in Shipstation	This is an optional field that is used when you have purchased the ability to increase the amount of API calls allowed to Shipstation.
Store ID	Generated in Shipstation	This is used if there are multiple Stores setup in a single Shipstation account.
Order Number Prefix	Add a prefix to be passed to Shipstation to be used in front of the Shipment ID from Vrio
Pass Vrio Order ID	This will pass the Vrio Order ID with the Shipment. This is used commonly for shipping labels	This is used commonly for shipping labels
Custom Field 2 Value	This will pass the input details to the Shipstation Custom Field 2
Test Mode	When checked, all test orders will be submitted to Shipstation When unchecked, no test orders will be submitted to Shipstation	This is recommended to be used at initial launch. Ensure to disable prior to going live.
Combine Shipments	Combine any shipments created for the same customer address into one shipment. This will combine any shipment that is either scheduled before, or up to 6 hours in the future.

ID Mapping

Vrio	Shipstation
Shipment ID	Order ID
requestedShippingService	Code field within the Shipping Profile

Here is an example request from Vrio to Shipstation:

Request:
{
    "orderNumber":{connection prefix+ shipment_id,
    "orderDate": "",
    "customerEmail": "",
    "items": [
        {
            "lineItemKey": "",
            "quantity": "",
            "name": "",
            "sku": "",
            "unitPrice": "",
            "options": []
        }
    ],
    "orderStatus": "",
    "shipTo": {
        "name": "",
        "phone": ,
        "street1": "",
        "street2": "",
        "city": "",
        "state": "",
        "postalCode": "",
        "country": "",
        "company": 
    },
    "amountPaid": "",
    "taxAmount": "",
    "shippingAmount": "",
    "requestedShippingService": {Vrio Shipping Profile "Code"},
      "advancedOptions": {
        "customField1": {This will be the Vrio Order ID if applicable based on Connection Settings}
    "billTo": {
        "name": "",
        "phone": ,
        "street1": "",
        "street2": "",
        "city": "",
        "state": "",
        "postalCode": "",
        "country": "",
        "company": 
    }
}

Split Shipments within Shipstation

Shipstation is a Fulfillment provider that does allow for Split Shipments. When a shipment is split within Shipstation

Split Shipment Logic:

When Vrio collects tracking numbers from Shipstation, if the shipment was flagged as merged or split within Shipstation, Vrio will get all the orders (Vrio shipments ) from Shipstation for the order.
Vrio sends the shipment item id {lineItemKey}, so if the shipment item moved or is no longer on the shipment Vrio originally created it on, Vrio will create new shipments and split them up.
1. Vrio will now show a new shipment parent type to go along with Free, Reship, etc.. called Split.
Once the new shipments within Vrio are created, the new shipment will behave as unqiue shipments and allow for each split shipment to have a unique tracking number.

🚧
Grouped Shipments
If the shipment was grouped by Vrio ( 2 shipments from 2 different orders sent at the same time ), and its split.

It will keep the shipment items associated with the order it originated on.

For example
Shipment 1 has Shipment Item 1 and 2.. Shipment 2 has Shipment Item 3 and 4.
Then inside Shipstation they split the shipment that Vrio grouped where shipment item 2 and 4 are now on new shipment
Vrio will create 2 new shipments, one for each order.