API Data Provider - Online Help

Labels

Retrieve all labels

Columns

Name Type References
LabelId String
Status String

The allowed values are processing, completed, error, voided.

ShipmentId String

Shipments.ShipmentId

ExternalShipmentId String
ExternalOrderId String
ShipDate Datetime
CreatedAt Datetime
ShipmentCostAmount Double
ShipmentCostCurrency String
InsuranceCostAmount Double
InsuranceCostCurrency String
RequestedComparisonAmount String
RateDetails String
TrackingNumber String
IsInternational Boolean
IsReturnLabel Boolean
RmaNumber String
BatchId String

Batches.BatchId

CarrierCode String
CarrierId String

Carriers.CarrierId

ServiceCode String
PackageCode String
IsVoided Boolean
VoidedAt Datetime
VoidType String
RefundDetails String
LabelFormat String
DisplayScheme String
LabelLayout String
IsTrackable Boolean
LabelImageId String
CarrierWeight String
Confirmation String
TrackingStatus String
FormDownload String
QrCodeDownload String
InsuranceClaim String
PaperlessDownload String
LabelDownloadHref String
LabelDownloadPdf String
LabelDownloadPng String
LabelDownloadZpl String
Packages String
ChargeEvent String
AlternativeIdentifiers String
ShippingRuleId String
TrackingUrl String
PickupWindows String
ShipTo String

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0