Prepare a shipment
prepare_shipmentRead-only
One call for an export order: the same order data as create_trade_documents plus the destination country (ISO code). Returns the link to the filled-in documents with totals and checks, Triplicate's guides for that destination and the products' HS chapters (country guide, labelling and import rules), a link to the landed cost calculator preset to the market, goods value and quantity, and HS lookups for items without a code. Nothing is stored.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bank | No | ||
| buyer | Yes | Buyer / consignee / importer | |
| items | Yes | ||
| terms | No | ||
| notify | No | Notify party, if different from the buyer | |
| seller | Yes | Seller / shipper / exporter | |
| signer | No | ||
| charges | No | ||
| remarks | No | Optional remarks printed on the documents, e.g. 'SAMPLES OF NO COMMERCIAL VALUE, NOT FOR RESALE. VALUE FOR CUSTOMS PURPOSES ONLY.' | |
| sold_to | No | Only if the buyer (sold to) is a different company from the consignee in 'buyer', e.g. a trading company buying for a factory: printed as BUYER (SOLD TO) on the invoice, the buyer on the proforma and sales contract | |
| document | No | ||
| language | No | Language of the generator page the link opens (documents are in English) | en |
| shipment | No | ||
| hs_totals | No | Also print totals by HS code (quantity, value, cartons, weights) on the invoice and packing list, for the customs broker's entry lines | |
| open_form | No | Also open one of the generator's extra forms with this data: VGM declaration (SOLAS, needs shipment.containers), ISF (10+2) data for a US buyer, USMCA/CUSMA certification of origin, packing declaration for sea containers to Australia, draft (bill of exchange), beneficiary's certificate, credit/debit note, shipping advice e-mail, or a return/repair invoice made from this invoice (the original invoice number, date and waybill as reference; the buyer as shipper when goods come back). Each has 3 free uses (the shipping advice has no limit). | |
| manufacturer | No | Who made the goods, printed on the commercial invoice with its MID code (US shipments: carriers and CBP ask for it; textile and apparel entries must show it). The generator suggests the MID from 19 CFR Part 102 if mid is empty | |
| open_document | No | pi proforma invoice, ci commercial invoice, pl packing list, si shipping instruction, sc sales contract (seller and buyer sign; the remarks become its other terms), co certificate of origin (non-preferential: the exporter's declaration, with space for a chamber of commerce to certify it), po purchase order (the buyer's order to the supplier: buyer = issuer, seller = supplier) | ci |
| imperial_units | No | Also show weights in pounds and volume in cubic feet on the packing list and shipping instruction (for US buyers) | |
| shipping_marks | No | Optional; generated from buyer, destination and carton count if empty | |
| letter_of_credit | No | Terms of the letter of credit (from MT700: 20, 31C, 32B, 39A, 44C, 31D, 48, 43P, 45A); the generator checks the documents against them (not among the free features) | |
| origin_statement | No | Preferential origin statement printed on the commercial invoice in the agreement's exact wording (3 free uses). Only for goods that meet the agreement's rules of origin. | |
| destination_country | No | ISO 3166-1 alpha-2 code of the importing country, e.g. SE, US, VN; picks the guides and presets the landed cost calculator |