ShipStation

ShipStation is a cloud platform that allows private individuals and companies to accept payments over the Internet.

Data integration: Skyvia supports importing data to and from ShipStation, exporting ShipStation data to CSV files, replicating ShipStation data to relational databases, and synchronizing ShipStation data with other cloud apps and relational databases.

Backup: Skyvia Backup supports ShipStation backup.

Query: Skyvia Query supports ShipStation.

Establishing Connection

To create a connection to ShipStation, specify an API Key and API Secret.

Getting Credentials

To locate API key and API Secret, do the following:

  1. Go to your ShipStation account.
  2. Click the gear icon in the upper left corner.

  3. Click API Settings -> Generate API Keys.

    Connection Editor window

  4. Copy the generated API Key and API Secret.

Creating Connection

To connect to ShipStation, enter the obtained API Key and API Secret to the corresponding boxes in the Connection Editor.

Connection Editor window

Connector Specifics

Filters Support

Use these filters to improve performance and save API calls. You can use filters with other fields or operators, but it may increase API calls usage.

ShipStation API supports filtering for the following objects and fields:

Orders

Field Operator
OrderDate, PaymentDate, CreatedDate, UpdatedDate >, >=, <, <=
OrderStatus, CustomerUsername =

OrderItems

Field Operator
OrderDate, OrderPaymentDate, OrderCreatedDate, OrderUpdatedDate >, >=, <, <=
OrderStatus =

Shipments

Field Operator
OrderId, CarrierCode, TrackingNumber =
ShipDate <=, >=
CreatedDate >, >=, <, <=

ShipmentItems

Field Operator
ShipDate <=,>=
ShipmentCreatedDate >, >=, <, <=

Packages

Field Operator
CarrierCode =

Services

Field Operator
CarrierCode =

Customers

Field Operator
State, CountryCode =

StoreRefreshStatus

Field Operator
StoreId =

Object Peculiarities

Orders

The Items field stores complex structured data in JSON format. You can use our Nested Objects mapping feature in Import to insert or update the nested values in such fields. Select the Nested Objects checkbox in import to enable this feature.

If you map the Items field to constant or expression in your integration, adjust mapping according to the following format.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

[
  {
    "OrderItemId": 102165090,
    "LineItemKey": "48510350416394",
    "Sku": "B0006ZZGZI",
    "Name": "Texas Instruments TI-83 Plus Programmable Graphing Calculator",
    "ImageUrl": "http://ecx.images-amazon.com/images/I/21S41356K0L.jpg",
    "Weight_Value": 8,
    "Weight_Units": "ounces",
    "Quantity": 1,
    "UnitPrice": 45,
    "TaxAmount": 0,
    "ShippingAmount": 4.95,
    "Adjustment": false,
    "CreatedDate": "2013-08-01T07:24:09Z",
    "UpdatedDate": "2013-08-01T07:24:09Z"
  }
]

OrderItems

The Orders object has a complex structure. Its Items field contains the nested array storing order details. For user convenience, we created a separate OrderItems object storing the Items field content in user-friendly format.

Incremental Replication and Synchronization

Skyvia supports Incremental Replication for the following ShipStation objects: Customers, Fulfillments, OrderItems, Orders, Products, Shipments, Stores, Warehouses. Skyvia can track only new records for the Fulfillments, Shipments, and Warehouses objects.

Skyvia supports Synchronization for the Orders and Warehouses objects. Skyvia can track only new records for the Warehouses object

Supported Actions

Skyvia supports all the common actions for ShipStation

On This Page