PackageResponse Class

PackageResponse class.

Sox.PackageResponse object holds all the return package attributes after shipment manifesting has taken place.

Inheritance Hierarchy

SystemObject
PSI.SoxErrorBase
PSI.SoxPackageResponse

Namespace: PSI.Sox
Assembly: PSI.Sox (in PSI.Sox.dll) Version: 2.1

Syntax

C++

JavaScript

Copy

[SerializableAttribute]
[KnownTypeAttribute(typeof(List<NameAddress>))]
[KnownTypeAttribute(typeof(NameAddress))]
[KnownTypeAttribute(typeof(CommodityContent))]
[KnownTypeAttribute(typeof(List<CommodityContent>))]
[KnownTypeAttribute(typeof(HazmatContent))]
[KnownTypeAttribute(typeof(List<HazmatContent>))]
[KnownTypeAttribute(typeof(AlcoholContent))]
[KnownTypeAttribute(typeof(List<AlcoholContent>))]
[KnownTypeAttribute(typeof(Date))]
[KnownTypeAttribute(typeof(SerializableDictionary))]
[KnownTypeAttribute(typeof(List<SerializableDictionary>))]
[KnownTypeAttribute(typeof(List<string>))]
[DataContractAttribute]
public class PackageResponse : ErrorBase, 
	ICloneable

[SerializableAttribute]
[KnownTypeAttribute(typeof(List<NameAddress^>))]
[KnownTypeAttribute(typeof(NameAddress))]
[KnownTypeAttribute(typeof(CommodityContent))]
[KnownTypeAttribute(typeof(List<CommodityContent^>))]
[KnownTypeAttribute(typeof(HazmatContent))]
[KnownTypeAttribute(typeof(List<HazmatContent^>))]
[KnownTypeAttribute(typeof(AlcoholContent))]
[KnownTypeAttribute(typeof(List<AlcoholContent^>))]
[KnownTypeAttribute(typeof(Date))]
[KnownTypeAttribute(typeof(SerializableDictionary))]
[KnownTypeAttribute(typeof(List<SerializableDictionary^>))]
[KnownTypeAttribute(typeof(List<String^>))]
[DataContractAttribute]
public ref class PackageResponse : public ErrorBase, 
	ICloneable

PSI.Sox.PackageResponse = function();

Type.createClass(
	'PSI.Sox.PackageResponse',
	PSI.Sox.ErrorBase,
	ICloneable);

The PackageResponse type exposes the following members.

Constructors

	Name	Description
	PackageResponse	Initializes a new instance of the PackageResponse class

Top

Properties

	Name	Description
	additional_handling_fee_unit	Obsolete. Gets or sets Additional Handling Fee
	AdditionalHandlingFee	Gets or sets Additional Handling Fee
	AesTransactionNumber	Gets or sets AES/CAED Transaction Number
	air_freight_fee_unit	Obsolete. Gets or sets Air Freight Fee
	AirFreightFee	Gets or sets Air Freight Fee
	AlcoholContents	Gets or sets Alcohol Contents
	appointment_delivery_fee_unit	Obsolete. Gets or sets Appointment Delivery Fee
	AppointmentDeliveryFee	Gets or sets Appointment Delivery Fee
	apportioned_base_unit	Obsolete. Gets or sets Apportioned Base Charge
	apportioned_discount_unit	Obsolete. Gets or sets Apportioned Discount
	apportioned_special_unit	Obsolete. Gets or sets Apportioned Special Service Charge
	apportioned_total_unit	Obsolete. Gets or sets Apportioned Total Charge
	ApportionedBase	Gets or sets Apportioned Base Charge
	ApportionedDiscount	Gets or sets Apportioned Discount
	ApportionedSpecial	Gets or sets Apportioned Special Service Charge
	ApportionedTotal	Gets or sets Apportioned Total Charge
	arrive_time	Obsolete.
	ArriveDate	Gets or sets Arrival Date
	ArriveTime	The arrive time for the shipment
	BarCode	Gets or sets Bar Code 1
	BarCode2	Gets or sets Bar Code 2
	BarCode3	Gets or sets Bar Code 3
	base_charge_unit	Obsolete. Gets or sets Base Charge
	BaseCharge	Gets or sets Base Charge
	batch_item_reference	Obsolete.
	batch_reference	Obsolete.
	batch_sequence_number	Obsolete.
	BatchItemReference	Gets or sets BatchItemReference.
	BatchReference	Gets or sets BatchReference.
	BatchSequenceNumber	Batch Sequence Number
	billing_fee_unit	Obsolete. Gets or sets Billing Fee
	BillingFee	Gets or sets Billing Fee
	BolLegalStatement	Gets or sets Bill of Lading Legal Statement
	border_processing_fee_unit	Obsolete. Gets or sets Border Processing Fee
	BorderProcessingFee	Gets or sets Border Processing Fee
	BrokerageMethod	Gets or sets Brokerage Method
	BundleId	Gets or sets Bundle ID
	BundleIdList	Gets or sets Bundle ID List
	calltag_fee_unit	Obsolete. Gets or sets Call Tag Fee
	CalltagFee	Gets or sets Call Tag Fee
	carbon_neutral_fee_unit	Obsolete. Gets or sets Carbon Neutral Fee
	CarbonNeutralFee	Gets or sets Carbon Neutral Fee
	carrier_cost_surcharge_unit	Obsolete. Gets or sets Carrier Cost Surcharge
	carrier_monitoring_fee_unit	Obsolete. Gets or sets Carrier Monitoring Fee
	CarrierCostSurcharge	Gets or sets Carrier Cost Surcharge
	CarrierMonitoringFee	Gets or sets Carrier Monitoring Fee
	CarrierName	Gets or sets Carrier Name
	certified_mail_fee_unit	Obsolete. Gets or sets Certified Mail Fee
	CertifiedMailFee	Gets or sets Certified Mail Fee
	chain_of_signature_fee_unit	Obsolete. Gets or sets Chain of Signature Fee
	ChainOfSignatureFee	Gets or sets Chain of Signature Fee
	cod_fee_unit	Obsolete. Gets or sets C.O.D. Fee
	CodFee	Gets or sets C.O.D. Fee
	CodPendingFeePayorPercentage	Gets or sets Payor's Percentage of Pending C.O.D. Fee
	CodReturnTrackingNumber	Gets or sets C.O.D. Return Tracking Number
	CompanyId	Gets or sets companyId
	ConsolidationFlag	Gets or sets Consolidation Flag
	ConsolidationId	Gets or sets Consolidation ID
	ConsolidationShipmentId	Gets or sets Consolidation Shipment ID
	ConsolidationType	Gets or sets Consolidation Type
	CycleCount	Gets or sets Cycle Count
	declared_value_fee_unit	Obsolete. Gets or sets Loss Protection Fee
	DeclaredValueFee	Gets or sets Loss Protection Fee
	DeliverToDoor	Gets or sets Deliver to the Door
	delivery_exception_notification_fee_unit	Obsolete. Gets or sets Delivery Exception Notification Fee
	delivery_notification_fee_unit	Obsolete. Gets or sets Delivery Notification Fee
	delivery_window_fee_unit	Obsolete. Gets or sets Delivery Window Fee
	DeliveryAreaCode	Gets or sets Delivery Area Code
	DeliveryExceptionNotificationFee	Gets or sets Delivery Exception Notification Fee
	DeliveryNotificationFee	Gets or sets Delivery Notification Fee
	DeliveryWindowFee	Gets or sets Delivery Window Fee
	DestinationAirportCode	Gets or sets Destination Airport Code
	DimensionalWeightRated	Gets or sets Dimensional Weight Rated
	Dimensions	Gets or sets Dimensions
	direct_delivery_fee_unit	Obsolete. Gets or sets Direct Delivery Fee
	DirectDeliveryFee	Gets or sets Direct Delivery Fee
	Discount	Gets or sets Discount
	discount_unit	Obsolete. Gets or sets Discount
	documentation_fee_unit	Obsolete. Gets or sets Documentation Fee
	DocumentationFee	Gets or sets Documentation Fee
	Documents	List of documents
	DropoffAppointmentDate	Gets or sets Drop-off Appointment Date
	DropoffAppointmentNumber	Gets or sets Drop-off Appointment Number
	DropoffAppointmentTime	Gets or sets Drop-off Appointment Time
	dry_ice_fee_unit	Obsolete. Gets or sets Dry Ice Fee
	DryIceFee	Gets or sets Dry Ice Fee
	duty_fee_unit	Obsolete. Gets or sets Duty Fee
	DutyFee	Gets or sets Duty Fee
	early_delivery_fee_unit	Obsolete. Gets or sets Early Delivery Fee
	EarlyDeliveryFee	Gets or sets Early Delivery Fee
	EntryNumber	Gets or sets Entry/Inbond Number
	ErrorCode	Gets or sets ErrorCode (Inherited from ErrorBase.)
	ErrorMessage	Gets or sets ErrorMessage (Inherited from ErrorBase.)
	evening_delivery_fee_unit	Obsolete. Gets or sets Evening Delivery Fee
	EveningDeliveryFee	Gets or sets Evening Delivery Fee
	exchange_fee_unit	Obsolete. Gets or sets Returns Exchange Fee
	ExchangeFee	Gets or sets Returns Exchange Fee
	ExchangeMethod	Gets or sets Returns Exchange Method
	extended_area_fee_unit	Obsolete. Gets or sets Extended Area Fee
	ExtendedAreaFee	Gets or sets Extended Area Fee
	Flats	Gets or sets Flats
	forklift_delivery_fee_unit	Obsolete. Gets or sets Forklift Delivery Fee
	forklift_pickup_fee_unit	Obsolete. Gets or sets Forklift Pickup Fee
	ForkliftDeliveryFee	Gets or sets Forklift Delivery Fee
	ForkliftPickupFee	Gets or sets Forklift Pickup Fee
	FtzIdentifier	Gets or sets Foreign Trade Zone Identifier
	fuel_surcharge_unit	Obsolete. Gets or sets Fuel Surcharge
	FuelSurcharge	Gets or sets Fuel Surcharge
	global_bundle_id	Obsolete.
	global_msn	Obsolete.
	GlobalBundleId	Global Bundle ID
	GlobalMsn	Global MSN
	Groundsaver	Gets or sets GroundSaver
	hazmat_fee_unit	Obsolete. Gets or sets Hazardous Materials Fee
	HazmatFee	Gets or sets Hazardous Materials Fee
	health_insurance_fee_unit	Obsolete. Gets or sets Health Insurance Fee
	HealthInsuranceFee	Gets or sets Health Insurance Fee
	helper_delivery_fee_unit	Obsolete. Gets or sets Helper Delivery Fee
	helper_pickup_fee_unit	Obsolete. Gets or sets Helper Pickup Fee
	HelperDeliveryFee	Gets or sets Helper Delivery Fee
	HelperPickupFee	Gets or sets Helper Pickup Fee
	hold_at_location_fee_unit	Obsolete. Gets or sets Hold at Location Fee
	HoldAtLocationFee	Gets or sets Hold at Location Fee
	holiday_delivery_fee_unit	Obsolete. Gets or sets Holiday Delivery Fee
	holiday_pickup_fee_unit	Obsolete. Gets or sets Holiday Pickup Fee
	HolidayDeliveryFee	Gets or sets Holiday Delivery Fee
	HolidayPickupFee	Gets or sets Holiday Pickup Fee
	HubCode	Gets or sets Hub Code
	HundredweightRated	Gets or sets Hundredweight Rated
	impb_non_compliance_fee_unit	Obsolete. Gets or sets IMpb Non-Compliance Fee
	ImpbNonComplianceFee	Gets or sets IMpb Non-Compliance Fee
	inside_delivery_fee_unit	Obsolete. Gets or sets Inside Delivery Fee
	inside_pickup_fee_unit	Obsolete. Gets or sets Inside Pickup Fee
	InsideDeliveryFee	Gets or sets Inside Delivery Fee
	InsidePickupFee	Gets or sets Inside Pickup Fee
	invoice_discount_unit	Obsolete. Gets or sets Invoice Discount
	invoice_freight_unit	Obsolete. Gets or sets Invoice Freight Charges
	invoice_insurance_fee_unit	Obsolete. Gets or sets Invoice Insurance Fees
	invoice_other_fee_unit	Obsolete. Gets or sets Invoice Other Charges
	InvoiceDiscount	Gets or sets Invoice Discount
	InvoiceFreight	Gets or sets Invoice Freight Charges
	InvoiceInsuranceFee	Gets or sets Invoice Insurance Fees
	InvoiceOtherFee	Gets or sets Invoice Other Charges
	iso_unique_identifier	Obsolete. Gets or sets ISO/IEC Unique Identifier
	IsoUniqueIdentifier	Gets or sets ISO/IEC Unique Identifier
	large_package_fee_unit	Obsolete. Gets or sets Large Package Fee
	large_pallet_fee_unit	Obsolete. Gets or sets Large Pallet Fee
	LargePackageFee	Gets or sets Large Package Fee
	LargePalletFee	Gets or sets Large Pallet Fee
	license_verification_fee_unit	Obsolete. Gets or sets License Verification Fee
	LicenseVerificationFee	Gets or sets License Verification Fee
	liftgate_delivery_fee_unit	Obsolete. Gets or sets Liftgate Delivery Fee
	liftgate_pickup_fee_unit	Obsolete. Gets or sets Liftgate Pickup Fee
	LiftgateDeliveryFee	Gets or sets Liftgate Delivery Fee
	LiftgatePickupFee	Gets or sets Liftgate Pickup Fee
	LocationId	Gets or sets Location ID
	MachineName	Gets or sets MachineName
	Maxicode	Gets or sets MaxiCode
	MmsPieceId	Gets or sets Postal Package ID
	Msn	Gets or sets Master Sequence Number
	multi_piece_fee_unit	Obsolete. Gets or sets Multi Piece Fee
	MultiPieceFee	Gets or sets Multi Piece Fee
	neutral_delivery_service_fee_unit	Obsolete. Gets or sets Neutral Delivery Service Fee
	NeutralDeliveryServiceFee	Gets or sets Neutral Delivery Service Fee
	NofnSequence	Gets or sets Item Sequence Number
	NofnSequenceBundle	Gets or sets Package Sequence Number in Bundle
	NofnTotal	Gets or sets Total Number of Items
	NofnTotalBundle	Gets or sets Total Number of Packages in Bundle
	nonmachinable_mail_fee_unit	Obsolete. Gets or sets Nonmachinable Mail Fee
	NonmachinableMailFee	Gets or sets Nonmachinable Mail Fee
	nonstandard_mail_fee_unit	Obsolete. Gets or sets Nonstandard Mail Fee
	NonstandardMailFee	Gets or sets Nonstandard Mail Fee
	offshore_fee_unit	Obsolete. Gets or sets Offshore Fee
	OffshoreFee	Gets or sets Offshore Fee
	OriginatorTrackingNumber	Gets or sets Originator Tracking Number
	over_dimension_fee_unit	Obsolete. Gets or sets Over Dimension Fee
	OverDimensionFee	Gets or sets Over Dimension Fee
	Oversize	Gets or sets Oversize
	oversize_fee_unit	Obsolete. Gets or sets Oversize Fee
	OversizeFee	Gets or sets Oversize Fee
	package_extras	Obsolete.
	PackageExtras	Dictionary of string items that can be applied to manifesting or buisness rule logic.
	PackageListId	Gets or sets Package List ID
	packaging_tare_weight_unit	Obsolete. Gets or sets Packaging Tare Weight
	PackagingTareWeight	Gets or sets Packaging Tare Weight
	pallet_fee_unit	Obsolete. Gets or sets Pallet Fee
	pallet_jack_delivery_fee_unit	Obsolete. Gets or sets Pallet Jack Delivery Fee
	pallet_jack_pickup_fee_unit	Obsolete. Gets or sets Pallet Jack Pickup Fee
	PalletFee	Gets or sets Pallet Fee
	PalletJackDeliveryFee	Gets or sets Pallet Jack Delivery Fee
	PalletJackPickupFee	Gets or sets Pallet Jack Pickup Fee
	parcel_airlift_fee_unit	Obsolete. Gets or sets Parcel Airlift Fee
	ParcelAirliftFee	Gets or sets Parcel Airlift Fee
	piece_count_fee_unit	Obsolete. Gets or sets Piece Count Fee
	PieceCountFee	Gets or sets Piece Count Fee
	prior_delivery_notification_fee_unit	Obsolete. Gets or sets Prior Delivery Notification Fee
	PriorDeliveryNotificationFee	Gets or sets Prior Delivery Notification Fee
	proactive_recovery_fee_unit	Obsolete. Gets or sets Proactive Recovery Fee
	ProactiveRecoveryFee	Gets or sets Proactive Recovery Fee
	proof_fee_unit	Obsolete. Gets or sets Proof of Delivery Fee
	proof_require_signature_fee_unit	Obsolete. Gets or sets Proof of Delivery Signature Fee
	ProofFee	Gets or sets Proof of Delivery Fee
	ProofRequireSignatureFee	Gets or sets Proof of Delivery Signature Fee
	RateCode	Gets or sets Rate Code
	rated_weight_unit	Obsolete. Gets or sets Rated Weight
	RatedService	Gets or sets RatedService
	RatedWeight	Gets or sets Rated Weight
	registered_mail_fee_unit	Obsolete. Gets or sets Registered Mail Fee
	RegisteredMailFee	Gets or sets Registered Mail Fee
	remote_origin_fee_unit	Obsolete. Gets or sets Remote Origin Fee
	RemoteOriginFee	Gets or sets Remote Origin Fee
	residential_delivery_fee_unit	Obsolete. Gets or sets Residential Delivery Fee
	ResidentialDeliveryFee	Gets or sets Residential Delivery Fee
	restricted_destination_fee	Obsolete. Gets or sets Restricted Destination Fee
	restricted_destination_fee_unit	Obsolete. Gets or sets Restricted Destination Fee
	RestrictedDestinationFee	Gets or sets Restricted Destination Fee
	return_delivery_fee_unit	Obsolete. Gets or sets Return Delivery Fee
	return_delivery_notification_fee_unit	Obsolete. Gets or sets Return Delivery Notification Fee
	ReturnDeliveryFee	Gets or sets Return Delivery Fee
	ReturnDeliveryNotificationFee	Gets or sets Return Delivery Notification Fee
	RoutingCode	Gets or sets Routing Code
	RoutingCode2	Gets or sets Routing Code 2
	RoutingCode3	Gets or sets Routing Code 3
	RoutingCode4	Gets or sets Routing Code 4
	RoutingCode5	Gets or sets Routing Code 5
	saturday_delivery_fee_unit	Obsolete. Gets or sets Saturday Delivery Fee
	saturday_pickup_fee_unit	Obsolete. Gets or sets Saturday Pickup Fee
	SaturdayDeliveryFee	Gets or sets Saturday Delivery Fee
	SaturdayPickupFee	Gets or sets Saturday Pickup Fee
	security_fee_unit	Obsolete. Gets or sets Security Fee
	SecurityFee	Gets or sets Security Fee
	SerialNumber	Gets or sets Serial Number
	Service	Gets or sets Service
	ship_id	Obsolete.
	ship_notification_fee_unit	Obsolete. Gets or sets Ship Notification Fee
	ShipId	ShipId to link packages together that have shipped at the same time.
	ShipNotificationFee	Gets or sets Ship Notification Fee
	ShippedService	Gets or sets ShippedService
	SiteId	Gets or sets SiteId
	Special	Gets or sets Special Service Charge
	special_delivery_fee_unit	Obsolete. Gets or sets Special Delivery Fee
	special_unit	Obsolete. Gets or sets Special Service Charge
	SpecialDeliveryFee	Gets or sets Special Delivery Fee
	stair_delivery_fee_unit	Obsolete. Gets or sets Stair Delivery Fee
	stair_pickup_fee_unit	Obsolete. Gets or sets Stair Pickup Fee
	StairDeliveryFee	Gets or sets Stair Delivery Fee
	StairPickupFee	Gets or sets Stair Pickup Fee
	subcategory	Obsolete.
	sunday_delivery_fee_unit	Obsolete. Gets or sets Sunday Delivery Fee
	sunday_pickup_fee_unit	Obsolete. Gets or sets Sunday Pickup Fee
	SundayDeliveryFee	Gets or sets Sunday Delivery Fee
	SundayPickupFee	Gets or sets Sunday Pickup Fee
	Tax	Gets or sets Taxes
	tax_unit	Obsolete. Gets or sets Taxes
	temperature_control_fee_unit	Obsolete. Gets or sets Temperature Control Fee
	TemperatureControlFee	Gets or sets Temperature Control Fee
	terminal_handling_fee_unit	Obsolete. Gets or sets Terminal Handling Fee
	TerminalHandlingFee	Gets or sets Terminal Handling Fee
	time_in_transit_days	Obsolete.
	TimeInTransit	Gets or sets Time in Transit
	TimeInTransitDays	Time in Transit Days - The amount of that a shipment should arrive based on its ship and arrival date.
	Total	Gets or sets Total Charge
	total_unit	Obsolete. Gets or sets Total Charge
	TrackingNumber	Gets or sets Tracking Number
	TrackingNumber2	Gets or sets Tracking Number 2
	unpack_fee_unit	Obsolete. Gets or sets Unpack Fee
	UnpackFee	Gets or sets Unpack Fee
	urban_delivery_fee_unit	Obsolete. Gets or sets Urban Delivery Fee
	UrbanDeliveryFee	Gets or sets Urban Delivery Fee
	UserData1	User Data 1 - User Defined Data #1
	UserData2	User Data 2 - User Defined Data #2
	UserData3	User Data 3 - User Defined Data #3
	UserData4	User Data 4 - User Defined Data #4
	UserData5	User Data 5 - User Defined Data #5
	UserId	Gets or sets UserId
	WaybillBolNumber	Gets or sets Waybill/BOL Number
	Weight	Gets or sets Weight
	weight_unit	Obsolete. Gets or sets Weight
	wharfage_fee_unit	Obsolete. Gets or sets Wharfage
	WharfageFee	Gets or sets Wharfage
	WorldEaseCode	Gets or sets World Ease Code
	WorldEaseFlag	Gets or sets World Ease Flag
	WorldEaseId	Gets or sets World Ease ID
	WorldEaseMasterShipmentId	Gets or sets World Ease Master Shipment ID
	Zone	Gets or sets Zone

Top

Methods

	Name	Description
	Clone	Makes a clone copy of the currently populated Package object.
	createPackageResponse(String)	Obsolete.
	createPackageResponse(Package)	Obsolete.
	CreatePackageResponse(String)	Creates a PackageResponse Object by the serialized Xml.
	CreatePackageResponse(Package)	Converts a Package object to a PackageRequest object.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	getXml	Obsolete.
	GetXml	Gets an Xml Serialized representation of the current PackageResponse Object.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

PSI.Sox Namespace