Carriers
Returns the list of shipping carriers connected to the account.
View-Specific Information
Select
The driver 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 driver.
- Id and IncludeExtendedDetails support the following operator: =.
SELECT * FROM Carriers WHERE Id = 'se-2345'
SELECT * FROM Carriers WHERE IncludeExtendedDetails = 'true'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | A string that uniquely identifies the carrier. | |
| CarrierCode | String | The carrier code used to identify the carrier. | |
| AccountNumber | String | The account number associated with the carrier. | |
| ConnectionStatus | String | The current connection status of the carrier account. | |
| RequiresFundedAmount | Boolean | Indicates whether the carrier requires a funded amount. | |
| Balance | Decimal | The current balance associated with the carrier account. | |
| Nickname | String | The nickname given to the carrier account. | |
| FriendlyName | String | The friendly name of the carrier. | |
| FundingSourceId | String | The Id of the funding source associated with the carrier. | |
| Primary | Boolean | Indicates whether this is the primary carrier. | |
| HasMultiPackageSupportingServices | Boolean | Indicates whether the carrier supports services that allow multiple packages. | |
| SupportsLabelMessages | Boolean | Indicates whether the carrier supports label messages. | |
| DisabledByBillingPlan | Boolean | Indicates whether the carrier is disabled due to the billing plan. | |
| Services | String | An array of services associated with the carrier. | |
| Packages | String | An array of package types supported by the carrier. | |
| Options | String | An array of carrier-level advanced options. | |
| SendRates | Boolean | Indicates whether the carrier sends rates. | |
| SupportsUserManagedRates | Boolean | Indicates whether the carrier supports user-managed rates. |
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 | |
| IncludeExtendedDetails | Boolean | Specifies whether to include the packages and options arrays in the response. |