ShipStation ODBC: Data Mapping

Reference the below tables for detailed data mapping, field information, and usable postback tokens when configuring import and postback options with ShipStation ODBC.

The tables include:

Import Field Mapping Data Table

Below is a list of fields that can be mapped when configuring import options with ShipStation ODBC.

Field Name

Data Type

Length

Notes

Order

Order #

string

1…50

Required. ShipStation will use this as both Order Number and Order Import Key.

Order Date

date/time

19

Conditionally Required, if not using Last Modified Date. Must use same timezone as the machine the database is hosted on.

Date/time format must include values for year, month, date, hour, minute, and second.

Examples: YYYY/MM/DD HH:MM:SS, MM/DD/YYYY HH:MM:SS, etc.

Last Modified Date

date/time

19

Required. Must use same timezone as the machine the database is hosted on.

Date/time format must include values for year, month, date, hour, minute, and second.

Examples: YYYY/MM/DD HH:MM:SS, MM/DD/YYYY HH:MM:SS, etc.

Ship By Date

date/time

19

Date/time format must include values for year, month, date, hour, minute, and second.

Order Statuses

string

1…50

Click on field to define potential values. Values can be defined as:

  • Awaiting Payment

  • Awaiting Shipment

  • Shipped

  • On Hold

  • Cancelled

If this is not defined, all orders will import in the Awaiting Shipment status.

Hold Until Date

date/time

19

Date/time format must include values for year, month, date, hour, minute, and second.

Customer Notes

string

0...1000

Internal Notes

string

0...1000

Gift Indicator

string

1…50

Click on field to define potential values. Values can be defined as:

  • Gift

  • Non-gift

Gift Message

string

0...1000

Order Source

string

0...50

Custom Field 1

string

0...100

Custom Field 2

string

0...100

Custom Field 3

string

0...100

Items

SKU

string

1...50

Name

string

1...200

Quantity

integer

1...99999

Unit Price

decimal

9,2

Unit Shipping

decimal

9,2

Unit Weight

decimal

9,2

Click on field to define weight unit type. Values can be treated as:

  • Ounces

  • Pounds

  • Grams

Image URL

string

0...500

FulFillment SKU

string

0...400

UPC

string

0...100

HS Tariff

string

0…30

Field is only used for international orders.

Country of Origin

string

2

2-character ISO 3116-1 country code. Field is only used for international orders.

Shipping Options

Ship Method

string

0-100

Maps to the Requested Shipping Service in ShipStation.

Insurance Provider

string

0...50

Click on field to define potential values. Values can be defined as:

  • Shipsurance

  • Carrier

Insurance Value

decimal

9,2

Total Weight

decimal

9,2

Click on field to define weight unit type. Values can be treated as:

  • Ounces

  • Pounds

  • Grams

Package Length

decimal

9,2

Click on field to define dimension unit type. Values can be treated as:

  • Centimeters

  • Inches

Package Width

decimal

9,2

Click on field to define dimension unit type. Values can be treated as:

  • Centimeters

  • Inches

Package Height

decimal

9,2

Click on field to define dimension unit type. Values can be treated as:

  • Centimeters

  • Inches

Content Type

string

0...50

Click on field to define potential values. Values can be defined as:

  • Sample

  • Documents

  • Gift

  • Merchandise

  • Returned Goods

Field is only used for international orders.

Non-Delivery Options

string

0...50

Click on field to define potential values. Values can be defined as:

  • Return to Sender

  • Treat as Abandoned

Field is only used for international orders.

Recipient

Full Name

string

1...100

Required, or use First Name and Last Name.

First Name

string

1...100

Conditionally Required, if not using Full Name

Last Name

string

1...100

Conditionally Required, if not using Full Name

Company

string

0...100

Address 1

string

1…200

Required.

Address 2

string

0…200

Address 3

string

0…200

City

string

1...100

Required.

State

string

2...100

Only U.S. and CA 2-character state codes are supported.

ZIP/Postal Code

string

0...50

Required.

Country

string

2

Required. 2-character ISO 3116-1 country code.

Email

string

0...100

Phone

string

0...50

Residential

string

0…50

Click on field to define potential values. Values can be defined as:

  • Non-residential

  • Residential

Customer Username

string

1...50

Billing

Payment Date

date/time

19

Date/time format must include values for year, month, date, hour, minute, and second.

Total Amount Paid

decimal

9,2

Shipping Amount Paid

decimal

9,2

Tax Amount

decimal

9,2

Payment Method

string

0…200

Full Name

string

1...100

First Name

string

1...100

Can be used instead of Full Name

Last Name

string

1...100

Can be used instead of Full Name

Company

string

0...100

Address 1

string

1…200

Address 2

string

0…200

Address 3

string

0…200

City

string

1...100

State

string

2...100

Only U.S. and CA 2-character state codes are supported.

ZIP/Postal Code

string

0...50

Country

string

2

2-character ISO 3116-1 country code.

Billing Party

string

1…50

Click on field to define potential values. Values can be defined as:

  • My Account

  • Recipient

  • Third Party

If you have multiple connections for the same carrier, My Account will use the Primary carrier account.

Billing Account #

string

0…30

Only used when Billing Party is set to Recipient or Third Party.

Billing Zip

string

0…10

Only used when Billing Party is set to Recipient or Third Party.

Billing Country

string

2

Only used when Billing Party is set to Recipient or Third Party.

Fields Requiring Additional Mapping

Below is a list of the fields that require values to be mapped or that require a selection to be made when configuring import options.

  • Not all fields that require specific values to be mapped or that require a selection to be made are required fields.

  • It is not required to map all of the available values. You can map only the values that are relevant to your data.

  • It is possible to map an available value more than once. For example, you could map the Order Status > Awaiting Shipment value in ShipStation to multiple values in your database.

Postback Mapping Data Table

Below is a list of fields that can be mapped for postback with ShipStation ODBC.

Field Name

Data Type

Length

Notes

Package

Order #

string

1…50

Required.

Carrier

string

0...50

Service

string

0…80

Package Type

string

0...50

Confirmation Service

string

0...50

Tracking Number

string

0...50

Ship Date

date/time

19

Print Date

date/time

19

Shipping Amount

decimal

9,2

Insurance Provider

string

0...50

Possible values:

  • Shipsurance

  • Carrier

Insured Value

decimal

9,2

Insurance Fee

decimal

9,2

Order Status

string

0…50

Recipient

Full Name

string

1...100

Company

string

0...100

Address 1

string

1…200

Address 2

string

0…200

Address 3

string

0…200

City

string

1...100

State

string

2...100

ZIP / Postal Code

string

0...50

Country

string

2

2-character ISO 3116-1 country code.

Phone

string

0...50

Custom Query Postback Tokens

Below is a list of tokens that can be used when writing a custom query for postback with ShipStation ODBC.

Token

Data Type

OrderID

Long

OrderNumber

String

CarrierCode

String

PackageCode

String

Status

String

TrackingNumber

String

ServiceCode

String

ShippedDate

Date/Time

CreatedDate

Date/Time

ShipmentCost

String

InsuranceCost

String

Confirmation

String

FullName

String

FirstName

String

LastName

String

Company

String

Street1

String

Street2

String

Street3

String

City

String

State

String

PostalCode

String

Country

String

Phone

String

InsuranceProvider

String

InsuredValue

Decimal

IsInsured

Boolean

Weight

Decimal

WeightUnits

String