4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

PackageDetail Type

Represents a single package contained in shipment.

Remarks

This type contains specific information on the package that is part of the whole shipment.

Example: Setting the package elements

PackageDetail pckg   = new PackageDetail 
pckg.Weight          = "2.0"
pckg.Description     = "Your order for the 4D Shipping SDK"
pckg.ShippingLabelFileName        = "shipping label for package# 1.pdf"

The fields contained by this type are listed below.

Fields

BaseCharge
String

Base charge applicable to this package.

For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

For UPS, this is the transport charge applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

CODAmount
String

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in CODLabel).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the CODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the CODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by SignatureType) and COD cannot coexist on a single package.

This field is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

CODFile
String

Filename and location to save the CODLabel of this package to. This is applicable for package(s) that use the COD service.

When the CODFile is set to a valid path and filename, the contents of the CODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then CODFile has to have .pdf extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

This field is only applicable to FedEx shipments.

CODLabel
String

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This field is only applicable to FedEx.

CODLabelB
Byte[]

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the CODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a CODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This field is only applicable to FedEx.

CODType
TPCODTypes

The code that indicates the type of funds that will be used for the COD payment for this package.

This field is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., CODAmount is set to a value other than "0.00").

Valid values are:

Value Description
codtpAny (0) Company check, personal check, cashier's check or money order - UPS no cash allowed. Not applicable for Canada Post
codtpCash (1) Cash - FedEx only, only valid for Ground shipments
codtpGuaranteedFunds (2) Cashier's check or money order
codtpCompanyCheck (3) Company check - FedEx and Canada Post only
codtpPersonalCheck (4) Personal check - FedEx and Canada Post only

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

DangerousGoodsAccessible
Boolean

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This field is only applicable to FedEx shipments, and is required to be specified when the SpecialServices contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

  • Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The DangerousGoodsAccessible should be set to True.
  • Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The DangerousGoodsAccessible should be set to False.
The accessibility type affects the service availability and rates.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates component by requesting rates for all available services.

DangerousGoodsOptions
Integer

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:

Value Meaning
0x00000001 Hazardous Materials
0x00000002 Lithium Ion Battery Exception
0x00000004 Other Regulated Materials - Domestic (ORM-D)
0x00000008 Reportable Quantities
0x00000010 Small Quantity Exception

Note: This is only valid when using FedEx.

Description
String

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

Girth
Integer

Measurement around the widest part of the package, perpendicular to the Length.

This field is only applicable when requesting rates for USPS packages.

Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Height
Integer

The height of the package to be shipped.

For FedEx, the Height is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Width are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set). For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

Id
String

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This field is optional, and only applies to USPS return labels.

InsuredValue
String

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

Length
Integer

The length of the package to be shipped.

For FedEx, the Length is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Width and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Note: For parcels, the Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

NetCharge
String

Net charge applicable to this package.

For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl components only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

PackagingType
TPackagingTypes

The packaging type of the package being rated and/or shipped.

Possible values are:

Value FedEx UPS USPS USPS (Endicia) USPS (Stamps.com) Canada Post
ptNone (0) X X X
ptPostcards (1) X X X
ptLetter (2) X X X X
ptLargeEnvelope (3) X X X
ptFlatRateEnvelope (4) X X X
ptFlatRateLegalEnvelope (5) X X X
ptFlatRatePaddedEnvelope (6) X X X
ptFlatRateGiftCardEnvelope (7) X X
ptFlatRateWindowEnvelope (8) X X
ptFlatRateCardboardEnvelope (9) X
ptSmallFlatRateEnvelope (10) X X
ptPak (11) X X
ptBox (12) X X
pt10kgBox (13) X X
pt25kgBox (14) X X
ptSmallExpressBox (15) X
ptMediumExpressBox (16) X
ptLargeExpressBox (17) X
ptFlatRateBox (18) X X
ptSmallFlatRateBox (19) X X X
ptMediumFlatRateBox (20) X X X
ptLargeFlatRateBox (21) X X X
ptDVDFlatRateBox (22) X
ptLargeVideoFlatRateBox (23) X
ptRegionalRateBoxA (24) X X X
ptRegionalRateBoxB (25) X X X
ptRectangular (26) X
ptNonRectangular (27) X
ptTube (28) X X X
ptMatterForTheBlind (29) X
ptPallet (30) X
ptYourPackaging (31) X X X X X X
ptDocument (32) X
ptFlats (33) X
ptParcels (34) X
ptBPM (35) X
ptFirstClass (36) X
ptPriority (37) X
ptMachinables (38) X
ptIrregulars (39) X
ptParcelPost (40) X
ptBPMParcel (41) X
ptMediaMail (42) X
ptBPMFlat (43) X
ptStandardFlat (44) X
ptRegionalRateBoxC (45) X X X
ptThickEnvelope (46) X X X
ptSmallBox (47) X
ptMediumBox (48) X
ptLargeBox (49) X
ptVeryLargeBox (50) X

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0), except for with FedEx, in which case it will default to ptLetter (2).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagingType for the first package is used in label requests.

If the PackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: Length, Width, and Height.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagingType make sure this is valid for all the following: CountryCode, CountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

ServiceType PackagingType Weight
stFirstClass (35) ptFirstClass (36) 1 to 13 OZS
stPriorityMail (36) ptPriority (37) 1 to 70 LBS
stExpeditedMailInnovations (37) ptMachinables (38) 6 to <16 OZS
stExpeditedMailInnovations (37) ptIrregulars (39) 1 to <16 OZS
stExpeditedMailInnovations (37) ptParcelPost (40) 1 to 70 LBS
stExpeditedMailInnovations (37) ptBPMParcel (41) 1 to 15 LBS
stExpeditedMailInnovations (37) ptMediaMail (42) 1 to 70 LBS
stExpeditedMailInnovations (37) ptBPMFlat (43) 1 to 15 LBS
stExpeditedMailInnovations (37) ptStandardFlat (44) 1 to <16 OZS
stPriorityMailInnovations (38) ptFlats (33) 1 to 70 LBS
stPriorityMailInnovations (38) ptParcels (34) 1 to 70 LBS
stPriorityMailInnovations (38) ptBPM (35) 1 to 70 LBS
stEconomyMailInnovations (39) ptFlats (33) 1 to 70 LBS
stEconomyMailInnovations (39) ptParcels (34) 1 to 70 LBS
stEconomyMailInnovations (39) ptBPM (35) 1 to 70 LBS

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

RatingAggregate
String

Rating aggregate applicable to this package.

Reference
String

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:

Type valueMeaning
CR Customer Reference - this gets printed on shipping label and invoice.
BL Bill Of Lading - this gets printed on shipping label, Ground shipping reports, and in the Customer Reference element on the invoice.
IN Invoice Number - this gets printed on shipping label and invoice.
PO Purchase Order Number - this gets printed on shipping label and invoice.
DN Department Number - this gets printed on shipping label and invoice.
SI Shipment Integrity - this gets printed on invoice only.
SN Store Number - this gets printed on shipping label and invoice.
IR Intracountry Reglatory Reference
EPC Electronic Product Code
RMA RMA Number

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the Reference should be set to: CN:123456; IN:123; SN:12;.

Reference information may also be used to track packages by reference.

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:

Code Reference Number Type
AJ Accounts Receivable Customer Account
AT Appropriation Number
BM Bill of Lading Number
9V Collect on Delivery (COD) Number
ON Dealer Order Number
DP Department Number
3Q Food and Drug Administration (FDA) Product Code
IK Invoice Number
MK Manifest Key Number
MJ Model Number
PM Part Number
PC Production Code
PO Purchase Order Number
RQ Purchase Request Number
RZ Return Authorization Number
SA Salesperson Number
SE Serial Number
ST Store Number
TN Transaction Reference Number
EI Employer ID Number
TJ Federal Taxpayer ID No.
SY Social Security Number

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this package, the Reference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track packages by reference.

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

ReturnReceipt
String

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

ReturnReceiptB
Byte[]

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

ReturnReceiptFile
String

Filename and location to save the ReturnReceipt of this package to. This is applicable only if using UPS.

When the ReturnReceiptFile is set to a valid path and filename, the contents of the ReturnReceipt are written to disk upon successful response (if a return shipment).

The ReturnReceiptFile has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

ShippingLabel
String

Image of the shipping label for this package return by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

ShippingLabelB
Byte[]

Image of the shipping label for this package return by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

ShippingLabelFile
String

Filename and location to save the ShippingLabel of this package to. When the ShippingLabelFile is set to a valid path and filename, the contents of the ShippingLabel are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then ShippingLabelFile has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

SignatureType
TSignatureTypes

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

stServiceDefault (0) The default value for the requested service.
stAdult (1) Available for both residential and nonresidential deliveries.
stDirect (2) Available for both residential and nonresidential deliveries.
stIndirect (3) Available for residential deliveries only.
stNoSignatureRequired (4)Not available for Ground services.
stUSPSDeliveryConfirmation (5)Available for UPS Mail Innovations only.
stAdult19 (6)Available for Canada Post only.

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

  • Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
  • Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
  • Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
  • Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the SignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

Size
TPackages

Size of the package being mailed.

This field is only used by USPS and is required for the GetRates method call.

See below for valid entries:

Package SizeDescriptionServiceType
psRegularFor Priority Mail: Package is less than one cubic foot in size. For all other ServiceTypes: Package length plus girth is 84 inches or less. Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
psLargeFor Priority Mail: Package is greater than one cubic foot in size. For all other ServiceTypes: Package length plus girth measure more than 84 inches but not more than 108 inches. This tag does not affect the rate for Express Mail, Bound Printed Mater, Media Mail or Library Mail.Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
dsOversizePackage length plus girth is more than 108 but not more than 130 inches. Parcel Post packages that measure more than 108 inches but not more than 130 inches in combined length and girth are charged the oversized Parcel Post rate regardless of the weight of the package.Parcel Post only.

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the Length, Height, Width and optionally Girth (irregular shaped packages only) fields to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

SpecialServices
Long

Contains the collection of special services offered on the package level. Valid values are:

Value Meaning FedEx UPS
0x00000001 Appointment Delivery X
0x00000002 Dangerous Goods X X
0x00000004 Dry Ice X
0x00000008 Priority Alert X
0x00000010 Non Standard Container X X
0x00000020 COD X
0x00000040 Additional Handling X
0x00000080 Signature Option X
0x00000100 Alcohol X

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the SpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

  • Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
  • Dangerous Goods: Indicates that this package contains dangerous goods. When the SpecialServices contains this flag, then the DangerousGoodsAccessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
  • Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
  • Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
  • Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
  • COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the CODAmount and CODType must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the SpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

  • Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
  • Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the CODAmount and CODType, SignatureType, and InsuredValue.

This field is not applicable to USPS or Canada Post.

TotalDiscount
String

Total discount applicable to this package.

This is specific to the FedEx AccountNumber. It is used in the FedExShip and FedExShipIntl components only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

TotalSurcharges
String

Total surcharges applicable to this package.

For FedEx, this is specific to the AccountNumber. It is used in the FedExShip and FedExShipIntl components only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

TrackingNumber
String

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

Weight
String

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

Width
Integer

The width of the package to be shipped.

For FedEx, the Width is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Height are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

Constructors

[VB.NET]
Public PackageDetail()

[C#]
public PackageDetail();



[VB.NET]
Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String)

[C#]
public PackageDetail(int packagingType, string weight);



[VB.NET]
Public PackageDetail(ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer)

[C#]
public PackageDetail(int length, int width, int height);



[VB.NET]
Public PackageDetail(ByVal PackagingType As Integer, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer)

[C#]
public PackageDetail(int packagingType, int length, int width, int height);



[VB.NET]
Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer)

[C#]
public PackageDetail(int packagingType, string weight, int length, int width, int height);



[VB.NET]
Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal CODType As Integer, ByVal SignatureType As Integer)

[C#]
public PackageDetail(int packagingType, string weight, int length, int width, int height, int specialServices, string insuredValue, string CODAmount, int CODType, int signatureType);



[VB.NET]
Public PackageDetail(ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal DangerousGoodsAccessible As Boolean, ByVal SignatureType As Integer)

[C#]
public PackageDetail(string weight, int length, int width, int height, int specialServices, string insuredValue, string CODAmount, bool dangerousGoodsAccessible, int signatureType);



[VB.NET]
Public PackageDetail(ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Description As String, ByVal Reference As String, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal DangerousGoodsAccessible As Boolean, ByVal SignatureType As Integer, ByVal ShippingLabelFile As String, ByVal CODFile As String)

[C#]
public PackageDetail(string weight, int length, int width, int height, string description, string reference, int specialServices, string insuredValue, string CODAmount, bool dangerousGoodsAccessible, int signatureType, string shippingLabelFile, string CODFile);



[VB.NET]
Public PackageDetail(ByVal PackagingType As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Description As String, ByVal Reference As String, ByVal SpecialServices As Integer, ByVal InsuredValue As String, ByVal CODAmount As String, ByVal CODType As Integer, ByVal SignatureType As Integer, ByVal ShippingLabelFile As String, ByVal ReturnReceiptFile As String)

[C#]
public PackageDetail(int packagingType, string weight, int length, int width, int height, string description, string reference, int specialServices, string insuredValue, string CODAmount, int CODType, int signatureType, string shippingLabelFile, string returnReceiptFile);



 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]