Fulfillments
Returns fulfillment records, including carrier, tracking, fee, and recipient details.
View-Specific Information
Select
The add-in 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 add-in.
- FulfillmentId, ShipmentId, ShipmentNumber, TrackingNumber, FulfillmentProviderCode, ShipToName, ShipToCountryCode, BatchId and OrderSourceId support the following operator: =.
- CreatedAt and ShipDate support the following operators: <=,<,>=,>.
- The following columns will support server side sort: CreatedAt and ModifiedAt can be sorted as ASC or DESC
SELECT * FROM Fulfillments WHERE FulfillmentId = 'se-1515922'
SELECT * FROM Fulfillments WHERE ShipmentId = 'se-24132521'
SELECT * FROM Fulfillments WHERE ShipmentNumber = '100003'
SELECT * FROM Fulfillments WHERE TrackingNumber = '22222'
SELECT * FROM Fulfillments WHERE FulfillmentProviderCode = 'se-8962'
SELECT * FROM Fulfillments WHERE ShipToName = 'test'
SELECT * FROM Fulfillments WHERE ShipToCountryCode = 'US'
SELECT * FROM Fulfillments WHERE BatchId = '1234'
SELECT * FROM Fulfillments WHERE OrderSourceId = '1234'
SELECT * FROM Fulfillments WHERE CreatedAt >= '2024-11-13T23:47:25.293-05:00'
SELECT * FROM Fulfillments WHERE ShipDate >= '2024-11-13T23:47:25.293-05:00'
Columns
| Name | Type | References | Description |
| FulfillmentId [KEY] | String | A string that uniquely identifies the fulfillment. | |
| ShipmentId | String |
Shipments.Id | A string that uniquely identifies the shipment. |
| ShipmentNumber | String | The shipment number (order number). | |
| UserId | String |
Users.Id | The Id of the user associated with the fulfillment. |
| TrackingNumber | String | The tracking number for the fulfillment. | |
| CreatedAt | Datetime | The date and time the fulfillment was created. | |
| ModifiedAt | Datetime | The date and time the fulfillment was last modified. | |
| ShipDate | Datetime | The date the fulfillment was shipped. | |
| VoidedAt | Datetime | The date and time the fulfillment was voided. | |
| DeliveredAt | Datetime | The date and time the fulfillment was delivered. | |
| FulfillmentCarrierFriendlyName | String | The friendly name of the carrier used for this fulfillment. | |
| FulfillmentProviderId | String | The Id of the fulfillment provider. | |
| FulfillmentProviderFriendlyName | String | The friendly name of the fulfillment provider. | |
| FulfillmentProviderCode | String | The code identifying the fulfillment provider. | |
| FulfillmentServiceCode | String | The service code used for this fulfillment. | |
| FulfillmentFeeCurrency | String | The currency of the fulfillment fee. | |
| FulfillmentFeeAmount | Decimal | The amount of the fulfillment fee. | |
| VoidRequested | Boolean | Indicates whether a void has been requested for this fulfillment. | |
| Voided | Boolean | Indicates whether this fulfillment has been voided. | |
| OrderSourceNotified | Boolean | Indicates whether the order source has been notified of this fulfillment. | |
| NotificationErrorMessage | String | The error message from the order source notification, if applicable. | |
| ShipToName | String | The name of the fulfillment recipient. | |
| ShipToCompanyName | String | The company name of the fulfillment recipient. | |
| ShipToEmail | String | The email address of the fulfillment recipient. | |
| ShipToPhone | String | The phone number of the fulfillment 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 2-letter ISO country code of the ship-to address. |
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 fulfillment results. | |
| OrderSourceId | String | The order source Id (store Id) used to filter fulfillment results. |