FormTypes Property
Contains the collection of types for international forms that can associate an international shipment.
Syntax
upsshipintl.getFormTypes([callback]) upsshipintl.setFormTypes( formTypes, [callback])
Default Value
0
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getFormTypes([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setFormTypes([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
The FormTypes property is optional. Up to 4 international forms (such as Invoice, Shipper's Export Declaration, Certificate of Origin, NAFTA Certificate of Origin, or Partial Invoice) can be requested within a ship request. To request any of the forms offered by UPS, you must set the FormTypes to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:
Value | Meaning |
0x00000001 | Invoice |
0x00000002 | Shipper's Export Declaration |
0x00000004 | Certificate of Origin |
0x00000008 | NAFTA Certificate of Origin |
Data Type
Integer