API Data Provider - Online Help

Shipments

Retrieve all shipments

Columns

Name Type References
ShipmentId [KEY] String
CarrierId String

Carriers.CarrierId

ExternalShipmentId String
ShipDate Datetime
CreatedAt Datetime
ModifiedAt Datetime
ShipmentStatus String

The allowed values are pending, processing, label_purchased, cancelled.

TotalWeightUnits String
TotalWeightValue Double
ShipToAddressLine1 String
ShipToAddressLine2 String
ShipToAddressResidentialIndicator String
ShipToCityLocality String
ShipToCompanyName String
ShipToCountryCode String
ShipToName String
ShipToPhone String
ShipToPostalCode String
ShipToStateProvince String
ShipFromAddressLine1 String
ShipFromAddressLine2 String
ShipFromAddressResidentialIndicator String
ShipFromCityLocality String
ShipFromCompanyName String
ShipFromCountryCode String
ShipFromName String
ShipFromPhone String
ShipFromPostalCode String
ShipFromStateProvince String
ReturnToAddressLine1 String
ReturnToAddressLine2 String
ReturnToAddressResidentialIndicator String
ReturnToCityLocality String
ReturnToCompanyName String
ReturnToCountryCode String
ReturnToName String
ReturnToPhone String
ReturnToPostalCode String
ReturnToStateProvince String
Confirmation String
AdvancedOptionsBillToAccount String
AdvancedOptionsBillToCountryCode String
AdvancedOptionsBillToParty String
AdvancedOptionsBillToPostalCode String
AdvancedOptionsContainsAlcohol Boolean
AdvancedOptionsCustomField1 String
AdvancedOptionsCustomField2 String
AdvancedOptionsCustomField3 String
AdvancedOptionsNonMachinable Boolean
AdvancedOptionsSaturdayDelivery Boolean
InsuranceProvider String
Tags String
Packages String
ServiceCode String
WarehouseId String

Warehouses.WarehouseId

Customs String
ExternalOrderId String
OrderSourceCode String
Items String

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0