ShipmentView

Property Type Request/Response Description
ShipmentId string Both Unique internal shipment Id. Leave empty for new shipments.
ModifiedAt datetime Response Date/Time of the last shipment change (of any kind).
Manifested boolean Response Indicator that shipment was printed on the 'end of day' (SCAN) form.
MerchantSettingsId string Both AKA 'WebstoreId'. Empty for a 'stand-alone' shipment. Set to associate shipment with a web store.
ComboBoxes ComboBoxesView Both Container for available shipping options
IsShipped string Response 'True' if shipment has been shipped (history shipment)
IsQuoteRequested string Both 'True' if shipment has been sent for async quote request
TagsAsString string Both Space-separated list of shipment tags
ShipFrom AddressView Both Ship From address -- the From address on shipping labels.
ShipTo AddressView Both Ship To address
Packages List & lt;PackageView> Both Array of packages
ServiceType TUPSService Both Shipping service type
ServiceTypeName TUPSService (human readable) Response Shipping service type as human readable value.
CarrierType TCarrierType Both Shipping carrier type
CarrierTypeName TCarrierType (human readable) Response Shipping carrier type as human readable value.
ActualCarrierType TCarrierType Response Actual postage provider (EasyPost, PitneyBowes, Endicia) for a ShipRushUSPS
ShippingAccountNumber string Response Shipping account number
ShippingAccountDisplayName string Response Shipping account display name (nickname)
ShippingAccountId string Both Internal shipping account Id (from the list of already registered accounts). If not specified, we will pick default account of the specified 'CarrierType'.
PaymentType TUPSChargeType Both Who pays for the shipment. 'Prepaid' is default payment type, in which shipment will be billed to the sender's account. This field is used for FedEx/UPS only and ignored for other carriers.
PaymentAccountNumber TUPSChargeType (human readable) Response
ThirdPartyAddress AddressView Both Third party company name when 'PaymentType' set to 'ThirdParty' or 'Consignee'
PaymentCompanyName string Both Third party account number when 'PaymentType' set to 'ThirdParty' or 'Consignee'
PaymentPostalCode string Both Third party postal code when 'PaymentType' set to 'ThirdParty' or 'Consignee'
PaymentCountry TCountry Both Third party country code when 'PaymentType' set to 'ThirdParty' or 'Consignee'
PaymentCountryName TCountry (human readable) Response
PaymentAmount double Both Amount expected to pay when 'PaymentType' set to 'ThirdParty' or 'Consignee'
ShipDate datetime Response Date/Time when shipper printed shipping label
ShipDateOnLabel datetime Both Date/Time printed on the shipping label (when package picked up by carrier or dropped to the mailbox).
ShippedBy string Response Shipper UserId.
ShippedByEmail string Response Shipper Email.
SaturdayDelivery boolean Both Allow package to be delivered on Saturday (additional surcharges may apply)
SaturdayPickup boolean Both Allow package to be picked up on Saturday (additional surcharges may apply)
HoldAtLocation boolean Both Hold package at the specified carrier delivery center. FedEx/UPS only.
HALAddress AddressView Both 'Hold at location' address.
CODRemittanceAddress AddressView Both 'COD Remit-To' address.
Alcohol boolean Both Specifies if shipment contains alcohol. FedEx only.
EmailNotification boolean Both Send ship notification or not. Supported for all carriers.
EmailNotificationAddress string Both Ship notificaton email
DeliveryNotification boolean Both Send delivery notification or not. FedEx/UPS/OnTrac only.
DeliveryNotificationAddress string Both Delivery notificaton email
ExceptionNotification boolean Both Send exception (problem with the shipment) notification or not. FedEx/UPS/OnTrac only.
ExceptionNotificationAddress string Both Exception notificaton email
IsReturnService boolean Both Specifies if shipment is a 'return label'.
ReturnServiceType TRetService Both Return service type. Supported types by carrier: <br />USPS: Print, PrintMail, Electronic <br />FedEx: ReturnManager, OneAttempt, Electronic <br />UPS: Electronic, PrintMail, Print, OneAttempt, ThreeAttempt <br />FusionLogistics: Print
ReturnServiceName TRetService (human readable) Response Return service type as human readable value.
ShippingCharges string Response Total shipping charges. Includes carrier charges, declared value coverage and markup.
CarrierRate string Response Shipping carrier charges.
ClearPathRate string Response Shipping charges for a ClearPath service
InsuranceRate string Response Declared value coverage charges. These charges are included into &#39;CarrierRate&#39; if carrier coverage is used. These charges are &#39;extra&#39; if ShipRush coverage used.
InsuranceCharges string Response Similar to &#39;InsuranceRate&#39; (for backward compatibility).
UseCustomInsurance boolean Response Returns if ShipRush Declared Value coverage was used or not. To control the use of ShipRush Declared Value coverage use Account.UseCustomInsurance (interactive signup required).
FreightCharges string Response Freight carrier charges. FedEx/UPS only.
OtherCharges string Response Other carrier surcharges (COD, weekend pickup/delivery, signature options, etc.)
Markup string Response Shipper markup. Calculated based on &#39;Mark up Rates&#39; setting &#39;Ship Settings&#39;
BaseCharge string Response Base carrier charges. FedEx/UPS only.
FuelSurcharge string Response Fuel surcharge. FedEx/UPS only.
ResidentialSurcharge string Response Residential surcharge. FedEx/UPS only.
PickupAt string Response Pickup date/time. Deliv only.
TimeInTransit string Response Time in transit as human readable value. Based on calendar days.
TimeInTransitDays string Response Time in transit in calendar days.
TimeInTransitBusinessDays string Response Time in transit in business days.
TrackingNumber string Response Shipment tracking number.
MasterTrackingNumber string Response Shipment master tracking number. FedEx MPS only.
PostbackUrl string Response Webhooks integration. Url for after-shipment HTTP POST.
PostbackContentType PostbackContentType Both Webhooks integration. Data format for after-shipment HTTP POST.
PrintableDocuments List & lt;PrintableDocumentView> Response Shipment label, packing list, international paperwork, etc.
Order OrderView Both Associated eCommerce order.
UnitsOfMeasureLinear TUOML Both Units of measure for shipment dimensions (&#39;IN&#39; or &#39;CM&#39;)
UnitsOfMeasureLinearName TUOML (human readable) Response
UnitsOfMeasureWeight TUOMW Both Units of measure for shipment weight (&#39;LBS&#39; or &#39;KG&#39;)
UnitsOfMeasureWeightName TUOMW (human readable) Response
SmartPostService TSmartPostService Both FedEx Ground Economy
SmartPostServiceName TSmartPostService (human readable) Response FedEx Ground Economy
SmartPostOption TSmartPostOption Both FedEx Ground Economy
SmartPostOptionName TSmartPostOption (human readable) Response FedEx Ground Economy
SmartPostHubId TSmartPostHubId Both FedEx Ground Economy
SmartPostHubIdName TSmartPostHubId (human readable) Response FedEx Ground Economy
HomeDeliveryType THomeDeliveryType Both FedEx Home Delivery type
HomeDeliveryTypeName THomeDeliveryType (human readable) Response FedEx Home Delivery type
HomeDeliveryDate string Both FedEx Home Delivery date
UseHomeDeliveryDate THomeDeliveryTime Both Use specified Delivery date
HomeDeliveryTime THomeDeliveryTime Both Specified Delivery time
HomeDeliveryTimeName THomeDeliveryTime Both Specified Delivery time
HomeDeliveryPhone string Both FedEx Home Delivery phone
Commodities List & lt;CommodityView> Both [International] List of commodities.
CustomsComments string Both [International]
ContentType InternationalContentType Both [International]
ContentTypeName InternationalContentType (human readable) Response [International]
ContentTypeOther string Both [International]
IfNotDelivered TUSPSNonDeliveryType Both [International]
IfNotDeliveredName TUSPSNonDeliveryType (human readable) Response [International]
CustomsFormType InternationalCustomsForm Both [International]
CustomsFormTypeName InternationalCustomsForm (human readable) Response [International]
CustomsReference string Both [International]
LicenseNumber string Both [International]
CertificateNumber string Both [International]
InvoiceNumber string Both [International]
InvoiceDate string Both [International]
InvoiceCurrency string Both [International]
PONumber TCurrencyType Both [International]
CustomsSigner string Both [International]
DescriptionOfGoods string Both [International]
IsDocumentsOnly boolean Both [International]
DutiesPaid TUPSChargeType Both [International]
DutiesPaidSetBy TUPSChargeType Both [International]
DutiesPaidName PropertySetBy (human readable) Response [International]
DutiesPaidByAccount string Both [International]
DutiesPaidPostalCode string Both [International]
ReasonForExport PurposeOfShipment Both [International]
ReasonForExportName PurposeOfShipment (human readable) Response [International]
DutiesPaidCountry TCountry Both [International - Third party country code when &#39;Duties Paid By&#39; set to &#39;ThirdParty&#39;]
DutiesPaidCountryName TCountry (human readable) Response [International]
TermsOfShipment TermsOfShipmentType Both [International]
TermsOfShipmentName TermsOfShipmentType (human readable) Response [International]
Currency string Both [International]
CurrencyName TCurrencyType Both [International]
CurrencySymbol TCurrencyType (human readable) Response [International]
FTRExemption PurposeOfShipment Both [International]
FTRExemptionName PurposeOfShipment (human readable) Response [International]
IntlFilingType IntlFilingTypeEnum (human readable) Response [International]
ITNNumber string Both [International]
ECCNumber string Both [International]
B13AFilingOption B13AOptionEnum (human readable) Response [International]
B13AFilingOptionName B13AOptionEnum (human readable) Response [International]
PermitNumber string Both [International]
IsBso boolean Both [International]
TotalInvoiceAmount string Both Invoice line amount. Required for UPS shipments to CA/PR.
PrintInvoice string Both
Importer AddressView Both [International]
Producer AddressView Both [International]
Broker AddressView Both [International]
ReturnOnDemandRequested boolean Both
InsidePickup string Both FedEx Freight/FusionLogistics only.
InsideDelivery string Both FedEx Freight/FusionLogistics only.
LiftgatePickup string Both FedEx Freight/FusionLogistics only.
LiftgateDelivery string Both FedEx Freight/FusionLogistics only.
TradeshowPickup string Both FedEx Freight, DayandRoss and FusionLogistics only.
TradeshowDelivery string Both FedEx Freight, DayandRoss and FusionLogistics only.
ConstructionSitePickup string Both FedEx Freight/FusionLogistics only.
ConstructionSiteDelivery string Both FedEx Freight/FusionLogistics only.
LimitedAccessPickup string Both FedEx Freight/FusionLogistics only.
LimitedAccessPickupType string Both FedEx Freight/FusionLogistics only.
LimitedAccessPickupTypeName string Both FedEx Freight/FusionLogistics only.
LimitedAccessDelivery string Both FedEx Freight/FusionLogistics only.
LimitedAccessDeliveryType string Both FedEx Freight/FusionLogistics only.
LimitedAccessDeliveryTypeName string Both FedEx Freight/FusionLogistics only.
NotifyBeforeDelivery string Both FedEx Freight/FusionLogistics only.
PalletJackPickup string Both Freight carriers only.
PalletJackDelivery string Both Freight carriers only.
AppointmentRequiredPickup string Both Freight carriers only.
DirectDeliveryOnly boolean Both UPS Direct Delivery flag
IsAccessPointShipment boolean Both UPS Access Point Shipment flag
EPRAReleaseCode string Both UPS Access Point release code
ShipmentQuoteId string Both Freight only
ShipmentLoadId string Both Freight only
SpecialInstructions string Both Fusion Logistics only
ShipViaQuoteId string Both Freight shipping using QuoteId
RequestPickup FreightShipmentRoleEnum Both Fusion Logistics only
AlternativePickupAddress string Both Fusion Logistics only
PickupAddress AddressView Both Fusion Logistics only
PickupDate string Both Fusion Logistics only
PickupReadyTime string Both Fusion Logistics only
PickupByTime string Both Fusion Logistics only
FreightRole FreightShipmentRoleEnum Both FedEx Freight only
FreightRoleName FreightShipmentRoleEnum (human readable) Response FedEx Freight only
FreightCollectTerms FreightCollectTermsEnum Both FedEx Freight only
FreightCollectTermsName FreightCollectTermsEnum (human readable) Response FedEx Freight only
FreightDeclaredValuePerUnitAmount double Both FedEx Freight only
FreightDeclaredValuePerUnitCurrency double Both FedEx Freight only
FreightDeclaredValueUnits int32 Both FedEx Freight only
FreightTotalHandlingUnits int32 Both FedEx Freight only
FreightClientDiscountPercent double Both FedEx Freight only
FreightCoverageType FreightCoverageTypeEnum Both FedEx Freight only
FreightCoverageTypeName FreightCoverageTypeEnum (human readable) Response FedEx Freight only
FreightBillToAddress AddressView Both FedEx Freight only
DHLeCDistributionFacility TDHLeCDistributionFacility Both DHL eCommerce only
DHLeCDistributionFacilityName TDHLeCDistributionFacility (human readable) Response DHL eCommerce only
TrackingNumberUrl string Both Clickable tracking number URL (on my.shiprush.com)
Zone string Both Effective shipment Zone. One of (ZoneUSPS, ZoneUPS or ZoneFedEx), depending on CarrierType.
ZoneUSPS string Both Shipment zone by USPS rate tables.
ZoneUPS string Both Shipment zone by UPS rate tables.
ZoneFedEx string Both Shipment zone by FedEx rate tables.
CarbonNeutral string Both UPS only - Carbon Neutral flag.
ExternalWebstoreId string Both External WebStoreId, if shipment is based on an order retrieved from webstore.
ExternalCustomerId string Both External CustomerId, if shipment is based on an order retrieved from webstore.
ExternalOrderId string Both External OrderId, if shipment is based on an order retrieved from webstore.
StoreOwnerEmail string Both Store ovners email, if shipment is based on an order retrieved from webstore.
ShowEnableTotalProtectionModal string Both Flag indicating whether we should ask the user if he wants to enable Shiprush Total Shipping Protection
IOSSNumber string Both [International - Import One-Stop Shop number (used for European Union import shipments)]
IOSSNumberIssuerCountry TCountry Both [International - Import One-Stop Shop number Issuer Country (used for European Union import shipments)]
EORINumber string Both [International - EORI Number
TaxPayerType TinTypeEnum Both [International - Taxpayer Type
EORINumberDestination string Both [International - EORI Number for Destination
DestinationTaxPaid boolean Both [International]
PersonIdentityCheck string Both Flag indicating whether Identity Check is enabled
PersonDateOfBirth string Both Date of birth required in case of Identity Check
UsePreferredDeliveryDate string Both Flag indicating whether Preferred Delivery Date is enabled
PreferredDeliveryDate string Both Preferred Delivery Date
EORIImporter string Both [International - Importer EORI number]
PlaceOfIncoterm string Both [International - Place (city) referring to the Incoterm]
PreferenceCriteria PreferenceCriteria Both [International - USMCA CO Preference Criteria
ThirdPartyConsignee boolean Both Flag indicating whether the shipment uses a Third Party Consignee option
ReturnsClearance boolean Both Flag indicating whether the shipment uses a Returns Clearance option
HasEnclosedReturnLabel boolean Both Flag supporting shipment with enclosed return label
EnclosedReturnInsuranceCharges double Both Flag supporting shipment with enclosed return label, insurance charges for return
EnclosedReturnAdditionalHandling boolean Both Flag supporting shipment with enclosed return label, additional handling option
DroppointDelivery boolean Both Droppoint delivery flag
ParcelRouting boolean Both Parcel Routing flag