ShipmentServiceOptionsInternationalForms
International Forms information.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| form_type | List[str] | ✅ | Indicates the name of the International Form requested. Valid values: - 01 - Invoice - 03 - CO - 04 - NAFTA CO - 05 - Partial Invoice - 06 - Packinglist - 07 - Customer Generated Forms - 08 – Air Freight Packing List - 09 - CN22 Form - 10 – UPS Premium Care Form - 11 - EEI For shipment with return service, 05 or 10 are the only valid values. Note: 01 and 05 are mutually exclusive and 05 are only valid for return shipments only. |
| product | List[InternationalFormsProduct] | ✅ | |
| user_created_form | InternationalFormsUserCreatedForm | ❌ | Data container for DocumentID(s). Required if Form Type is 07. |
| ups_premium_care_form | InternationalFormsUpsPremiumCareForm | ❌ | UPS Premium Care Form is required if UPS Premium Care Indicator is present on a package. Valid only for Canada to Canada movements. |
| cn22_form | InternationalFormsCn22Form | ❌ | Container for the CN22 form. Required if the customer wants to use the UPS generated CN22. |
| additional_document_indicator | str | ❌ | Presence of the indicator means user will supply additional document, such as EEI, NAFTA_CO or CO. This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality AND the shipper has SELF-PREPARED other International Forms (EEI, CO, NAFTACO) to accompany the shipment. It is evaluated only when: 1. Account is paperless enabled. 2. Movement requires an invoice. 3. Destination country or territory accepts paperless invoice. 4. Invoice data is supplied by the client and the data passes validation. |
| form_group_id_name | str | ❌ | Contains description text which identifies the group of International forms. This element does not appear on the forms. |
| eei_filing_option | InternationalFormsEeiFilingOption | ❌ | EEI Filing option. Applicable for EEI form and is required. |
| contacts | InternationalFormsContacts | ❌ | Holds the contact information of various parties. Applicable for EEI and NAFTA CO only. Required for NAFTA CO and EEI. Ultimate consignee contact information is required for EEI. Producer contact information is required for NAFTA CO |
| invoice_number | str | ❌ | Commercial Invoice number assigned by the exporter. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. |
| invoice_date | str | ❌ | Date when the Invoice is created. Ideally this is the same as the ship date. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice. Format is yyyyMMdd. |
| purchase_order_number | str | ❌ | The customer's order reference number. Applies to Invoice and Partial Invoice forms only. |
| terms_of_shipment | str | ❌ | Indicates the rights to the seller from the buyer. Also, it refers to Terms of Sale. Applies to Invoice and Partial Invoice forms only. Valid values: CFR: Cost and Freight CIF: Cost Insurance and Freight CIP: Carriage and Insurance Paid CPT: Carriage Paid To DAF: Delivered at Frontier DDP: Delivery Duty Paid DDU: Delivery Duty Unpaid DEQ: Delivered Ex Quay DES: Delivered Ex Ship EXW: Ex Works FAS: Free Alongside Ship FCA: Free Carrier FOB: Free On Board |
| reason_for_export | str | ❌ | A reason to export the current international shipment. Valid values: SALE, GIFT, SAMPLE, RETURN, REPAIR, INTERCOMPANYDATA, Any other reason. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and Optional for Partial Invoice. No validation. |
| comments | str | ❌ | Any extra information about the current shipment. Applies to Invoice and Partial Invoice forms only. |
| declaration_statement | str | ❌ | This is the legal explanation, used by Customs, for the delivering of this shipment. It must be identical to the set of declarations actually used by Customs. Examples of declarations that might be entered in this field are: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under the NAFTA. I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin. Applies to Invoice and Partial Invoice forms only. On the invoice for return shipment, the verbiage is as follows (user input is ignored): The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin |
| discount | InternationalFormsDiscount | ❌ | Container tag that holds the discount. Applies to Invoice and Partial Invoice forms only. |
| freight_charges | InternationalFormsFreightCharges | ❌ | Container tag that holds the Freight Charges. Applies to Invoice and Partial Invoice forms only. |
| insurance_charges | InternationalFormsInsuranceCharges | ❌ | Container tag that holds the Insurance Charges. Applies to Invoice and Partial Invoice forms only. |
| other_charges | InternationalFormsOtherCharges | ❌ | Container tag that holds the information of amount that covers additional charges not already listed on the invoice. Applies to Invoice and Partial Invoice forms only. |
| currency_code | str | ❌ | Currency code for all the monetary values of the Invoice form. Applies to Invoice and Partial Invoice forms only. |
| blanket_period | InternationalFormsBlanketPeriod | ❌ | This field should be entered if the NAFTA Certificate covers multiple shipments of identical goods as described in the Description of Goods field that are imported into a NAFTA country or territory for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between these dates. Applies to NAFTA CO form only. Required for NAFTA CO. This is not valid for a paperless shipment. |
| export_date | str | ❌ | The date the goods will be exiting the country or territory. Applies to CO and EEI forms only. Required for CO and EEI forms. Format is yyyyMMdd. |
| exporting_carrier | str | ❌ | The name of the carrier that is exporting the shipment. The vessels flag number should also be entered, if the carrier is a vessel. If value is empty, it will be set to default value as 'UPS' for EEI forms. Applies to CO and EEI forms only. Required for CO forms. |
| carrier_id | str | ❌ | The four-character Standard Carrier Alpha Code (SCAC) for vessel, rail, and truck shipments. For air shipment, enter the two or three character International Air Transport Association (IATA) code. Applies to EEI forms only. No Validations. |
| in_bond_code | str | ❌ | The two-character In Bond Code. Applies to EEI forms only. Required for EEI forms. Valid values for EEI are: 70: Not in bond; 67: IE from a FTZ; 68: T&E from a FTZ. |
| entry_number | str | ❌ | The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks). Applies to EEI forms only. Conditionally Required for EEI forms when In bond code value is other than 70 (Not In Bond) |
| point_of_origin | str | ❌ | Contains one of the following: The two-digit U.S. Postal Service abbreviation for the state from which the goods were shipped to the port of export. The state that is the source for the good with the highest value. The state of consolidation. The Foreign Trade Zone number of the zone from where the exports are leaving. If the goods were shipped from Puerto Rico, enter PR. Applies to EEI forms only. Required for EEI. |
| point_of_origin_type | str | ❌ | Valid values are : S (for state postal code abbreviation) , F : FTZ Identifier Applies EEI forms only. Required for EEI form. |
| mode_of_transport | str | ❌ | Mode of transport by which the goods are exported. Valid values: Air, AirContainerized, Auto, FixedTransportInstallations, Mail, PassengerHandcarried, Pedestrian, Rail, Rail, Containerized, RoadOther, SeaBarge, SeaContainerized, SeaNoncontainerized, Truck, TruckContainerized. Applies to EEI forms only. Required for EEI. Only allowed values can be entered. Only 10 Characters can appear on the form. Anything greater than 10 characters will be truncated on the form. |
| port_of_export | str | ❌ | Should be one of the following-Overland: The U.S. Customs port where the carrier crosses the U.S. border, Vessel and Air: The U.S. Customs port where the goods are loaded on the carrier to be exported from the U.S., Postal: The U.S. Postal Office from where the goods are mailed. Applies to EEI forms only. No validation is performed. |
| port_of_unloading | str | ❌ | The country or territory and the port where the goods will be unloaded from the exporting carrier. For vessel and air shipments only. Applies to EEI forms only. No validation is performed. |
| loading_pier | str | ❌ | Pier where goods are loaded. For vessel shipments only. Applies to EEI forms only. No validation is performed. |
| parties_to_transaction | str | ❌ | Information about parties to transaction. Use Related, if the parties to the transaction are related. A related party is an export from a U.S. businessperson or business to a foreign business or from a U.S. business to a foreign person or business where the person has at least 10 percent of the voting shares of the business during the fiscal year. If unincorporated, then an equivalent interest in the business. Applies to EEI forms only. Valid values: - R - Related - N - Non-related. Parties to transaction is required if EEIFilingOption Code is 3 and if valid UPSFiled POA Code present in request. Default will be set to N - Non-related if invalid code present with length of one. |
| routed_export_transaction_indicator | str | ❌ | If Present, indicates that it is a routed export transaction. A routed export transaction is one, where the foreign principal party in interest authorizes a U.S. forwarding (or other) agent to export the merchandise outside the U.S. Applies to EEI forms only. |
| containerized_indicator | str | ❌ | If present indicates that the goods are containerized. This applies to vessel shipments only. Applies to EEI forms only. |
| override_paperless_indicator | str | ❌ | The application will automatically provide a copy of the invoice or NAFTA/CO with each response regardless of whether the user has enabled Paperless account. The user now has the option to print or ignore the copy provided. |
| shipper_memo | str | ❌ | Text for the shipper to add additional information. Forward shipment only. |
| hazardous_materials_indicator | str | ❌ | This is an empty tag. Presence of the indicator for EEI form means shipment contains hazardous material. |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs