Returns the list of labels.

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, Status, ShipmentId, ExternalShipmentId, TrackingNumber, BatchId, CarrierId, ServiceCode, WarehouseId, RefundStatus and RateId support the following operator: =.
• CreatedAt supports the following operators: <=,<,>=,>.
• The following columns will support server side sort: CreatedAt and VoidedAt can be sorted as ASC or DESC.

For example, the following queries are processed server side:

SELECT * FROM Labels WHERE Id = 'se-1234'

SELECT * FROM Labels WHERE Status = 'completed'

SELECT * FROM Labels WHERE ShipmentId = 'se-2345'

SELECT * FROM Labels WHERE ExternalShipmentId = 'se-5678'

SELECT * FROM Labels WHERE TrackingNumber = 'value'

SELECT * FROM Labels WHERE BatchId = 'se-3214'

SELECT * FROM Labels WHERE CarrierId = 'se-4567'

SELECT * FROM Labels WHERE ServiceCode = 'ups'

SELECT * FROM Labels WHERE WarehouseId = 'se-2345'

SELECT * FROM Labels WHERE RefundStatus = 'approved'

SELECT * FROM Labels WHERE RateId = 'se-3456'

SELECT * FROM Labels WHERE CreatedAt >= '2024-11-13T23:47:25.293-05:00'

Columns

Name	Type	References	Description
Id [KEY]	String		A string that uniquely identifies the label.
Status	String		The current status of the shipping label. The allowed values are processing, completed, error, voided.
ShipmentId	String	Shipments.Id	A string that uniquely identifies the shipment.
ExternalShipmentId	String		A unique user-defined key to identify a shipment.
ExternalOrderId	String		The Id that the order source assigned.
ShipDate	Datetime		The date the shipment was shipped.
CreatedAt	Datetime		The date and time the label was created, in ISO 8601 format.
ShipmentCostCurrency	String		The ISO 4217 currency code for the shipment cost.
ShipmentCostAmount	Decimal		The shipment cost amount.
InsuranceCostCurrency	String		The ISO 4217 currency code for the insurance cost.
InsuranceCostAmount	Decimal		The insurance cost amount.
RequestedComparisonAmountCurrency	String		The ISO 4217 currency code for the requested comparison amount.
RequestedComparisonAmount	Decimal		The requested comparison amount.
TrackingNumber	String		The tracking number for the package.
IsReturnLabel	Boolean		Indicates whether this is a return label.
RmaNumber	String		The Return Merchandise Authorization number.
IsInternational	Boolean		Indicates whether this is an international shipment.
BatchId	String		A string that uniquely identifies the batch.
CarrierId	String	Carriers.Id	A string that uniquely identifies the carrier.
ChargeEvent	String		Determines when the user's account will be charged for the label.
ServiceCode	String		A carrier service code, such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
PackageCode	String		A package type code such as thick_envelope, small_flat_rate_box, or large_package.
Voided	Boolean		Indicates whether the label has been voided.
VoidedAt	Datetime		The date and time the label was voided, in ISO 8601 format.
VoidType	String		Indicates how the label was voided.
RefundDetailsRefundStatus	String		The status of a Refund Assist request for eligible labels.
RefundDetailsRequestDate	Datetime		The date and time the refund was requested, in ISO 8601 format.
RefundDetailsAmountPaidCurrency	String		The ISO 4217 currency code for the amount paid in the refund.
RefundDetailsAmountPaidAmount	Decimal		The amount paid in the refund.
RefundDetailsAmountRequestedCurrency	String		The ISO 4217 currency code for the amount requested in the refund.
RefundDetailsAmountRequestedAmount	Decimal		The amount requested in the refund.
RefundDetailsAmountApprovedCurrency	String		The ISO 4217 currency code for the amount approved in the refund.
RefundDetailsAmountApprovedAmount	Decimal		The amount approved in the refund.
RefundDetailsAmountCreditedCurrency	String		The ISO 4217 currency code for the amount credited in the refund.
RefundDetailsAmountCreditedAmount	Decimal		The amount credited in the refund.
LabelFormat	String		The file format for downloading shipping labels.
DisplayScheme	String		The display format that the label should be shown in.
LabelLayout	String		The available layout size for the shipping label.
Trackable	Boolean		Indicates whether the shipment is trackable.
LabelImageId	String		The identifier of the label image resource.
CarrierCode	String		A shipping carrier code, such as fedex, dhl_express, stamps_com, etc.
Confirmation	String		The delivery confirmation type.
TrackingStatus	String		The current tracking status of the shipment.
LabelDownloadHref	String		The URL to download the label.
LabelDownloadPdf	String		The URL to download the label in PDF format.
LabelDownloadPng	String		The URL to download the label in PNG format.
LabelDownloadZpl	String		The URL to download the label in ZPL format.
FormDownloadHref	String		The URL to download the form.
FormDownloadType	String		The MIME type of the form download resource.
QrCodeDownloadHref	String		The URL to download the QR code.
QrCodeDownloadType	String		The MIME type of the QR code download resource.
PaperlessDownloadHref	String		The URL to access the paperless download.
PaperlessDownloadInstructions	String		The instructions for the paperless download.
PaperlessDownloadHandoffCode	String		The handoff code for the paperless download.
InsuranceClaimHref	String		The URL to access the insurance claim.
InsuranceClaimType	String		The MIME type of the insurance claim resource.
Packages	String		The packages associated with the label.
AlternativeIdentifiers	String		Alternative identifiers provided by the carrier for the label.
RateDetails	String		A breakdown of individual charges for the label.
TrackingUrl	String		The URL to track the package.
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 street address.
ShipToAddressLine2	String		The second line of the street address.
ShipToAddressLine3	String		The third line of the street address.
ShipToCityLocality	String		The name of the city or locality.
ShipToStateProvince	String		The state or province.
ShipToPostalCode	String		The postal code.
ShipToCountryCode	String		A two-letter ISO 3166-1 country code.
ShipToAddressResidentialIndicator	String		Indicates whether the destination address is residential.
ShipToInstructions	String		Delivery instructions for the recipient address.
ShipToGeolocation	String		Geolocation data for the recipient 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
WarehouseId	String		A filter-only field. Filters labels by the Id of the warehouse.
RefundStatus	String		A filter-only field. Filters labels by the status of the refund request. The allowed values are request_scheduled, pending, approved, rejected, excluded.
RateId	String		A filter-only field. Filters labels by the rate Id.