DocumentInfo Type

Specifies the information of the requested document.

Remarks

This type specifies the information of the document to be requested. This include the type of document, the printing options, and the location on disk where the file will be written. This must be set before calling GetShipmentDocuments. For example:

component.UPSAccount.Server = "https://wwwcie.ups.com/webservices/FreightShip";
component.UPSAccount.AccessKey = "Your Access Key";
component.UPSAccount.UserId = "User Id";
component.UPSAccount.Password = "Password";
component.UPSAccount.AccountNumber = "000000";

component.SenderContact.Company = "Developer Test 1";
component.SenderContact.Phone = "884530171";
component.SenderAddress.Address1 = "101 Developer Way";
component.SenderAddress.City = "Richmond";
component.SenderAddress.State = "VA";
component.SenderAddress.ZipCode = "23224";
component.SenderAddress.CountryCode = "US";

component.RecipientContact.Company = "Consignee Test 1";
component.RecipientAddress.Address1 = "1000 Consignee Street";
component.RecipientAddress.City = "Allanton";
component.RecipientAddress.State = "MO";
component.RecipientAddress.ZipCode = "63001";
component.RecipientAddress.CountryCode = "US";

component.Payor.PayorType = TPayorTypes.ptSender;
component.HandlingUnit = "SKD:1";

CommodityDetail item = new CommodityDetail();
item.Description = "LCD TVS";
item.FreightClass = "77.5";
item.Weight = "150";
item.FreightNMFC = "132680";
item.FreightNMFCSub = "02";
item.NumberOfPieces = 20;
item.Value = "100";

component.Commodities.Add(item);

DocumentInfo label = new DocumentInfo();
label.FileName = "TestLabel.pdf";
label.PrintFormat = TFreightPrintFormats.fpfLaser;
label.PrintSize = TFreightPrintSizes.fpsSize8X11;
label.DocumentType = TFreightTypeCodes.ftcLabel;
component.Documents.Add(label);

component.GetShipmentDocuments();

Console.WriteLine("Total Charge: " + component.TotalCharge);
for (int i = 0; i < component.Charges.Count; i++)
{
	Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value);
}
Console.WriteLine("Billable Weight: " + component.BillableWeight);
Console.WriteLine("BOLID: " + component.BOLID);
Console.WriteLine("Shipment Number: " + component.ShipmentNumber);

Fields

DocumentType
int

Specifies the type of document that is requested. Possible values are:


ftcLabel (0)
ftcAWB (1)
ftcUPSBOL (2)
ftcVICSBOL (3)
ftcPackingList (4)

The default value is ftcLabel (0).

File
String

The decoded binary label file.

FileB
byte []

The decoded binary label file.

FileName
String

Specifies where the file will be written. This field must be set before calling GetShipmentDocuments. It should contain the full path and filename to which the returned document will be written when GetShipmentDocuments is called.

LabelsPerPage
int

This specifies the number of labels per page in the returned label file. Possible values are:


flppOne (0)
flppTwo (1)
flppFour (2)

Required when DocumentType is fitLabel. Otherwise it is ignored.

PrintFormat
int

Specifies the print format of the label. Possible values are:


fpfLaser (0)
fpfThermal (1)

Required when DocumentType is fitLabel. Otherwise it is ignored.

PrintSize
int

Specifies the requested print size of the label. Possible values are:


fpsSize4X6 (0)	4x6
fpsSize4X8 (1)	4x8
fpsSize8X11 (2)	8x11 (Recommended for laser label types)

Required when DocumentType is fitLabel. Otherwise it is ignored.

Constructors

public DocumentInfo();