Tableau Connector for ShipStation

Build 24.0.9060

Orders

Lists all orders.

Select

The connector will use the ShipStation API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the connector.

  • Id ,OrderNumber ,OrderStatus ,CustomerName ,ItemKeyword and TagId support the following operator: =.
  • CreateDate ,ModifyDate ,OrderDate and PaymentDate support the following operators: =,<=,>=.
  • The following columns will support server side sort: Name, OrderDate ,ModifyDate CreateDate and can be sorted as ASC or DESC
For example, the following query is processed server side:
SELECT * FROM Orders WHERE Id = 2810333

Columns

Name Type References Description
Id [KEY] Long The system generated identifier for the order.
AdvancedOptionsBillToAccount String Account number of billToParty.
AdvancedOptionsBillToCountryCode String Country Code of billToParty.
AdvancedOptionsBillToParty String Identifies which party to bill.
AdvancedOptionsBillToPostalCode String Postal code of billToParty.
AdvancedOptionsContainsAlcohol Boolean Specifies whether the order contains alcohol.
AdvancedOptionsCustomField1 String Field that allows for custom data to be associated with an order.
AdvancedOptionsCustomField2 String Field that allows for custom data to be associated with an order.
AdvancedOptionsCustomField3 String Field that allows for custom data to be associated with an order.
AdvancedOptionsMergedIds String Array of orderIds. Each orderId identifies an order that was merged with the associated order.
AdvancedOptionsMergedOrSplit Boolean Returns whether or not an order has been merged or split with another order.
AdvancedOptionsNonMachinable Boolean Specifies whether the order is non-machinable.
AdvancedOptionsParentId Integer If an order has been split, it will return the Parent ID of the order with which it has been split.
AdvancedOptionsSaturdayDelivery Boolean Specifies whether the order is to be delivered on a Saturday.
AdvancedOptionsSource String Identifies the original source/marketplace of the order.
AdvancedOptionsStoreId Integer ID of store that is associated with the order.
AdvancedOptionsWarehouseId Integer Specifies the warehouse where to the order is to ship from.
AmountPaid Double The total amount paid for the Order.
BillToAddressVerified String Billing to address Verified Status.
BillToCity String Billing to city.
BillToCompany String Billing to company.
BillToCountry String Billing to country.
BillToName String Billing to Name.
BillToPhone String Billing to phone.
BillToPostalCode String Billing to postal code.
BillToResidential Boolean Billing to residential.
BillToState String Billing to state.
BillToStreet1 String Billing to street1.
BillToStreet2 String Billing to street2.
BillToStreet3 String Billing to shipToStreet3.
CarrierCode String The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).
Confirmation String The type of delivery confirmation that is to be used(or was used) when this order is shipped(was shipped).
CreateDate Datetime The timestamp the order was created in ShipStation's database. Read-Only.
CustomerEmail String The customer's email address.
CustomerId Integer

Customers.Id

Unique identifier for the customer. Generated by ShipStation the first time the customer record is created.
CustomerNotes String Notes left by the customer when placing the order.
CustomerUsername String Identifier for the customer in the originating system. This is typically a username or email address.
DimensionsHeight Double Height of the order.
DimensionsLength Double Length of the order.
DimensionsUnits String Units of the order.
DimensionsWidth Double Width of the order.
ExternallyFulfilled Boolean States whether the order has is current marked as externally fulfilled by the marketplace.
ExternallyFulfilledBy String If externally Fulfilled is true then this string will return how the order is being fulfilled by the marketplace.
Gift Boolean Specifies whether or not this Order is a gift.
GiftMessage String Gift message left by the customer when placing the order.
HoldUntilDate String If placed on hold, this date is the expiration date for this order's hold status.
InsuranceOptionsInsuredValue Double The shipping insurance information associated with this order.(insured Value).
InsuranceOptionsInsureShipment Boolean The shipping insurance information associated with this order.(insured Shipment).
InsuranceOptionsProvider String The shipping insurance information associated with this order.(insurance provider).
InternalNotes String Private notes that are only visible to the seller.
InternationalOptionsContents String Customs information that can be used to generate customs documents for international orders(contents).
InternationalOptionsNonDelivery String Customs information that can be used to generate customs documents for international orders(non Delivery).
LabelMessages String Label messages of the order.
ModifyDate Datetime The timestamp the order was modified in ShipStation. modify Date will equal create Date until a modification is made.
OrderDate Datetime The date the order was placed.
OrderKey String A user-provided key that should be unique to each order. Can only be initalized during order creation. If the orderkey isn't specified during creation, a unique value will be generated and assigned.
OrderNumber String A user-defined order number used to identify an order.
OrderStatus String The order's status. Possible values: 'awaiting_payment', 'awaiting_shipment', 'shipped', 'on_hold', 'cancelled'
OrderTotal Double The order total.
PackageCode String The code for the package type that is to be used(or was used) when this order is shipped(was shipped).
PaymentDate Datetime The date the order was paid for.
PaymentMethod String Method of payment used by the customer.
RequestedShippingService String Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart.
ServiceCode String The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).
ShipByDate Date The date the order is to be shipped before or on.
ShipDate Date The date the order was shipped.
ShippingAmount Double Shipping amount paid by the customer, if any.
ShipToAddressVerified String The recipients shipping address Verified or not.
ShipToCity String The recipients shipping city.
ShipToCompany String The recipients shipping company.
ShipToCountry String The recipients shipping country.
ShipToName String The recipients shipping name.
ShipToPhone String The recipients shipping phone.
ShipToPostalCode String The recipients shipping postal code.
ShipToResidential Boolean The recipients shipping residential.
ShipToState String The recipients shipping state.
ShipToStreet1 String The recipients shipping street1.
ShipToStreet2 String The recipients shipping street2.
ShipToStreet3 String The recipients shipping street3.
TagIds String Array of tagIds associated with this order.
TaxAmount Double The total tax amount for the Order.
UserId String User assigned to Order/Shipment in the GUID. Read-Only.
WeightUnits String Weight of the order units.
WeightValue Double Weight of the order value.
WeightWtUnits Integer A numeric value that is equivalent to the units field.
CustomerName String Name of the customer.
ItemKeyword String Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060