{"kind":"document","title":"Shipping document","version":"2.0","what":"The key fields read from one document: parties, countries, tariff code, quantity, packages, weights, value, term and references.","status":"live","read_by":{"tool":"check_documents","in_input":"documents","url":"https://www.supplychain.md/api/v1/check_documents"},"filled_by":"The agent, reading the documents the person has","plugs_in_later":"Exporter, forwarder and broker agents sending document data in this format (planned, not live)","schema":{"type":"object","properties":{"type":{"type":"string","enum":["commercial_invoice","packing_list","transport_document","certificate_of_origin","insurance_certificate","purchase_order","inspection_certificate","other"],"description":"What the document is. Use other, with a label, for declarations, licences, safety data sheets and anything else."},"label":{"type":"string","maxLength":80,"description":"The document's name as you'd show it, like Bill of lading 1234."},"seller":{"type":"string","maxLength":160,"description":"Seller, exporter or shipper as the document names it."},"buyer":{"type":"string","maxLength":160,"description":"Buyer or importer as the document names it."},"consignee":{"type":"string","maxLength":160,"description":"Consignee as the document names it. A transport document made out to order is not compared."},"origin_country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Country of origin or dispatch, two-letter code."},"destination_country":{"type":"string","pattern":"^[A-Za-z]{2}$","description":"Destination country, two-letter code."},"hs_code":{"type":"string","maxLength":24,"description":"Tariff code as the document shows it, like 7616.99.5190. Compared on the first 6 digits."},"description":{"type":"string","maxLength":300,"description":"Description of the goods as the document words it."},"quantity":{"type":"number","minimum":0,"description":"Quantity of goods, in the unit the documents use."},"packages":{"type":"integer","minimum":0,"description":"Number of packages: cartons, crates or pallets."},"gross_kg":{"type":"number","minimum":0,"description":"Gross weight, kg."},"net_kg":{"type":"number","minimum":0,"description":"Net weight, kg."},"total_value":{"type":"number","minimum":0,"description":"Total value on the document; for an insurance certificate, the insured value."},"currency":{"type":"string","pattern":"^[A-Za-z]{3}$","description":"Currency code of total_value, like USD."},"trade_term":{"type":"string","maxLength":60,"description":"Trade term with the named place as the document writes it, like FOB and the port of loading."},"po_number":{"type":"string","maxLength":60,"description":"Purchase order number quoted on the document."},"invoice_number":{"type":"string","maxLength":60,"description":"Invoice number quoted on the document."}},"required":["type"],"description":"The documents the agent has, up to 12, each with the fields it read: type (commercial_invoice, packing_list, transport_document, certificate_of_origin, insurance_certificate, purchase_order, inspection_certificate or other), label, seller, buyer, consignee, origin_country, destination_country (two-letter codes), hs_code, description, quantity, packages, gross_kg, net_kg, total_value, currency, trade_term, po_number, invoice_number. Send only what each document shows."},"example":{"type":"commercial_invoice","seller":"Supplier A","buyer":"Buyer B","origin_country":"DE","destination_country":"US","hs_code":"7616.99.5190","description":"Aluminum housings, rev C","quantity":10000,"packages":400,"gross_kg":4800,"net_kg":4400,"total_value":72000,"currency":"USD","trade_term":"FOB port of loading","po_number":"PO-1001","invoice_number":"INV-2001"},"example_note":"Round illustrative numbers, not market data, a price or a quote; send your own.","disclaimer":"Use at your own risk. supplychain.md is provided as is, without warranty. Information here may be inaccurate, incomplete or not current, and is not verified; figures are estimates from the numbers you send and the formulas stated. Nothing here is legal, customs, trade-compliance, tax, financial, insurance, engineering or safety advice, a quote, a rate, or an offer to buy, sell, carry, store, insure or clear goods. supplychain.md never places orders, signs contracts, pays, books freight, files customs entries or gives a quote. Check everything yourself before you act on it.","terms":"https://www.supplychain.md/terms"}