Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

PackageReference Property

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

Syntax

char* GetPackageReference(int iPackageIdx);

int SetPackageReference(int iPackageIdx, char* lpszPackageReference);

Default Value

""

Remarks

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 PackageReference 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 PackageReference 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".

The size of the array is controlled by the PackageCount property.

This property is not available at design time.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0