Shipments
Retrieve all shipments
Columns
| Name | Type | References | |
| ShipmentId [KEY] | String | ||
| CarrierId | String |
Carriers.CarrierId | |
| ServiceCode | String | ||
| RequestedShipmentService | String | ||
| ExternalShipmentId | String | ||
| ShipmentNumber | String | ||
| HoldUntilDate | Datetime | ||
| ShipDate | Datetime | ||
| ShipDatetime | Datetime | ||
| ShipByDate | Datetime | ||
| DeliverByDate | Datetime | ||
| CreatedAt | Datetime | ||
| ModifiedAt | Datetime | ||
| ShipmentStatus | String |
The allowed values are pending, processing, label_purchased, cancelled. | |
| IsReturn | Boolean | ||
| Confirmation | String | ||
| ShipToName | String | ||
| ShipToPhone | String | ||
| ShipToEmail | String | ||
| ShipToCompanyName | String | ||
| ShipToInstructions | String | ||
| ShipToAddressLine1 | String | ||
| ShipToAddressLine2 | String | ||
| ShipToAddressLine3 | String | ||
| ShipToCityLocality | String | ||
| ShipToStateProvince | String | ||
| ShipToPostalCode | String | ||
| ShipToCountryCode | String | ||
| ShipToAddressResidentialIndicator | String | ||
| ShipToGeolocation | String | ||
| ShipFromName | String | ||
| ShipFromPhone | String | ||
| ShipFromEmail | String | ||
| ShipFromCompanyName | String | ||
| ShipFromInstructions | String | ||
| ShipFromAddressLine1 | String | ||
| ShipFromAddressLine2 | String | ||
| ShipFromAddressLine3 | String | ||
| ShipFromCityLocality | String | ||
| ShipFromStateProvince | String | ||
| ShipFromPostalCode | String | ||
| ShipFromCountryCode | String | ||
| ShipFromAddressResidentialIndicator | String | ||
| ShipFromGeolocation | String | ||
| WarehouseId | String |
Warehouses.WarehouseId | |
| ReturnToName | String | ||
| ReturnToPhone | String | ||
| ReturnToEmail | String | ||
| ReturnToCompanyName | String | ||
| ReturnToInstructions | String | ||
| ReturnToAddressLine1 | String | ||
| ReturnToAddressLine2 | String | ||
| ReturnToAddressLine3 | String | ||
| ReturnToCityLocality | String | ||
| ReturnToStateProvince | String | ||
| ReturnToPostalCode | String | ||
| ReturnToCountryCode | String | ||
| ReturnToAddressResidentialIndicator | String | ||
| Customs | String | ||
| ExternalOrderId | String | ||
| OrderSourceCode | String | ||
| AdvancedOptionsBillToAccount | String | ||
| AdvancedOptionsBillToCountryCode | String | ||
| AdvancedOptionsBillToParty | String | ||
| AdvancedOptionsBillToPostalCode | String | ||
| AdvancedOptionsBillToName | String | ||
| AdvancedOptionsBillToAddressLine1 | String | ||
| HasAdvancedOptionsAlcohol | Boolean | ||
| IsAdvancedOptionsDeliveredDutyPaid | Boolean | ||
| IsAdvancedOptionsNonMachinable | Boolean | ||
| IsAdvancedOptionsSaturdayDelivery | Boolean | ||
| IsAdvancedOptionsDryIce | Boolean | ||
| AdvancedOptionsDryIceWeight | String | ||
| AdvancedOptionsFedexFreight | String | ||
| IsAdvancedOptionsThirdPartyConsignee | Boolean | ||
| IsAdvancedOptionsGuaranteedDutiesAndTaxes | Boolean | ||
| IsAdvancedOptionsPrepaidDutiesTaxes | Boolean | ||
| AdvancedOptionsAncillaryEndorsementsOption | String | ||
| AdvancedOptionsFreightClass | String | ||
| AdvancedOptionsCustomField1 | String | ||
| AdvancedOptionsCustomField2 | String | ||
| AdvancedOptionsCustomField3 | String | ||
| AdvancedOptionsCollectOnDelivery | String | ||
| AdvancedOptionsReturnPickupAttempts | Integer | ||
| IsAdvancedOptionsAdditionalHandling | Boolean | ||
| IsAdvancedOptionsOwnDocumentUpload | Boolean | ||
| IsAdvancedOptionsLimitedQuantity | Boolean | ||
| IsAdvancedOptionsEventNotification | Boolean | ||
| IsAdvancedOptionsImportServices | Boolean | ||
| IsAdvancedOptionsOverrideHoliday | Boolean | ||
| IsAdvancedOptionsFragile | Boolean | ||
| IsAdvancedOptionsDeliveryAsAddressed | Boolean | ||
| IsAdvancedOptionsReturnAfterFirstAttempt | Boolean | ||
| IsAdvancedOptionsCertificateOfOrigin | Boolean | ||
| ComparisonRateType | String | ||
| RetailRate | String | ||
| ShippingRuleId | String | ||
| InsuranceProvider | String | ||
| Tags | String | ||
| StoreId | String | ||
| BatchIds | String | ||
| Packages | String | ||
| PackageShipmentPackageId | String | ||
| PackageId | String | ||
| PackageCode | String | ||
| PackageName | String | ||
| PackageWeightValue | Double | ||
| PackageWeightUnit | String | ||
| PackageDimensionsUnit | String | ||
| PackageDimensionsLength | Double | ||
| PackageDimensionsWidth | Double | ||
| PackageDimensionsHeight | Double | ||
| PackageInsuredValueCurrency | String | ||
| PackageInsuredValueAmount | Double | ||
| PackageLabelMessagesReference1 | String | ||
| PackageLabelMessagesReference2 | String | ||
| PackageLabelMessagesReference3 | String | ||
| PackageExternalPackageId | String | ||
| PackageContentDescription | String | ||
| TotalWeightValue | Double | ||
| TotalWeightUnit | String | ||
| Items | String | ||
| NotesFromBuyer | String | ||
| InternalNotes | String | ||
| NotesForGift | String | ||
| NotesToBuyer | String | ||
| IsGift | Boolean | ||
| AssignedUser | String | ||
| AmountPaidCurrency | String | ||
| AmountPaidAmount | Double | ||
| ShippingPaidCurrency | String | ||
| ShippingPaidAmount | Double | ||
| TaxPaidCurrency | String | ||
| TaxPaidAmount | Double | ||
| Zone | Integer | ||
| DangerousGoodsDeclaration | String | ||
| SenderInfo | String |