Shipstation

A documentation for Shipstation source on Daton.

Locating the Username (Token) & Password (Secret)

1. Login to Shipstation.

2. You can find your API Key as the username and API Secret under settings. URL: https://ss.shipstation.com/#/settings/api

Snapshot

Features	Details
Release Status	Released
Source API Version	1.1
Table Selection	Yes
Column Selection	Yes
Edit Integrations	Yes
Replication Type Selection	No
Authentication Parameters	Basic Auth (Token & Secret)
Replication Type	Key-based incremental Full Load
Replication Key	Date
Suggested Replication Frequency	1 hr

Shipstation Tables

Source documentation: https://www.shipstation.com/docs/api/accounts/list-tags/

1. Account Tags Purpose: To get all the data for all tags defined for this account. Replication: Full Load Fields

Field name	Type
tagId	NUMERIC
name	STRING
color	STRING

2. Carriers Purpose: To get all the data for all shipping providers connected to your account. Replication: Full Load Fields

Field name	Type
name	STRING
code	STRING
accountNumber	STRING
requiresFundedAccount	BOOLEAN
balance	NUMERIC
nickname	STRING
shippingProviderId	NUMERIC
primary	BOOLEAN

3. Customers Purpose: To get all the customers. Replication: Full Load Fields

Field name	Type
customerId	NUMERIC
createDate	STRING
modifyDate	STRING
name	STRING
company	STRING
street1	STRING
street2	STRING
city	STRING
state	STRING
postalCode	STRING
countryCode	STRING
phone	STRING
email	STRING
addressVerified	STRING
marketplaceUsernames	RECORD
tags	STRING

4. Fulfilments Purpose: To get all the fulfilments. Replication: Full Load Fields

Field name	Type
fulfillmentId	NUMERIC
orderId	NUMERIC
orderNumber	STRING
userId	STRING
customerEmail	STRING
trackingNumber	STRING
createDate	STRING
shipDate	STRING
voidDate	STRING
deliveryDate	STRING
carrierCode	STRING
fulfillmentProviderCode	STRING
fulfillmentServiceCode	STRING
fulfillmentFee	NUMERIC
voidRequested	BOOLEAN
voided	BOOLEAN
marketplaceNotified	BOOLEAN
notifyErrorMessage	STRING
shipTo	RECORD

5. Marketplaces Purpose: To get all the marketplaces that can be integrated with ShipStation. Replication: Full Load Fields

Field name	Type
name	STRING
marketplaceId	NUMERIC
canRefresh	BOOLEAN
supportsCustomMappings	BOOLEAN
supportsCustomStatuses	BOOLEAN
canConfirmShipments	BOOLEAN

6. Orders Purpose: To get data for all the orders. Replication: Full Load Fields

Field name	Type
orderId	NUMERIC
orderNumber	STRING
orderKey	STRING
orderDate	STRING
createDate	STRING
modifyDate	STRING
paymentDate	STRING
shipByDate	STRING
orderStatus	STRING
customerId	STRING
customerUsername	STRING
customerEmail	STRING
billTo	RECORD
shipTo	RECORD
items	RECORD
orderTotal	NUMERIC
amountPaid	NUMERIC
taxAmount	NUMERIC
shippingAmount	NUMERIC
customerNotes	STRING
internalNotes	STRING
gift	BOOLEAN
giftMessage	STRING
paymentMethod	STRING
requestedShippingService	STRING
carrierCode	STRING
serviceCode	STRING
packageCode	STRING
confirmation	STRING
shipDate	DATE
holdUntilDate	DATE
weight	RECORD
dimensions	RECORD
insuranceOptions	RECORD
internationalOptions	RECORD
advancedOptions	RECORD
tagIds	STRING
userId	STRING
externallyFulfilled	BOOLEAN
externallyFulfilledBy	STRING
labelMessages	STRING

7. Products Purpose: To get data for all the products. Replication: Full Load Fields

Field name	Type
aliases	STRING
productId	NUMERIC
sku	STRING
name	STRING
price	NUMERIC
defaultCost	STRING
length	STRING
width	STRING
height	STRING
weightOz	NUMERIC
internalNotes	STRING
fulfillmentSku	STRING
createDate	DATETIME
modifyDate	DATETIME
active	BOOLEAN
productCategory	STRING
productType	STRING
warehouseLocation	STRING
defaultCarrierCode	STRING
defaultServiceCode	STRING
defaultPackageCode	STRING
defaultIntlCarrierCode	STRING
defaultIntlServiceCode	STRING
defaultIntlPackageCode	STRING
defaultConfirmation	STRING
defaultIntlConfirmation	STRING
customsDescription	STRING
customsValue	STRING
customsTariffNo	STRING
customsCountryCode	STRING
noCustoms	BOOLEAN
tags	RECORD

8. Shipments Purpose: To get data for all the shipments. Replication: Incremental Replication Key: createDateStart Fields

Field name	Type
shipmentId	NUMERIC
orderId	NUMERIC
orderKey	STRING
userId	STRING
customerEmail	STRING
orderNumber	STRING
createDate	DATETIME
shipDate	DATE
shipmentCost	NUMERIC
insuranceCost	NUMERIC
trackingNumber	STRING
isReturnLabel	BOOLEAN
batchNumber	STRING
carrierCode	STRING
serviceCode	STRING
packageCode	STRING
confirmation	STRING
warehouseId	NUMERIC
voided	BOOLEAN
voidDate	STRING
marketplaceNotified	BOOLEAN
notifyErrorMessage	STRING
shipTo	RECORD
weight	RECORD
dimensions	RECORD
insuranceOptions	RECORD
advancedOptions	RECORD
shipmentItems	STRING
labelData	STRING
formData	STRING

9. Stores Purpose: To get all the installed stores on the account. Replication: Full Load Fields

Field name	Type
storeId	NUMERIC
storeName	STRING
marketplaceId	NUMERIC
marketplaceName	STRING
accountName	STRING
email	STRING
integrationUrl	STRING
active	BOOLEAN
companyName	STRING
phone	STRING
publicEmail	STRING
website	STRING
refreshDate	DATETIME
lastRefreshAttempt	DATETIME
createDate	DATETIME
modifyDate	DATETIME
autoRefresh	BOOLEAN
statusMappings	RECORD

10. Users Purpose: To get data for all the users. Replication: Full Load Fields

Field name	Type
userId	STRING
userName	STRING
name	STRING
is_active	STRING

11. Warehouse Purpose: To get all the Replication: Full Load Fields

Field name	Type
warehouseId	NUMERIC
warehouseName	STRING
originAddress	RECORD
returnAddress	RECORD
createDate	DATETIME
isDefault	BOOLEAN
sellerIntegrationId	STRING
extInventoryIdentity	STRING
registerFedexMeter	STRING
is_active	STRING