Shipments
Returns shipment records, including carrier, address, package, and advanced options details.
View-Specific Information
Select
The component 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 component.
- Id, ShipmentStatus, ExternalShipmentId, ShipmentNumber, StoreId, ShipToName, BatchId, PickupId, SalesOrderId and ItemKeyword support the following operator: =.
- CreatedAt, ModifiedAt and PaymentDate support the following operators: <=,<,>=,>.
- The following columns will support server side sort: CreatedAt and ModifiedAt can be sorted as ASC or DESC.
SELECT * FROM Shipments WHERE Id = 'se-1234'
SELECT * FROM Shipments WHERE ShipmentStatus = 'cancelled'
SELECT * FROM Shipments WHERE ExternalShipmentId = 'c04560bf-110b-d4ea-a09e-6cb81a3f82aa'
SELECT * FROM Shipments WHERE ShipmentNumber = '100002'
SELECT * FROM Shipments WHERE StoreId = 'se-938261'
SELECT * FROM Shipments WHERE ShipToName = 'test'
SELECT * FROM Shipments WHERE BatchId = 'se-5674'
SELECT * FROM Shipments WHERE PickupId = 'se-3456'
SELECT * FROM Shipments WHERE SalesOrderId = 'se-3456'
SELECT * FROM Shipments WHERE ItemKeyword = 'test'
SELECT * FROM Shipments WHERE CreatedAt >= '2024-11-26T19:00:00.000-05:00'
SELECT * FROM Shipments WHERE PaymentDate >= '2024-11-26T19:00:00.000-05:00'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A string that uniquely identifies the shipment. | |
| ShipmentStatus | String | The current status of the shipment.
The allowed values are pending, processing, label_purchased, cancelled. | |
| ExternalShipmentId | String | A unique user-defined key to identify a shipment. | |
| ShipmentNumber | String | The user or order source defined shipment number. | |
| StoreId | String | A string that uniquely identifies the store. | |
| CreatedAt | Datetime | The date and time the shipment was created. | |
| ModifiedAt | Datetime | The date and time the shipment was last modified. | |
| CarrierId | String |
Carriers.Id | A string that uniquely identifies the carrier. |
| ServiceCode | String | A carrier service, such as usps_first_class_mail, fedex_ground, etc. | |
| RequestedShipmentService | String | The requested shipment service. | |
| ExternalOrderId | String | The Id that the order source assigned. | |
| WarehouseId | String |
Warehouses.Id | A string that uniquely identifies the warehouse. |
| ShipDate | Datetime | The date the shipment was sent. | |
| HoldUntilDate | Datetime | The date the shipment should be held until before shipping. | |
| ShipByDate | Datetime | The date by which the shipment must be shipped. | |
| DeliverByDate | Datetime | The date by which the shipment must be delivered. | |
| IsReturn | Boolean | Indicates whether this is a return shipment. | |
| IsGift | Boolean | Indicates whether this is a gift shipment. | |
| Confirmation | String | The delivery confirmation type. | |
| InsuranceProvider | String | The insurance provider. | |
| ComparisonRateType | String | The type of rate used for rate comparison. | |
| OrderSourceCode | String | The order source code. | |
| Zone | Integer | The shipping zone associated with the shipment. | |
| DisplayScheme | String | The display format for the shipment. | |
| AssignedUser | String | The user assigned to this shipment. | |
| NotesFromBuyer | String | Notes from the buyer. | |
| NotesToBuyer | String | Notes to the buyer. | |
| NotesForGift | String | Gift notes. | |
| InternalNotes | String | Internal notes from the seller. | |
| RetailRateCurrency | String | The currency of the retail rate. | |
| RetailRateAmount | Decimal | The retail rate amount. | |
| AmountPaidCurrency | String | The currency of the amount paid. | |
| AmountPaidAmount | Decimal | The amount paid. | |
| ShippingPaidCurrency | String | The currency of the shipping amount paid. | |
| ShippingPaidAmount | Decimal | The shipping amount paid. | |
| TaxPaidCurrency | String | The currency of the tax paid. | |
| TaxPaidAmount | Decimal | The tax amount paid. | |
| TotalWeightValue | Double | The total weight of the shipment. | |
| TotalWeightUnit | String | The unit of measurement for the total weight. | |
| ShipToName | String | The name of the recipient. | |
| ShipToPhone | String | The phone number of the recipient. | |
| ShipToEmail | String | The email address of the recipient. | |
| ShipToCompanyName | String | The company name of the recipient. | |
| ShipToAddressLine1 | String | The first line of the ship-to address. | |
| ShipToAddressLine2 | String | The second line of the ship-to address. | |
| ShipToAddressLine3 | String | The third line of the ship-to address. | |
| ShipToCityLocality | String | The city or locality of the ship-to address. | |
| ShipToStateProvince | String | The state or province of the ship-to address. | |
| ShipToPostalCode | String | The postal code of the ship-to address. | |
| ShipToCountryCode | String | The country code of the ship-to address. | |
| ShipToAddressResidentialIndicator | String | Indicates whether the ship-to address is residential. | |
| ShipToInstructions | String | Delivery instructions for the ship-to address. | |
| ShipToGeolocation | String | The geolocation of the ship-to address. | |
| ShipFromName | String | The name of the sender. | |
| ShipFromPhone | String | The phone number of the sender. | |
| ShipFromEmail | String | The email address of the sender. | |
| ShipFromCompanyName | String | The company name of the sender. | |
| ShipFromAddressLine1 | String | The first line of the ship-from address. | |
| ShipFromAddressLine2 | String | The second line of the ship-from address. | |
| ShipFromAddressLine3 | String | The third line of the ship-from address. | |
| ShipFromCityLocality | String | The city or locality of the ship-from address. | |
| ShipFromStateProvince | String | The state or province of the ship-from address. | |
| ShipFromPostalCode | String | The postal code of the ship-from address. | |
| ShipFromCountryCode | String | The country code of the ship-from address. | |
| ShipFromAddressResidentialIndicator | String | Indicates whether the ship-from address is residential. | |
| ShipFromInstructions | String | Delivery instructions for the ship-from address. | |
| ShipFromGeolocation | String | The geolocation of the ship-from address. | |
| ReturnToName | String | The name on the return address. | |
| ReturnToPhone | String | The phone number on the return address. | |
| ReturnToEmail | String | The email address on the return address. | |
| ReturnToCompanyName | String | The company name on the return address. | |
| ReturnToAddressLine1 | String | The first line of the return address. | |
| ReturnToAddressLine2 | String | The second line of the return address. | |
| ReturnToAddressLine3 | String | The third line of the return address. | |
| ReturnToCityLocality | String | The city or locality of the return address. | |
| ReturnToStateProvince | String | The state or province of the return address. | |
| ReturnToPostalCode | String | The postal code of the return address. | |
| ReturnToCountryCode | String | The country code of the return address. | |
| ReturnToAddressResidentialIndicator | String | Indicates whether the return address is residential. | |
| ReturnToInstructions | String | Delivery instructions for the return address. | |
| ReturnToGeolocation | String | The geolocation of the return address. | |
| CustomsContents | String | The type of customs contents. | |
| CustomsNonDelivery | String | The action to take if customs delivery fails. | |
| CustomsTermsOfTradeCode | String | The Incoterms code for the shipment. | |
| AdvancedOptionsBillToAccount | String | The account number to bill shipping costs to. | |
| AdvancedOptionsBillToCountryCode | String | The country code of the third-party billing account. | |
| AdvancedOptionsBillToParty | String | The billing party for the shipment. | |
| AdvancedOptionsBillToPostalCode | String | The postal code of the third-party billing account. | |
| AdvancedOptionsContainsAlcohol | Boolean | Indicates whether the shipment contains alcohol. | |
| AdvancedOptionsDeliveredDutyPaid | Boolean | Indicates whether the shipper is paying the international delivery duties. | |
| AdvancedOptionsDryIce | Boolean | Indicates whether the shipment contains dry ice. | |
| AdvancedOptionsDryIceWeightValue | Double | The weight of the dry ice. | |
| AdvancedOptionsDryIceWeightUnit | String | The unit of measurement for the dry ice weight. | |
| AdvancedOptionsNonMachinable | Boolean | Indicates that the package cannot be processed automatically. | |
| AdvancedOptionsSaturdayDelivery | Boolean | Indicates whether Saturday delivery is enabled, if supported by the carrier. | |
| AdvancedOptionsFedexFreightShipperLoadAndCount | String | The FedEx Freight shipper load and count. | |
| AdvancedOptionsFedexFreightBookingConfirmation | String | The FedEx Freight booking confirmation. | |
| AdvancedOptionsUseUpsGroundFreightPricing | Boolean | Indicates whether to use UPS Ground Freight pricing. | |
| AdvancedOptionsFreightClass | String | The National Motor Freight Traffic Association freight class. | |
| AdvancedOptionsCustomField1 | String | The first arbitrary field for storing custom information about the shipment. | |
| AdvancedOptionsCustomField2 | String | The second arbitrary field for storing custom information about the shipment. | |
| AdvancedOptionsCustomField3 | String | The third arbitrary field for storing custom information about the shipment. | |
| AdvancedOptionsOriginType | String | Indicates whether the shipment will be picked up or dropped off by the carrier. | |
| AdvancedOptionsAdditionalHandling | Boolean | Indicates whether this shipment requires additional handling. | |
| AdvancedOptionsShipperRelease | Boolean | Indicates whether the shipper release option is enabled. | |
| AdvancedOptionsCollectOnDeliveryPaymentType | String | The payment type for collect on delivery. | |
| AdvancedOptionsCollectOnDeliveryPaymentAmountCurrency | String | The currency of the collect on delivery payment amount. | |
| AdvancedOptionsCollectOnDeliveryPaymentAmountAmount | Decimal | The collect on delivery payment amount. | |
| AdvancedOptionsThirdPartyConsignee | Boolean | Indicates whether the third-party consignee option is enabled. | |
| AdvancedOptionsDangerousGoods | Boolean | Indicates whether the shipment contains dangerous goods. | |
| AdvancedOptionsDangerousGoodsContactName | String | The name of the dangerous goods contact. | |
| AdvancedOptionsDangerousGoodsContactPhone | String | The phone number of the dangerous goods contact. | |
| AdvancedOptionsMovementIndicator | String | The movement indicator for the shipment. | |
| AdvancedOptionsWindsorFrameworkDetailsMovementIndicator | String | The Windsor Framework movement indicator. | |
| AdvancedOptionsWindsorFrameworkDetailsNotAtRisk | Boolean | Indicates whether the shipment is not at risk under the Windsor Framework. | |
| AdvancedOptionsAncillaryEndorsementsOption | String | The ancillary endorsements option for the shipment. | |
| AdvancedOptionsReturnPickupAttempts | Long | The number of return pickup attempts. | |
| AdvancedOptionsOwnDocumentUpload | Boolean | Indicates whether own document upload is enabled. | |
| AdvancedOptionsLimitedQuantity | Boolean | Indicates whether the shipment contains limited quantities. | |
| AdvancedOptionsEventNotification | Boolean | Indicates whether event notifications are enabled. | |
| AdvancedOptionsFragile | Boolean | Indicates whether the shipment contains fragile items. | |
| AdvancedOptionsDeliveryAsAddressed | Boolean | Indicates whether the carrier is instructed to deliver to the exact address provided. | |
| AdvancedOptionsReturnAfterFirstAttempt | Boolean | Indicates whether to return the shipment after the first failed delivery attempt. | |
| AdvancedOptionsRegulatedContentType | String | The category of goods subject to regulatory requirements. | |
| AdvancedOptionsNetstampsOptionsRow | Long | The row on the sheet where the label is placed. | |
| AdvancedOptionsNetstampsOptionsColumn | Long | The column on the sheet where the label is placed. | |
| Items | String | The items included in the shipment. | |
| TaxIdentifiers | String | Tax identification information associated with the shipment. | |
| Tags | String | Tags associated with the shipment. | |
| Packages | String | The packages included in the shipment. |
Pseudocolumns
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| BatchId | String | The batch Id used to filter shipment results. | |
| PickupId | String | The pickup Id used to filter shipment results. | |
| SalesOrderId | String | The sales order Id used to filter shipment results. | |
| ItemKeyword | String | The keyword used to filter shipments by items matching across Sku, Description, and Options. | |
| PaymentDate | Datetime | The payment date used to filter shipment results. |