ShipmentReference Property
Customer-defined number (that may or may not be unique) used to identify the whole shipment.
Syntax
[VB.NET] Public Property ShipmentReference As String
[C#] public string ShipmentReference {get; set;}
Remarks
This is applicable to international shipments only. Valid if the origin/destination pair is not US/US or PR/PR.
This is optional to be provided in a ship request (when the GetShipmentLabels method is called). You can enter up to two customer references on shipment 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 |
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 shipment, the ShipmentReference 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 shipment by reference.
Default Value
""