CommercialInvoicePurpose Property
Reason to export the current international shipment Required for dutiable international express or ground shipment.
Syntax
fedexshipintl.getCommercialInvoicePurpose([callback]) fedexshipintl.setCommercialInvoicePurpose( commercialInvoicePurpose, [callback])
Possible Values
0 (cipSold), 1 (cipGift), 2 (cipNotSold), 3 (cipPersonalEffects), 4 (cipReturn), 5 (cipRepair), 6 (cipRepairAndReturn), 7 (cipSample), 8 (cipInterCompanyData)
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 getCommercialInvoicePurpose([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 setCommercialInvoicePurpose([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
Reason to export the current international shipment
Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.
Valid values are:
Value | FedEx | UPS | |
cipSold (0) | X | X | |
cipGift (1) | X | X | |
cipNotSold (2) | X | ||
cipPersonalEffects (3) | X | ||
cipReturn (4) | X | ||
cipRepair (5) | X | ||
cipRepairAndReturn (6) | X | ||
cipSample (7) | X | X | |
cipInterCompanyData (8) | X |
Data Type
Integer