{"openapi":"3.1.0","info":{"title":"Freightools GPT API","version":"0.1.0","description":"One JSON per import shipment → validated completely (L0–L5) before any Freightools write → Customer Shipment + Shipping Order created with read-back verification → the Israeli customs sub-manifest transmitted when `submitManifest` is true and the gates are open → MN_MSG4 feedback returned. The portal renders the same representation.\n\nAuthentication: `Authorization: Bearer em_test_<keyId>.<secret>` / `em_live_<keyId>.<secret>`. Keys are environment-bound (a test key never reaches production and vice versa), scoped (shipments:read, shipments:write, manifest:send, documents:read, documents:write, logs:xml, org:read) and shown once.\n\nRate limit: 60 requests per minute per API key by default (token bucket; the platform administrator can change it); 429 with Retry-After. A retry of the same body is always safe (identical replay).\n\nStart with the integrator guide at /docs/guide: the JSON structure per variant with every field, its validation and what customs receives, the seven minimal examples, the states and the decision rules. The request body of POST /v1/shipments (ShipmentBody) is a oneOf of the five variant schemas; the examples attached to that operation are the bodies to copy.\n\nEvery non-2xx response is the ErrorEnvelope `{type, status, requestId, shipmentRef?, message?, errors[] {path, code, message, value?, hint?}, warnings?}`; the same `{path, code, message}` shape is used for warnings[] and knownDeviations[].\n\nTimes are ISO 8601 UTC; Freightools identifiers are strings; `version` is the ETag."},"servers":[{"url":"https://easy-manifest-production.up.railway.app"}],"security":[{"bearer":[]}],"tags":[{"name":"Shipments"},{"name":"Customs"},{"name":"Actions"},{"name":"Documents"},{"name":"Reference"},{"name":"Org"},{"name":"Meta"}],"paths":{"/v1/shipments":{"post":{"operationId":"submitShipment","tags":["Shipments"],"summary":"Create or update a shipment by shipmentRef","description":"Same `shipmentRef` = same shipment, never a 409 (the one exception: the ref of a shipment synced from Freightools — its customer shipment code, e.g. \"CS 012345\" — is 409 `shipment_ref_synced`; that shipment is managed in Freightools, so submit under your own reference): identical data and intent → 200 + `Idempotent-Replayed: true` (a submissions row only; whitespace, key order and number formatting do not count as changes because the comparison is a hash of the normalised body); same data with `submitManifest` flipped → 202 intent revision (no Freightools write; false→true arms the automatic send, true→false disarms it and invalidates a queued send); changed data → 202 data revision applied immediately, also after a transmission (then `manifest.state` becomes `updated_not_retransmitted` and a `customs_decision` action opens; nothing is retransmitted without your decision). A change of variant is 422 `unsupported_change`: use a new shipmentRef. `options.dryRun: true` validates and resolves completely, writes nothing (not even a submissions row) and answers 200 with the warnings and knownDeviations.\n\n`processing.state = waiting` is NOT success and not an error: the shipment is applied and waits for Freightools' customs lookup (manifest number, IL1, IL2). `manifest.state = accepted` is the only success state and comes only from a correlated MN_MSG4. `knownDeviations[]` lists what customs does not receive today with the Freightools change request that would fix it.\n\n`Prefer: wait=N` (N ≤ 20) waits up to N seconds for the Freightools apply before answering; it only progresses when a worker is running. Response codes: 201 new shipment (Location header), 202 new revision applying, 200 identical replay or dry run; 402 `payment_method_required` when a company on the free trial has used its 10 free shipments and the body would create a NEW production shipment.\n\nScope `shipments:write`.","security":[{"bearer":[]}],"parameters":[{"name":"Prefer","in":"header","required":false,"schema":{"type":"string","pattern":"^wait=\\d+$"},"example":"wait=20"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentBody"},"examples":{"fcl-single":{"summary":"FCL, one container with dangerous goods (minimal body)","value":{"shipmentRef":"EXAMPLE-FCL-001","submitManifest":true,"service":{"mode":"ocean","load":"FCL"},"parties":{"shipper":{"name":"Example Trading Co., Ltd","address":"12 Harbour Road","city":"Shenzhen","country":"CN"},"consignee":{"name":"Example Imports Ltd","taxId":"510000128","address":"5 Industrial Street","city":"Tel Aviv-Yafo","country":"IL"}},"dgContact":{"company":"Example Forwarding Ltd","person":"Operations desk","phone":"+972500000000","phoneType":"TE"},"routing":{"pol":"CNSZX"},"carriage":{"carrier":{"scac":"MSCU"},"vessel":{"imo":"9308584","name":"MSC NINA F"},"voyage":"001E","eta":"2026-12-20"},"master":{"document":{"number":"MSCUEX0000001"},"loadingPort":"CNSHK","dischargeSite":"ILAST"},"house":{"document":{"number":"EXHBL0000001"}},"commercial":{"incoterm":"EXW"},"cargo":{"containers":[{"number":"EXMU0000015","isoType":"45G1","seal":"SEAL000001","grossKg":11500,"packages":{"count":14,"type":"PK"},"goods":[{"hs":"870310","description":"ELECTRIC VEHICLES","dangerous":{"unNumber":"3556","class":"9"}}]}]}}},"fcl-multi-7":{"summary":"FCL, seven 40'HC containers","value":{"shipmentRef":"EXAMPLE-FCL-007","submitManifest":true,"service":{"mode":"ocean","load":"FCL"},"parties":{"shipper":{"name":"Example Panels S.A.","address":"8 Port Avenue","city":"Constanta","country":"RO"},"consignee":{"name":"Example Imports Ltd","taxId":"510000128","address":"5 Industrial Street","city":"Tel Aviv-Yafo","country":"IL"}},"routing":{"pol":"ROCND"},"carriage":{"carrier":{"scac":"MSCU"},"vessel":{"imo":"9376141","name":"MSC POLINA"},"voyage":"002W","eta":"2026-12-22"},"master":{"document":{"number":"MSCUEX0000007","type":"waybill"},"dischargeSite":"ILAST"},"house":{"document":{"number":"EXHBL0000007","type":"telex"}},"commercial":{"incoterm":"FCA"},"cargo":{"containers":[{"number":"EXMU0001011","isoType":"45G0","seal":"SEAL000101","grossKg":27000,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]},{"number":"EXMU0001027","isoType":"45G0","seal":"SEAL000102","grossKg":27100,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]},{"number":"EXMU0001032","isoType":"45G0","seal":"SEAL000103","grossKg":27200,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]},{"number":"EXMU0001048","isoType":"45G0","seal":"SEAL000104","grossKg":27300,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]},{"number":"EXMU0001053","isoType":"45G0","seal":"SEAL000105","grossKg":27400,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]},{"number":"EXMU0001069","isoType":"45G0","seal":"SEAL000106","grossKg":27500,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]},{"number":"EXMU0001074","isoType":"45G0","seal":"SEAL000107","grossKg":27600,"packages":{"count":16,"type":"PK"},"goods":[{"hs":"441011","description":"MELAMINE FACED CHIPBOARDS"}]}]}}},"fcl-dg-3x20":{"summary":"FCL, three 20' containers with class 8 dangerous goods","value":{"shipmentRef":"EXAMPLE-FCL-DG","submitManifest":true,"service":{"mode":"ocean","load":"FCL"},"parties":{"shipper":{"name":"Example Batteries A.S.","address":"3 Factory Road","city":"Izmit","country":"TR"},"consignee":{"name":"Example Imports Ltd","taxId":"510000128","address":"5 Industrial Street","city":"Tel Aviv-Yafo","country":"IL"}},"dgContact":{"company":"Example Forwarding Ltd","person":"Operations desk","phone":"+972500000000","phoneType":"TE"},"routing":{"pol":"TRIZT"},"carriage":{"carrier":{"scac":"YMLU"},"vessel":{"imo":"9757230","name":"YM WELLSPRING"},"voyage":"003E","eta":"2026-12-18"},"master":{"document":{"number":"YMLUEX0000003"},"dischargeSite":"ILASH"},"house":{"document":{"number":"EXHBL0000003"}},"commercial":{"incoterm":"FOB"},"cargo":{"containers":[{"number":"EXMU0002018","isoType":"22G0","seal":"SEAL000201","grossKg":25400,"packages":{"count":28,"type":"PK"},"goods":[{"hs":"850710","description":"BATTERIES, WET, FILLED WITH ACID, ELECTRIC STORAGE","dangerous":{"unNumber":"2794","class":"8"}}]},{"number":"EXMU0002023","isoType":"22G0","seal":"SEAL000202","grossKg":25350,"packages":{"count":28,"type":"PK"},"goods":[{"hs":"850710","description":"BATTERIES, WET, FILLED WITH ACID, ELECTRIC STORAGE","dangerous":{"unNumber":"2794","class":"8"}}]},{"number":"EXMU0002039","isoType":"22G0","seal":"SEAL000203","grossKg":25300,"packages":{"count":28,"type":"PK"},"goods":[{"hs":"850710","description":"BATTERIES, WET, FILLED WITH ACID, ELECTRIC STORAGE","dangerous":{"unNumber":"2794","class":"8"}}]}]}}},"lcl-line-master":{"summary":"LCL under a line master","value":{"shipmentRef":"EXAMPLE-LCL-001","submitManifest":true,"service":{"mode":"ocean","load":"LCL","lcl":{"arrangement":"lineMaster"}},"parties":{"shipper":{"name":"Example Textiles SAS","address":"21 Quai Example","city":"Le Havre","country":"FR"},"consignee":{"name":"Example Retail Ltd","taxId":"510000342","address":"9 Market Street","city":"Netanya","country":"IL"}},"routing":{"pol":"FRLEH"},"carriage":{"carrier":{"name":"MEDKON"},"vessel":{"imo":"9366457","name":"MEDKON PERLA"},"voyage":"004E","eta":"2026-12-15"},"master":{"document":{"number":"MEDKEX0000001"},"dischargeSite":"ILASH","goodsReceiptSite":"ILBXQ"},"house":{"document":{"number":"EXHBL0000011","type":"telex"}},"commercial":{"incoterm":"FOB"},"cargo":{"container":{"number":"EXMU0003014","isoType":"45G1","seal":"SEAL000301"},"packages":[{"count":4,"type":"CT","grossKg":842.5,"goods":[{"hs":"620342","description":"MEN'S COTTON TROUSERS"}]}]}}},"lcl-coload":{"summary":"LCL co-load under another forwarder's house","value":{"shipmentRef":"EXAMPLE-LCL-COLOAD","submitManifest":true,"service":{"mode":"ocean","load":"LCL","lcl":{"arrangement":"coload"}},"parties":{"shipper":{"name":"Example Chemie GmbH","address":"Hafenstrasse 1","city":"Hamburg","country":"DE"},"consignee":{"name":"Example Chemicals Ltd","taxId":"510000565","address":"14 Science Park","city":"Haifa","country":"IL"},"coloader":{"name":"Example Consolidation GmbH","address":"Speicherstadt 2","city":"Hamburg","country":"DE"}},"dgContact":{"company":"Example Forwarding Ltd","person":"Operations desk","phone":"+972500000000","phoneType":"TE"},"routing":{"pol":"DEHAM"},"carriage":{"eta":"2026-12-12"},"master":{"issuer":"coloader","document":{"number":"EXCONSOL000001"},"dischargeSite":"ILASH","goodsReceiptSite":"ILMTS"},"house":{"document":{"number":"EXHBL0000021"}},"commercial":{"incoterm":"CIF"},"cargo":{"container":{"number":"EXMU0004010","isoType":"45G1"},"packages":[{"count":2,"type":"CT","grossKg":1610.4,"cbm":2.75,"marks":"EXAMPLE CHEMICALS 1-2","goods":[{"hs":"330210","description":"ODORIFEROUS MIXTURES","dangerous":{"unNumber":"3082","class":"9","packingGroup":"III"}}]}]}}},"air-house":{"summary":"Air import house; created, send blocked until CR-AIR","value":{"shipmentRef":"EXAMPLE-AIR-001","submitManifest":true,"service":{"mode":"air"},"parties":{"shipper":{"name":"Example Garments Co., Ltd","address":"88 Textile Avenue","city":"Shanghai","country":"CN"},"consignee":{"name":"Example Fashion Ltd","taxId":"510000789","address":"15 Kinneret Street","city":"Bnei Brak","country":"IL"}},"routing":{"aol":"CNPVG","aod":"ILTLV","acceptancePlace":"SHANGHAI"},"carriage":{"airline":{"iata":"EY"},"flight":{"number":"123","date":"2026-12-10"}},"master":{"document":{"number":"607-12345675"},"dischargeSite":"ILMMN"},"house":{"document":{"number":"EXHAWB000001"},"placeOfIssue":"SHANGHAI"},"commercial":{"incoterm":"FOB"},"cargo":{"pieces":[{"count":33,"type":"CT","grossKg":285,"goods":[{"hs":"611595","description":"KNITTED GARMENTS"}]}]}}},"fcl-everything-optional":{"summary":"FCL with every optional member and options.dryRun (guide §4.7)","value":{"shipmentRef":"EXAMPLE-FCL-001","submitManifest":true,"service":{"mode":"ocean","load":"FCL","scope":"door-port"},"parties":{"shipper":{"name":"Example Trading Co., Ltd","address":"12 Harbour Road","city":"Shenzhen","country":"CN","zip":"518000","phone":"+8675500000000","email":"export@example-trading.test","partnerCode":"EXT-001","taxId":"IDCN914403000001","taxIdType":"company"},"consignee":{"name":"Example Imports Ltd","taxId":"510000128","address":"5 Industrial Street","city":"Tel Aviv-Yafo","country":"IL","zip":"6701101","phone":"+97230000000","email":"imports@example-imports.test","partnerCode":"EXI-001","taxIdType":"company"},"notify":{"name":"Example Logistics Ltd","address":"2 Port Road","city":"Ashdod","country":"IL","phone":"+97280000000"},"customer":{"party":"consignee","reference":"PO-2026-000123"},"customsBroker":{"name":"Example Customs Brokers Ltd","taxId":"510000904","address":"7 Customs Square","city":"Ashdod","country":"IL"}},"dgContact":{"company":"Example Forwarding Ltd","person":"Operations desk","phone":"+972500000000","phoneType":"TE"},"routing":{"pol":"CNSZX","pod":"ILASH","placeOfReceipt":{"country":"CN","city":"Dongguan","zip":"523000","address":"1 Example Factory Road"},"acceptancePlace":"DONGGUAN","transshipmentPorts":["CNNGB"]},"carriage":{"carrier":{"scac":"MSCU","name":"MSC"},"vessel":{"imo":"9308584","name":"MSC NINA F"},"voyage":"001E","eta":"2026-12-20","etd":"2026-11-15","booking":"EXBOOK000001","transshipments":[{"port":"CNNGB","vessel":{"imo":"9376141","name":"MSC POLINA"},"voyage":"002W","eta":"2026-12-05"}]},"master":{"issuer":"carrier","document":{"number":"MSCUEX0000001","type":"original"},"loadingPort":"CNSHK","dischargeSite":"ILAST","goodsReceiptSite":"ILAST"},"house":{"document":{"number":"EXHBL0000001","type":"original"},"placeOfIssue":"SHENZHEN"},"commercial":{"incoterm":"EXW","freightTerms":"collect"},"cargo":{"containers":[{"number":"EXMU0000015","isoType":"45G1","seal":"SEAL000001","grossKg":11500,"cbm":68,"tareKg":3900,"soc":false,"reefer":{"active":false},"packages":{"count":14,"type":"PK","marks":"EXAMPLE IMPORTS 1-14"},"goods":[{"hs":"870310","description":"ELECTRIC VEHICLES","additionalHs":["870380"],"dangerous":{"unNumber":"3556","class":"9","packingGroup":"III","properShippingName":"VEHICLE, LITHIUM ION BATTERY POWERED"},"vehicles":[{"vin":"1HGBH41JXMN109186"}],"value":{"amount":42000,"currency":"USD"}}]}],"totalCbm":68},"options":{"dryRun":true}}},"fcl-export-booking":{"summary":"FCL export from Israel at booking: no container numbers, seals, HS or B/L numbers yet; incoterm derived","value":{"shipmentRef":"EXAMPLE-EXP-001","service":{"mode":"ocean","load":"FCL"},"parties":{"shipper":{"name":"Example Exports Ltd","taxId":"510000128","address":"5 Industrial Street","city":"Haifa","country":"IL"},"consignee":{"name":"Example Handel GmbH","address":"1 Hafenstrasse","city":"Hamburg","country":"DE"},"customer":{"reference":"PO-EXAMPLE-77"}},"routing":{"pol":"ILHFA","pod":"DEHAM"},"carriage":{"carrier":{"scac":"MSCU"},"etd":"2026-12-02","eta":"2026-12-20","booking":"EXBOOK0000001"},"cargo":{"containers":[{"isoType":"45G1","grossKg":12000,"goods":[{"description":"MACHINE PARTS"}]},{"isoType":"45G1","grossKg":11500,"goods":[{"description":"MACHINE PARTS"}]}]}}},"fcl-cross-trade":{"summary":"FCL cross-trade (neither end in Israel), tracking switched off","value":{"shipmentRef":"EXAMPLE-XT-001","service":{"mode":"ocean","load":"FCL"},"parties":{"shipper":{"name":"Example Trading Co., Ltd","address":"12 Harbour Road","city":"Shenzhen","country":"CN"},"consignee":{"name":"Example Handel GmbH","address":"1 Hafenstrasse","city":"Hamburg","country":"DE"},"customer":{"party":"consignee","reference":"PO-EXAMPLE-88"}},"routing":{"pol":"CNSZX","pod":"DEHAM"},"carriage":{"carrier":{"scac":"MSCU"},"eta":"2027-01-15"},"master":{"document":{"number":"MSCUEX0000205"}},"house":{"document":{"number":"EXHBL0000205","type":"waybill"}},"commercial":{"incoterm":"FOB"},"cargo":{"containers":[{"number":"EXMU0000205","isoType":"45G1","seal":"SEAL000205","grossKg":9800,"packages":{"count":40,"type":"CT"},"goods":[{"hs":"441011","description":"PARTICLE BOARD"}]}]},"tracking":{"active":false}}}}}}},"responses":{"200":{"description":"Identical replay (header Idempotent-Replayed: true) or dry run","headers":{"Idempotent-Replayed":{"schema":{"type":"string","const":"true"}},"ETag":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ShipmentView"},{"$ref":"#/components/schemas/DryRunResponse"}]},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"201":{"description":"New shipment; revision 1 queued for apply","headers":{"Location":{"schema":{"type":"string"}},"ETag":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"202":{"description":"New revision (data or intent) accepted","headers":{"ETag":{"schema":{"type":"string"},"description":"The shipment version, for If-Match"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"402":{"description":"payment_method_required: \"Your first 10 shipments were free. Add a payment method to create more.\" The company is on the free trial, its first 10 production shipments are used, and the body names a shipmentRef the environment does not have yet. Nothing was validated or recorded. `settingsUrl` is the portal page Settings → Usage & billing, where an owner or admin adds the payment method. Never answered for a new revision of an existing shipment, a dry run, the test environment, or a company with a payment method on file or billed by Freightools.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"shipment_ref_synced: the shipmentRef is the customer shipment code of a shipment synced from Freightools (managed in Freightools; use your own reference)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"Body over 1 MiB or file over the tenant limit (payload_too_large)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"422":{"description":"Validation failed at L2–L5 (resolution_error, unsupported, consistency_error, policy_error)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Rate limit (60 requests/min per API key) or manual re-poll pacing; Retry-After is set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"gate_closed (an environment go-live switch is off: writes_enabled, customs_send_enabled or preview_verified) or tenant_not_configured (no license key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"get":{"operationId":"listShipments","tags":["Shipments"],"summary":"List shipments of the key's environment","description":"Filterable by processing state, manifest state, open actions, update time and a substring of the ref / CS / SO code. Offset paging; `updatedSince` is the poll-based change feed (webhooks are planned, not available).\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"state","in":"query","schema":{"$ref":"#/components/schemas/PROCESSING_STATE"}},{"name":"manifestState","in":"query","schema":{"$ref":"#/components/schemas/MANIFEST_STATE"}},{"name":"actionRequired","in":"query","schema":{"type":"boolean"}},{"name":"updatedSince","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"q","in":"query","schema":{"type":"string","maxLength":80}},{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":200,"default":50}},{"name":"offset","in":"query","schema":{"type":"integer","minimum":0,"default":0}}],"responses":{"200":{"description":"Page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Rate limit (60 requests/min per API key) or manual re-poll pacing; Retry-After is set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/by-ref/{ref}":{"get":{"operationId":"getShipmentByRef","tags":["Shipments"],"summary":"Representation by your shipmentRef","description":"`processing.state = waiting` is NOT success and not an error: the shipment is applied and waits for Freightools' customs lookup (manifest number, IL1, IL2). `manifest.state = accepted` is the only success state and comes only from a correlated MN_MSG4. `knownDeviations[]` lists what customs does not receive today with the Freightools change request that would fix it.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string","pattern":"^[A-Za-z0-9._/-]{1,60}$"}}],"responses":{"200":{"description":"The shipment","headers":{"ETag":{"schema":{"type":"string"},"description":"The shipment version, for If-Match"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}":{"get":{"operationId":"getShipment","tags":["Shipments"],"summary":"Representation by id","description":"`processing.state = waiting` is NOT success and not an error: the shipment is applied and waits for Freightools' customs lookup (manifest number, IL1, IL2). `manifest.state = accepted` is the only success state and comes only from a correlated MN_MSG4. `knownDeviations[]` lists what customs does not receive today with the Freightools change request that would fix it. The same object is rendered by the portal.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"The shipment","headers":{"ETag":{"schema":{"type":"string"},"description":"The shipment version, for If-Match"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/revisions":{"get":{"operationId":"listRevisions","tags":["Shipments"],"summary":"Every revision of a shipment","description":"Ascending by rev: received at, by whom, data hash, kind (data | intent), state and the paths that changed against the previous revision.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Revisions","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/RevisionSummary"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/revisions/{rev}":{"get":{"operationId":"getRevision","tags":["Shipments"],"summary":"One revision with its bodies","description":"The body as received (inputJson), the normalised body (normalizedJson), the resolved Freightools ids, the state, a summary of what was written to Freightools (ids and codes, no bodies) and the diff from the previous revision.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"rev","in":"path","required":true,"schema":{"type":"string"},"description":"Revision number (e.g. 2) or revision id"}],"responses":{"200":{"description":"Revision","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RevisionSummary"},{"type":"object","properties":{"inputJson":{},"normalizedJson":{"$ref":"#/components/schemas/ShipmentBody"},"resolution":{},"ftImage":{},"diffFromPrevious":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"from":{},"to":{}}}},"isCurrent":{"type":"boolean"},"isLastApplied":{"type":"boolean"},"isLastTransmitted":{"type":"boolean"}}}]}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/diff":{"get":{"operationId":"diffRevisions","tags":["Shipments"],"summary":"Path-level diff between two revisions","description":"Defaults to `from=transmitted&to=current` (what customs holds vs what you last sent). `from`/`to` also accept `applied` and revision numbers. An empty `changes` with a null side means that side does not exist yet (nothing transmitted).\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"from","in":"query","schema":{"oneOf":[{"type":"string","enum":["transmitted","applied"]},{"type":"integer"}]}},{"name":"to","in":"query","schema":{"oneOf":[{"type":"string","enum":["current"]},{"type":"integer"}]}}],"responses":{"200":{"description":"Diff","content":{"application/json":{"schema":{"type":"object","properties":{"from":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"rev":{"type":"integer"},"dataHash":{"type":"string"}}},{"type":"null"}]},"to":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"rev":{"type":"integer"},"dataHash":{"type":"string"}}},{"type":"null"}]},"changes":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"from":{},"to":{}}}}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/manifest":{"post":{"operationId":"manualSend","tags":["Customs"],"summary":"Manually trigger the customs send (or a preview)","description":"Secondary to the automatic send (plan §4.4): same conditions minus submitManifest. 202 when a send-manifest job is queued (the job re-checks everything under the lock before its first Freightools call); 409 transmission_exists when a counted transmission exists (use decisions); 409 not_ready with the readiness reasons; 501 preview_not_verified while IsPreview is unverified; 503 gate_closed when a customs gate is closed — zero Freightools calls happen in that case.\n\nScope `manifest:send`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"If-Match","in":"header","required":false,"schema":{"type":"string"},"description":"The ETag / `version` of the representation you read, e.g. `\"7\"`; a stale value is 412"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManifestActionRequest"},"examples":{"send":{"value":{"action":"send"}},"preview":{"value":{"action":"preview"}}}}}},"responses":{"202":{"description":"Send queued (manifest.state scheduled)","headers":{"ETag":{"schema":{"type":"string"},"description":"The shipment version, for If-Match"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Conflict: transmission_exists, not_ready, decision_stale, action_closed, not_pollable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"412":{"description":"If-Match does not match the current version (precondition_failed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"preview_not_verified / not_implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"gate_closed (an environment go-live switch is off: writes_enabled, customs_send_enabled or preview_verified) or tenant_not_configured (no license key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/manifest/decisions":{"post":{"operationId":"recordDecision","tags":["Customs"],"summary":"Record the decision after a post-transmission change","description":"Plan §4.8. Actions: keep | correction | cancel_and_resend | cancel_only | refer_to_operator. The revision must be the current one and the transmission the latest non-cancel one, else 409 decision_stale (re-read and decide again). keep: nothing is sent, the customs_decision action closes, the updated_not_retransmitted banner stays. correction / cancel_and_resend / cancel_only: recorded now and transmitted by the send job while the environment's Writes enabled and Customs send enabled switches are on; while either is off nothing is sent, the decision stays open and the readiness check send_gates names the closed switch. refer_to_operator: opens an operator_review action. Requires If-Match.\n\nScope `manifest:send`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"If-Match","in":"header","required":false,"schema":{"type":"string"},"description":"The ETag / `version` of the representation you read, e.g. `\"7\"`; a stale value is 412"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DecisionRequest"},"examples":{"correction":{"value":{"action":"correction","revision":2,"transmission":"22222222-3333-4444-8555-666666666661","note":"weight corrected per revised B/L"}},"keep":{"value":{"action":"keep","revision":2}}}}}},"responses":{"201":{"description":"Decision recorded","headers":{"ETag":{"schema":{"type":"string"},"description":"The shipment version, for If-Match"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Conflict: transmission_exists, not_ready, decision_stale, action_closed, not_pollable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"412":{"description":"If-Match does not match the current version (precondition_failed)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/transmissions":{"get":{"operationId":"listTransmissions","tags":["Customs"],"summary":"Every customs transmission of a shipment","description":"Kind (initial | correction | cancel | resend | preview), state, revision, manifest number, IL1, log id, outcome and the links to the raw XML (scope logs:xml).\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Transmissions","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TransmissionView"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/transmissions/{tid}":{"get":{"operationId":"getTransmission","tags":["Customs"],"summary":"One transmission","description":"Detail row with request/response bodies (redacted upstream), poll state and whether a snapshot exists.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"tid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Transmission","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransmissionView"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/transmissions/{tid}/request.xml":{"get":{"operationId":"getRequestXml","tags":["Customs"],"summary":"Raw MN_MSG1 as Freightools built it","description":"text/xml. Every read is written to the tenant audit log.\n\nScope `logs:xml`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"tid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"XML","content":{"text/xml":{"schema":{"type":"string"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/transmissions/{tid}/feedback.xml":{"get":{"operationId":"getFeedbackXml","tags":["Customs"],"summary":"Raw MN_MSG4 feedback","description":"text/xml. Every read is written to the tenant audit log.\n\nScope `logs:xml`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"tid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"XML","content":{"text/xml":{"schema":{"type":"string"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/transmissions/{tid}/re-poll":{"post":{"operationId":"rePollFeedback","tags":["Customs"],"summary":"Ask for an immediate feedback poll","description":"Queues one poll-feedback job now. Paced: at most one manual poll per transmission every 30 s (429 with Retry-After otherwise).\n\nScope `manifest:send`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"tid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"202":{"description":"Queued","content":{"application/json":{"schema":{"type":"object","properties":{"queued":{"type":"boolean"},"transmissionId":{"type":"string"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Conflict: transmission_exists, not_ready, decision_stale, action_closed, not_pollable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"429":{"description":"Rate limit (60 requests/min per API key) or manual re-poll pacing; Retry-After is set","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/tracking":{"get":{"operationId":"getShipmentTracking","tags":["Shipments"],"summary":"Route, milestones and position of a shipment","description":"The journey the portal map draws: status live (a Freightools vessel position) | estimated (interpolated along the route from the schedule) | no_data, the route split into travelled / remaining [lat, lng] points, the milestones (Freightools schedules, else your routing LOCODEs), vessel or flight, dates, phase and the last fetch. Freightools positions depend on the company's vessel-position service; until it is on, the position is estimated. Never cached (Cache-Control: no-store).\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Tracking view","content":{"application/json":{"schema":{"type":"object","properties":{"shipment":{"type":"object","properties":{"id":{"type":"string"},"ref":{"type":"string"},"mode":{"type":"string","enum":["ocean","air"]}}},"status":{"type":"string","enum":["live","estimated","no_data"]},"position":{"oneOf":[{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"at":{"oneOf":[{"type":"string"},{"type":"null"}]},"bearing":{"oneOf":[{"type":"number"},{"type":"null"}]}}},{"type":"null"}]},"estimatedPosition":{"oneOf":[{"type":"object","properties":{"lat":{"type":"number"},"lng":{"type":"number"},"bearing":{"oneOf":[{"type":"number"},{"type":"null"}]}}},{"type":"null"}]},"route":{"type":"object","properties":{"travelled":{"type":"array","items":{"type":"array","items":{"type":"number"}}},"remaining":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"milestones":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string"},"kind":{"type":"string","enum":["pickup","cutoff","load","departure","transshipment","arrival","delivery","gate_out","other"]},"name":{"type":"string"},"locode":{"oneOf":[{"type":"string"},{"type":"null"}]},"lat":{"oneOf":[{"type":"number"},{"type":"null"}]},"lng":{"oneOf":[{"type":"number"},{"type":"null"}]},"estimated":{"oneOf":[{"type":"string"},{"type":"null"}]},"actual":{"oneOf":[{"type":"string"},{"type":"null"}]},"terminal":{"type":"boolean"},"source":{"type":"string","enum":["schedules","so_dates","revision"]}}}},"vessel":{"oneOf":[{"type":"object","properties":{"name":{"oneOf":[{"type":"string"},{"type":"null"}]},"imo":{"oneOf":[{"type":"string"},{"type":"null"}]},"mmsi":{"oneOf":[{"type":"string"},{"type":"null"}]},"callSign":{"oneOf":[{"type":"string"},{"type":"null"}]}}},{"type":"null"}]},"voyage":{"oneOf":[{"type":"string"},{"type":"null"}]},"flight":{"oneOf":[{"type":"object","properties":{"number":{"type":"string"},"date":{"type":"string"}}},{"type":"null"}]},"dates":{"type":"object","properties":{"etd":{"oneOf":[{"type":"string"},{"type":"null"}]},"atd":{"oneOf":[{"type":"string"},{"type":"null"}]},"eta":{"oneOf":[{"type":"string"},{"type":"null"}]},"ata":{"oneOf":[{"type":"string"},{"type":"null"}]},"deliveryEta":{"oneOf":[{"type":"string"},{"type":"null"}]},"deliveryActual":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"phase":{"type":"string","enum":["unknown","pre_departure","in_transit","arrived","delivered"]},"fetchedAt":{"oneOf":[{"type":"string"},{"type":"null"}]},"nextFetchAt":{"oneOf":[{"type":"string"},{"type":"null"}]},"documents":{"type":"object","properties":{"count":{"type":"integer"},"types":{"type":"array","items":{"type":"string"}}}}},"required":["shipment","status","route","milestones","phase"]}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/feedback":{"get":{"operationId":"listFeedback","tags":["Customs"],"summary":"Normalised customs feedback rows","description":"Every MN_MSG4 row correlated to this shipment (one per Freightools log id): status code, parsed outcome with errors mapped to your JSON paths, whether it matched a transmission of ours.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Feedback rows","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"transmissionId":{"oneOf":[{"type":"string"},{"type":"null"}]},"ftLogId":{"type":"string"},"ftCsId":{"oneOf":[{"type":"string"},{"type":"null"}]},"statusCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"matched":{"type":"boolean"},"parsed":{"oneOf":[{"$ref":"#/components/schemas/NormalisedFeedback"},{"type":"null"}]},"receivedAt":{"type":"string"}}}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/actions":{"get":{"operationId":"listActions","tags":["Actions"],"summary":"Open and closed actions of a shipment","description":"customs_decision (decide via …/manifest/decisions), documents_required (customs 2570), fix_input (feedback errors mapped to paths), operator_review.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Actions","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ActionView"}},"total":{"type":"integer"},"open":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/actions/{aid}/close":{"post":{"operationId":"closeAction","tags":["Actions"],"summary":"Close an action with a note","description":"outcome confirmed_not_sent is allowed only on an operator_review action bound to a transmission in unknown_outcome, for admins / keys with manifest:send; it marks the transmission confirmed_not_sent and re-arms the automatic send (plan §4.10).\n\nScope `shipments:write`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"aid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloseActionRequest"}}}},"responses":{"200":{"description":"Action closed","headers":{"ETag":{"schema":{"type":"string"},"description":"The shipment version, for If-Match"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentView"},"examples":{"waiting":{"summary":"waiting","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"waiting","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"partial_failure":{"summary":"partial_failure","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":3,"etag":"\"3\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"partially_applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":null,"changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":null,"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"partial_failure","readiness":{"checks":[],"masterChecks":"not_available"}},"manifest":{"state":"not_requested","lastOutcome":null,"autoSend":"armed","submitManifest":true},"customs":{"manifestNumber":null,"houseTransactionNumber":null,"masterTransactionNumber":null,"consignmentSequence":null,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":null,"code":null},"manifestExecutionStepId":null},"diff":null,"actionsRequired":[],"transmissions":[],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:05:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"unknown_outcome":{"summary":"unknown_outcome","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":null,"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"unknown_outcome","lastOutcome":null,"autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"operator_review","state":"open","revision":1,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{"reason":"send_unknown_outcome","hint":"confirm in Freightools whether the MSG1 left; close with confirmed_not_sent only with evidence"},"options":["close_with_note"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"unknown_outcome","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":null,"applicationId":null,"sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":null,"outcome":null,"confirmationId":null,"error":{"name":"FreighToolsTimeoutError","message":"SendIntegrationRequest did not answer within 90 s; no GetIntegrationLogs row found after 30 min"}}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:40:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"updated_not_retransmitted":{"summary":"updated_not_retransmitted","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":7,"etag":"\"7\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555552","rev":2,"kind":"data","state":"applied","dataHash":"a7b6c5d4e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6","submitManifest":true,"receivedAt":"2026-10-25T09:00:00.000Z","appliedAt":"2026-10-25T09:04:00.000Z","changedPaths":["/cargo/containers/0/grossKg"],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":false,"count":2},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"updated_not_retransmitted","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":[{"path":"/cargo/containers/0/grossKg","from":11500,"to":11800}],"actionsRequired":[{"id":"33333333-4444-4555-8666-777777777771","type":"customs_decision","state":"open","revision":2,"transmissionId":"22222222-3333-4444-8555-666666666661","details":{},"options":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"createdAt":"2026-10-25T09:04:00.000Z","closedAt":null}],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T09:04:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}},"accepted_with_exceptions":{"summary":"accepted_with_exceptions","value":{"id":"0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","shipmentRef":"EXAMPLE-FCL-001","version":5,"etag":"\"5\"","service":{"mode":"ocean","load":"FCL","lclArrangement":null,"variant":"F"},"revisions":{"current":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastApplied":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"lastTransmitted":{"id":"11111111-2222-4333-8444-555555555551","rev":1,"kind":"data","state":"applied","dataHash":"3f1a0c6b9d2e8f7a5b4c3d2e1f0a9b8c7d6e5f4a3b2c1d0e9f8a7b6c5d4e3f2a","submitManifest":true,"receivedAt":"2026-10-25T07:00:00.000Z","appliedAt":"2026-10-25T07:04:00.000Z","changedPaths":[],"submittedBy":{"type":"api_key","id":"9d8c7b6a-5f4e-4d3c-8b2a-1f0e9d8c7b6a"}},"inSync":true,"count":1},"processing":{"state":"ready","readiness":{"checks":[{"id":"manifest_number","status":"waiting","detail":"SO.ManifestNumber not filled by the Freightools customs lookup yet","nextCheckAt":"2026-10-25T13:00:00.000Z"},{"id":"master_transaction","status":"waiting","detail":"SO.CarrierTransactionNumber (IL2) not filled yet"},{"id":"house_transaction","status":"waiting","detail":"CS.TransactionNumber (IL1) not filled yet"},{"id":"delivery_order","status":"waiting","detail":"SO.DeliveryOrderReceived is false (policy warn)"},{"id":"il1_unique_on_manifest","status":"ok","detail":"no live transmission uses this (manifest, IL1) pair"},{"id":"execution_step","status":"ok","detail":"execution step 800001 covers the container goods"},{"id":"iso_type_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"master_serials","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"unloading_site_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"dg_flag_vs_master","status":"unknown","detail":"no public path to the carrier master (CR-18)"},{"id":"send_gates","status":"ok","detail":"customs send gates open"}],"masterChecks":"not_available","evaluatedAt":"2026-10-25T07:05:00.000Z"}},"manifest":{"state":"accepted_with_exceptions","lastOutcome":"accepted","autoSend":"disarmed","submitManifest":true},"customs":{"manifestNumber":"123456","houseTransactionNumber":"I000111A01","masterTransactionNumber":"I000111A00","consignmentSequence":6501,"deliveryOrderReceivedAt":null},"freightools":{"environment":"test","customerShipment":{"id":"400001","code":"CS 030001"},"shippingOrder":{"id":"250001","code":"SO 030001-2026 - O-I - FCL/FCL"},"manifestExecutionStepId":"800001"},"diff":null,"actionsRequired":[],"transmissions":[{"id":"22222222-3333-4444-8555-666666666661","kind":"initial","state":"feedback_received","revision":1,"manifestNumber":"123456","il1":"I000111A01","consignmentSequence":6501,"ftLogId":"9912001","applicationId":"APP-77120","sentAt":"2026-10-25T07:07:00.000Z","feedbackAt":"2026-10-25T07:08:00.000Z","outcome":{"statusCode":"1","statusNameHe":"נקלט","outcome":"accepted","manifestState":"accepted_with_exceptions","functionCode":"90","manifestNumber":"123456","il1":"I000111A01","applicationId":"APP-77120","errors":[{"code":"4852","messageHe":"סוג מכולה אינו תואם למצהר הקו","messageEn":"Container type differs from the carrier master","severity":"warning","path":"/cargo/containers/0/isoType","hint":"Set isoType to the type on the carrier master (the master cannot be pre-checked, CR-18)","itemSerial":"1"}],"requiredDocuments":[]},"confirmationId":null,"error":null}],"decisions":[],"documents":{"count":0,"items":[],"levelsNotice":"Uploading a document stores it here only. Customs transmission of documents is not available yet."},"deliveryOrder":null,"knownDeviations":[{"path":"/house/document/number","code":"HBL_NOT_EMITTED","message":"The house B/L number is never emitted in the manifest (Freightools change request CR-1)","variant":"F","hint":"CR-1"},{"path":"/dgContact","code":"DG_CONTACT_NOT_EMITTED","message":"The DG contact (UNDGContact 37B, customs check 602) has no Freightools field and is not transmitted (Freightools change request CR-1b)","variant":"F","hint":"CR-1b"},{"path":"/cargo/containers/0/packages","code":"TOTAL_PACKAGES_IS_CONTAINER_COUNT","message":"For FCL Freightools sends the container count as total packages (146), not the package count (Freightools change request CR-2)","variant":"F","hint":"CR-2"}],"warnings":[{"path":"/routing/pod","code":"pod_defaulted_from_site","message":"/routing/pod defaulted to \"ILASH\" from /master/dischargeSite","value":"ILASH"},{"path":"/master/goodsReceiptSite","code":"goods_receipt_site_defaulted","message":"/master/goodsReceiptSite defaulted to \"ILAST\" from /master/dischargeSite","value":"ILAST"}],"timestamps":{"createdAt":"2026-10-25T07:00:00.000Z","updatedAt":"2026-10-25T07:08:00.000Z"},"links":{"self":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b","revisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/revisions","transmissions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/transmissions","decisions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/manifest/decisions","actions":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/actions","documents":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/documents","feedback":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/feedback","audit":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/audit","diff":"/v1/shipments/0f6c1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/diff?from=transmitted&to=current"}}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Conflict: transmission_exists, not_ready, decision_stale, action_closed, not_pollable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/documents":{"post":{"operationId":"uploadDocument","tags":["Documents"],"summary":"Upload a document (stored only; not sent to Freightools or customs)","description":"multipart/form-data with the fields `documentType` (IL_287 | 707 | 98 | 380 | 271 | MBL | HBL | BOOKING | ARRIVAL_NOTICE | AWB | HAWB | OTHER) and optional `note` BEFORE one `file` part. PDF, JPEG, PNG, XLSX sniffed from the bytes (a renamed executable is 415); max 20 MiB (tenant-configurable) → 413; virus-scanned; sha256 dedupe per shipment + type answers 200 with the existing document. Uploading a document stores it here only. Customs transmission of documents is not available yet.\n\nScope `documents:write`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"documentType":{"type":"string","enum":["IL_287","707","98","380","271","MBL","HBL","BOOKING","ARRIVAL_NOTICE","AWB","HAWB","OTHER"]},"note":{"type":"string"},"file":{"type":"string","format":"binary"}},"required":["documentType","file"]}}}},"responses":{"200":{"description":"Deduplicated against an existing clean document"},"201":{"description":"Stored","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/DocumentView"},{"type":"object","properties":{"deduplicated":{"type":"boolean"},"levelsNotice":{"type":"string"}}}]}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"413":{"description":"Body over 1 MiB or file over the tenant limit (payload_too_large)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"415":{"description":"File type not accepted: sniffed bytes, declared type and extension must agree (unsupported_media_type)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"get":{"operationId":"listDocuments","tags":["Documents"],"summary":"Documents of a shipment","description":"Uploading a document stores it here only. Customs transmission of documents is not available yet.\n\nScope `documents:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Documents","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/DocumentView"}},"count":{"type":"integer"},"levelsNotice":{"type":"string"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/documents/{did}":{"get":{"operationId":"getDocument","tags":["Documents"],"summary":"Document metadata","description":"Never the bytes: use …/download.\n\nScope `documents:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"did","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Document","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentView"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"delete":{"operationId":"deleteDocument","tags":["Documents"],"summary":"Soft-delete a document","description":"Needs a reason; portal users need the admin role. The row stays for the audit trail; the object is removed by the retention sweep after the grace period.\n\nScope `documents:write`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"did","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteDocumentRequest"}}}},"responses":{"204":{"description":"Deleted"},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/documents/{did}/download":{"get":{"operationId":"downloadDocument","tags":["Documents"],"summary":"Short-lived download link","description":"302 to a 5-minute URL with forced attachment disposition (presigned S3 URL or the signed local /files/<token>). Only clean, not deleted documents are downloadable (409 otherwise). Audited.\n\nScope `documents:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"did","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"302":{"description":"Redirect to the file","headers":{"Location":{"schema":{"type":"string"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"409":{"description":"Conflict: transmission_exists, not_ready, decision_stale, action_closed, not_pollable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/documents/{did}/push-to-freightools":{"post":{"operationId":"pushDocumentToFreightools","tags":["Documents"],"summary":"Copy a document to Freightools (SetFile) — not available yet","description":"Always 501 not_implemented: SetFile's target entity and response are FT-DEPENDENT (example set E6).\n\nScope `documents:write`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"did","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"501":{"description":"preview_not_verified / not_implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/shipments/{id}/audit":{"get":{"operationId":"getShipmentAudit","tags":["Shipments"],"summary":"Who did what on this shipment","description":"shipment_events (state changes, submissions, decisions) and the tenant audit_log rows bound to the shipment (XML reads, downloads, decisions, key events), newest first, 500 each.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"Trail","content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"object"}},"audit":{"type":"array","items":{"type":"object"}}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"404":{"description":"Unknown id, or the shipment belongs to another environment (not_found)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/countries":{"get":{"operationId":"referenceCountries","tags":["Reference"],"summary":"ISO-2 countries Freightools knows","description":"Read once per environment from Freightools (GetCountries) and cached for 24 hours.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Countries","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"iso":{"type":"string"},"name":{"type":"string"},"freightoolsId":{"type":"string"}}}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"gate_closed (an environment go-live switch is off: writes_enabled, customs_send_enabled or preview_verified) or tenant_not_configured (no license key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/ports":{"get":{"operationId":"referencePorts","tags":["Reference"],"summary":"Sea port by UN/LOCODE","description":"Resolved against YOUR environment (Freightools GetPhysicalAddress with addressTypeId 2, cached). `q` must be a LOCODE; free-text search is not available because Freightools resolves places by LOCODE only.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{2}[A-Za-z2-9]{3}$"}}],"responses":{"200":{"description":"Zero or one port","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"locode":{"type":"string"},"name":{"type":"string"},"country":{"type":"string"},"freightoolsId":{"type":"string"},"addressTypeId":{"type":"integer"}}}},"total":{"type":"integer"},"q":{"type":"string"}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"gate_closed (an environment go-live switch is off: writes_enabled, customs_send_enabled or preview_verified) or tenant_not_configured (no license key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/airports":{"get":{"operationId":"referenceAirports","tags":["Reference"],"summary":"Airport by UN/LOCODE","description":"As /reference/ports with addressTypeId 3: airports and sea ports are different Freightools records even when the LOCODE is the same.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","pattern":"^[A-Za-z]{2}[A-Za-z2-9]{3}$"}}],"responses":{"200":{"description":"Zero or one airport","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"},"q":{"type":"string"}}}}}},"400":{"description":"Validation failed at L0/L1 (validation_error), malformed query or body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"503":{"description":"gate_closed (an environment go-live switch is off: writes_enabled, customs_send_enabled or preview_verified) or tenant_not_configured (no license key)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/container-types":{"get":{"operationId":"referenceContainerTypes","tags":["Reference"],"summary":"Curated ISO 6346 size/type codes","description":"With the Freightools freight unit each maps to and the SOC / inactive-reefer overrides.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Codes","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"},"note":{"type":"string"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/package-types":{"get":{"operationId":"referencePackageTypes","tags":["Reference"],"summary":"UNECE Rec 21 package codes","description":"With the LCL restriction (CT BX CS PK PP VN until CR-3), the air allow-list and the VIN requirement (VN).\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Codes","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/incoterms":{"get":{"operationId":"referenceIncoterms","tags":["Reference"],"summary":"Incoterms and the ids your tenant has","description":"Defaults overlaid with the tenant's incotermIds setting; `available: false` means your tenant has no id for the code, which is then 422 incoterm_unresolved.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Codes","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/il-sites":{"get":{"operationId":"referenceIlSites","tags":["Reference"],"summary":"Israeli customs sites (sea and air)","description":"With the kind (port | terminal | airTerminal), the default commercial port and whether your tenant allow-list admits the site.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Sites","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/document-types":{"get":{"operationId":"referenceDocumentTypes","tags":["Reference"],"summary":"Document types accepted by the upload","description":"IL_287, 707, 98 (VERIFIED from customs request 2570), 380, 271 (INFERRED), OTHER.\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Types","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/reference/states":{"get":{"operationId":"referenceStates","tags":["Reference"],"summary":"Every state vocabulary","description":"The exact lists the API and the portal use (src/domain/states.ts); treat unknown values as \"unknown, show the message\".\n\nScope `shipments:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Vocabularies","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/org/environments":{"get":{"operationId":"orgEnvironments","tags":["Org"],"summary":"The key's environment","description":"Host, gates, policies, connection status and settings — never key material (only the last 4 characters of the license key).\n\nScope `org:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Environment","content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object"}},"total":{"type":"integer"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/v1/org/me":{"get":{"operationId":"orgMe","tags":["Org"],"summary":"The calling key","description":"Key label and scopes, tenant, environment.\n\nScope `org:read`.","security":[{"bearer":[]}],"responses":{"200":{"description":"Caller","content":{"application/json":{"schema":{"type":"object","properties":{"key":{"type":"object"},"tenant":{"type":"object"},"environment":{"type":"object"}}}}}},"401":{"description":"No or invalid API key (unauthorized)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"403":{"description":"The key lacks the required scope, or the IP is not allowed (forbidden)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}},"/openapi.json":{"get":{"operationId":"openapi","tags":["Meta"],"summary":"This document","description":"Public.","security":[],"responses":{"200":{"description":"OpenAPI 3.1","content":{"application/json":{"schema":{"type":"object"}}}}}}},"/healthz":{"get":{"operationId":"healthz","tags":["Meta"],"summary":"Liveness and readiness","description":"ok + db (SELECT 1), worker (true | false | unknown), version, uptimeSeconds. 503 when the database does not answer. Public.","security":[],"responses":{"200":{"description":"Healthy","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"db":{"type":"boolean"},"worker":{},"version":{"type":"string"},"uptimeSeconds":{"type":"integer"}}}}}},"503":{"description":"Database unreachable"}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"em_test_<keyId>.<secret> | em_live_<keyId>.<secret>","description":"API key minted in the portal (Settings → API keys). Test keys reach only the test environment."}},"schemas":{"SUBMISSION_OUTCOME":{"type":"string","enum":["invalid","identical","revision"],"description":"src/domain/states.ts SUBMISSION_OUTCOME"},"REVISION_KIND":{"type":"string","enum":["data","intent"],"description":"src/domain/states.ts REVISION_KIND"},"REVISION_STATE":{"type":"string","enum":["pending_apply","applying","applied","partially_applied","apply_failed","apply_unknown","superseded"],"description":"src/domain/states.ts REVISION_STATE"},"PROCESSING_STATE":{"type":"string","enum":["received","invalid","applying","partial_failure","unknown_outcome","apply_failed","blocked","waiting","ready","synced"],"description":"src/domain/states.ts PROCESSING_STATE"},"READINESS_CHECK_STATUS":{"type":"string","enum":["ok","waiting","unknown","blocked"],"description":"src/domain/states.ts READINESS_CHECK_STATUS"},"READINESS_CHECK_ID":{"type":"string","enum":["manifest_number","master_transaction","house_transaction","delivery_order","il1_unique_on_manifest","execution_step","iso_type_vs_master","master_serials","unloading_site_vs_master","dg_flag_vs_master","air_manifest_path","air_mawb_under_manifest","send_gates","manifest_data","trade_scope"],"description":"src/domain/states.ts READINESS_CHECK_ID"},"MANIFEST_STATE":{"type":"string","enum":["not_requested","scheduled","sending","awaiting_feedback","unknown_outcome","accepted","accepted_with_exceptions","received_with_errors","rejected","correction_pending_approval","documents_required","correction_rejected","updated_not_retransmitted","decision_in_progress","cancel_requested","cancelled","resend_waiting_il1","feedback_timeout","send_failed"],"description":"src/domain/states.ts MANIFEST_STATE"},"MANIFEST_LAST_OUTCOME":{"type":"string","enum":["accepted","received_with_errors","split_merged","correction_pending_approval","cancelled","correction_approved","closed","held","rejected","correction_approved_manually","documents_required","correction_rejected","correction_withdrawn","other"],"description":"src/domain/states.ts MANIFEST_LAST_OUTCOME"},"MANIFEST_AUTO_SEND":{"type":"string","enum":["not_requested","armed","disarmed"],"description":"src/domain/states.ts MANIFEST_AUTO_SEND"},"TRANSMISSION_KIND":{"type":"string","enum":["initial","correction","cancel","resend","preview","attachment"],"description":"src/domain/states.ts TRANSMISSION_KIND"},"TRANSMISSION_STATE":{"type":"string","enum":["queued","sending","sent","awaiting_feedback","feedback_received","unknown_outcome","failed","confirmed_not_sent","feedback_timeout","invalidated_before_call"],"description":"src/domain/states.ts TRANSMISSION_STATE"},"DECISION_ACTION":{"type":"string","enum":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"description":"src/domain/states.ts DECISION_ACTION"},"DECISION_STATE":{"type":"string","enum":["open","executing","done","failed","stale"],"description":"src/domain/states.ts DECISION_STATE"},"ACTION_TYPE":{"type":"string","enum":["customs_decision","documents_required","fix_input","operator_review"],"description":"src/domain/states.ts ACTION_TYPE"},"DOCUMENT_STATE":{"type":"string","enum":["uploading","scanning","clean","infected","scan_failed","deleted"],"description":"src/domain/states.ts DOCUMENT_STATE"},"DOCUMENT_FT_FILE_STATE":{"type":"string","enum":["not_pushed","pushing","pushed","push_failed","unknown"],"description":"src/domain/states.ts DOCUMENT_FT_FILE_STATE"},"DOCUMENT_CUSTOMS_STATE":{"type":"string","enum":["not_available","not_sent","sent","acknowledged","failed"],"description":"src/domain/states.ts DOCUMENT_CUSTOMS_STATE"},"Finding":{"type":"object","properties":{"path":{"type":"string","description":"JSON Pointer into the submitted body (\"\" = whole body)"},"code":{"type":"string"},"message":{"type":"string"},"value":{},"variant":{"type":"string","enum":["F","L","C","K","A"]},"hint":{"type":"string"}},"required":["path","code","message"]},"ReadinessCheck":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/READINESS_CHECK_ID"},"status":{"$ref":"#/components/schemas/READINESS_CHECK_STATUS"},"detail":{"type":"string"},"since":{"type":"string"},"nextCheckAt":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","status","detail"]},"RevisionSummary":{"type":"object","properties":{"id":{"type":"string"},"rev":{"type":"integer"},"kind":{"$ref":"#/components/schemas/REVISION_KIND"},"state":{"$ref":"#/components/schemas/REVISION_STATE"},"dataHash":{"type":"string"},"submitManifest":{"type":"boolean"},"receivedAt":{"type":"string"},"appliedAt":{"oneOf":[{"type":"string"},{"type":"null"}]},"changedPaths":{"type":"array","items":{"type":"string"}},"submittedBy":{"type":"object","properties":{"type":{"oneOf":[{"type":"string"},{"type":"null"}]},"id":{"oneOf":[{"type":"string"},{"type":"null"}]}}}},"required":["id","rev","kind","state","dataHash","submitManifest","receivedAt","changedPaths"]},"FeedbackError":{"type":"object","properties":{"code":{"type":"string"},"messageHe":{"oneOf":[{"type":"string"},{"type":"null"}]},"messageEn":{"oneOf":[{"type":"string"},{"type":"null"}]},"severity":{"type":"string","enum":["error","warning","info"]},"path":{"oneOf":[{"type":"string","description":"JSON Pointer into your body, when the customs code maps to a field"},{"type":"null"}]},"hint":{"oneOf":[{"type":"string"},{"type":"null"}]},"itemSerial":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["code","severity"]},"NormalisedFeedback":{"type":"object","properties":{"statusCode":{"oneOf":[{"type":"string","description":"customs CargoStatus 1..13"},{"type":"null"}]},"statusNameHe":{"oneOf":[{"type":"string"},{"type":"null"}]},"outcome":{"$ref":"#/components/schemas/MANIFEST_LAST_OUTCOME"},"manifestState":{"$ref":"#/components/schemas/MANIFEST_STATE"},"functionCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"manifestNumber":{"oneOf":[{"type":"string"},{"type":"null"}]},"il1":{"oneOf":[{"type":"string"},{"type":"null"}]},"applicationId":{"oneOf":[{"type":"string"},{"type":"null"}]},"errors":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackError"}},"requiredDocuments":{"type":"array","items":{"type":"string"}}}},"TransmissionView":{"type":"object","properties":{"id":{"type":"string"},"kind":{"$ref":"#/components/schemas/TRANSMISSION_KIND"},"state":{"$ref":"#/components/schemas/TRANSMISSION_STATE"},"revision":{"oneOf":[{"type":"integer"},{"type":"null"}]},"manifestNumber":{"oneOf":[{"type":"string"},{"type":"null"}]},"il1":{"oneOf":[{"type":"string"},{"type":"null"}]},"consignmentSequence":{"oneOf":[{"type":"integer"},{"type":"null"}]},"ftLogId":{"oneOf":[{"type":"string"},{"type":"null"}]},"applicationId":{"oneOf":[{"type":"string"},{"type":"null"}]},"sentAt":{"oneOf":[{"type":"string"},{"type":"null"}]},"feedbackAt":{"oneOf":[{"type":"string"},{"type":"null"}]},"outcome":{"oneOf":[{"$ref":"#/components/schemas/NormalisedFeedback"},{"type":"null"}]},"confirmationId":{"oneOf":[{"type":"string","description":"the decision id that authorised a non-initial transmission"},{"type":"null"}]},"error":{}},"required":["id","kind","state"]},"DecisionView":{"type":"object","properties":{"id":{"type":"string"},"action":{"$ref":"#/components/schemas/DECISION_ACTION"},"state":{"$ref":"#/components/schemas/DECISION_STATE"},"revision":{"oneOf":[{"type":"integer"},{"type":"null"}]},"transmissionId":{"oneOf":[{"type":"string"},{"type":"null"}]},"note":{"oneOf":[{"type":"string"},{"type":"null"}]},"decidedBy":{"type":"object","properties":{"type":{"type":"string"},"id":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"createdAt":{"type":"string"},"executedAt":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","action","state"]},"ActionView":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ACTION_TYPE"},"state":{"type":"string","enum":["open","closed"]},"revision":{"oneOf":[{"type":"integer"},{"type":"null"}]},"transmissionId":{"oneOf":[{"type":"string"},{"type":"null"}]},"details":{"type":"object"},"options":{"type":"array","items":{"type":"string","description":"what you can do: decision actions, upload_documents, resubmit, close_with_note"}},"createdAt":{"type":"string"},"closedAt":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["id","type","state","options"]},"DocumentView":{"type":"object","properties":{"id":{"type":"string"},"documentType":{"type":"string","enum":["IL_287","707","98","380","271","MBL","HBL","BOOKING","ARRIVAL_NOTICE","AWB","HAWB","OTHER"]},"filename":{"type":"string"},"contentType":{"type":"string"},"sizeBytes":{"type":"integer"},"sha256":{"type":"string"},"state":{"$ref":"#/components/schemas/DOCUMENT_STATE"},"levels":{"type":"object","properties":{"stored":{"type":"string"},"freightoolsFile":{"type":"string"},"customs":{"type":"string"}},"required":["stored","freightoolsFile","customs"],"description":"The three independent document levels in their fixed wording (plan §6)"},"customsEligible":{"type":"boolean"},"version":{"type":"integer"},"uploadedAt":{"type":"string"},"revision":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"required":["id","documentType","filename","contentType","sizeBytes","sha256","state","levels","customsEligible","version","uploadedAt"]},"ShipmentView":{"type":"object","properties":{"id":{"type":"string"},"shipmentRef":{"type":"string"},"version":{"type":"integer","description":"ETag; send it back as If-Match on decisions and manual sends"},"etag":{"type":"string"},"service":{"type":"object","properties":{"mode":{"type":"string","enum":["ocean","air"]},"load":{"oneOf":[{"type":"string","enum":["FCL","LCL"]},{"type":"null"}]},"lclArrangement":{"oneOf":[{"type":"string"},{"type":"null"}]},"variant":{"type":"string","enum":["F","L","C","K","A"]}}},"revisions":{"type":"object","properties":{"current":{"oneOf":[{"$ref":"#/components/schemas/RevisionSummary"},{"type":"null"}]},"lastApplied":{"oneOf":[{"$ref":"#/components/schemas/RevisionSummary"},{"type":"null"}]},"lastTransmitted":{"oneOf":[{"$ref":"#/components/schemas/RevisionSummary"},{"type":"null"}]},"inSync":{"type":"boolean","description":"true when nothing was transmitted yet or the current data equals the transmitted data"},"count":{"type":"integer"}}},"processing":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/PROCESSING_STATE"},"readiness":{"type":"object","properties":{"checks":{"type":"array","items":{"$ref":"#/components/schemas/ReadinessCheck"}},"masterChecks":{"type":"string","enum":["not_available","ok","mismatch"]},"evaluatedAt":{"type":"string"}}}}},"manifest":{"type":"object","properties":{"state":{"$ref":"#/components/schemas/MANIFEST_STATE"},"lastOutcome":{"oneOf":[{"$ref":"#/components/schemas/MANIFEST_LAST_OUTCOME"},{"type":"null"}]},"autoSend":{"$ref":"#/components/schemas/MANIFEST_AUTO_SEND"},"submitManifest":{"type":"boolean"}}},"customs":{"type":"object","properties":{"manifestNumber":{"oneOf":[{"type":"string"},{"type":"null"}]},"houseTransactionNumber":{"oneOf":[{"type":"string","description":"IL1"},{"type":"null"}]},"masterTransactionNumber":{"oneOf":[{"type":"string","description":"IL2"},{"type":"null"}]},"consignmentSequence":{"oneOf":[{"type":"integer"},{"type":"null"}]},"deliveryOrderReceivedAt":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"freightools":{"type":"object","properties":{"environment":{"type":"string","enum":["test","production"]},"customerShipment":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"null"}]},"code":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"shippingOrder":{"type":"object","properties":{"id":{"oneOf":[{"type":"string"},{"type":"null"}]},"code":{"oneOf":[{"type":"string"},{"type":"null"}]}}},"manifestExecutionStepId":{"oneOf":[{"type":"string"},{"type":"null"}]}},"description":"Freightools identifiers are strings; never do arithmetic on them"},"diff":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"from":{},"to":{}},"required":["path"]}},{"type":"null"}]},"actionsRequired":{"type":"array","items":{"$ref":"#/components/schemas/ActionView"}},"transmissions":{"type":"array","items":{"$ref":"#/components/schemas/TransmissionView"}},"decisions":{"type":"array","items":{"$ref":"#/components/schemas/DecisionView"}},"documents":{"type":"object","properties":{"count":{"type":"integer"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DocumentView"}},"levelsNotice":{"type":"string","const":"Uploading a document stores it here only. Customs transmission of documents is not available yet."}}},"deliveryOrder":{"oneOf":[{"type":"object","properties":{"details":{"type":"object","additionalProperties":true,"description":"receiverName, receiverTypeCode, receiverExternalId, deliverySiteNumber, producerIdentityNumber, endorsementCode, producerTypeCode, note"},"completeness":{"type":"object","properties":{"checks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["ok","missing","invalid","waiting","blocked"]},"detail":{"type":"string"}}}},"ready":{"type":"boolean"}}},"updatedAt":{"type":"string"},"updatedBy":{"type":"object","properties":{"type":{"type":"string"},"id":{"oneOf":[{"type":"string"},{"type":"null"}]}}}},"description":"Delivery-order details collected in the portal (phase 3: nothing is sent to customs yet)"},{"type":"null"}]},"knownDeviations":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}},"timestamps":{"type":"object","properties":{"createdAt":{"type":"string"},"updatedAt":{"type":"string"}}},"links":{"type":"object","additionalProperties":{"type":"string"}}},"required":["id","shipmentRef","version","etag","service","revisions","processing","manifest","customs","freightools","diff","actionsRequired","transmissions","decisions","documents","knownDeviations","warnings","timestamps","links"]},"ShipmentListItem":{"type":"object","properties":{"id":{"type":"string"},"shipmentRef":{"type":"string"},"mode":{"type":"string","enum":["ocean","air"]},"load":{"oneOf":[{"type":"string","enum":["FCL","LCL"]},{"type":"null"}]},"variant":{"type":"string"},"dangerous":{"type":"boolean"},"customerShipmentCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"shippingOrderCode":{"oneOf":[{"type":"string"},{"type":"null"}]},"processingState":{"$ref":"#/components/schemas/PROCESSING_STATE"},"manifestState":{"$ref":"#/components/schemas/MANIFEST_STATE"},"lastOutcome":{"oneOf":[{"$ref":"#/components/schemas/MANIFEST_LAST_OUTCOME"},{"type":"null"}]},"autoSend":{"$ref":"#/components/schemas/MANIFEST_AUTO_SEND"},"revision":{"oneOf":[{"type":"string","description":"e.g. r3"},{"type":"null"}]},"transmittedRevision":{"oneOf":[{"type":"string"},{"type":"null"}]},"inSync":{"type":"boolean"},"actionsOpen":{"type":"integer"},"eta":{"oneOf":[{"type":"string"},{"type":"null"}]},"updatedAt":{"type":"string"}},"required":["id","shipmentRef","processingState","manifestState","autoSend","updatedAt"]},"ListResponse":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ShipmentListItem"}},"total":{"type":"integer"},"limit":{"type":"integer"},"offset":{"type":"integer"}},"required":["items","total","limit","offset"]},"ErrorEnvelope":{"type":"object","properties":{"type":{"type":"string","description":"validation_error | resolution_error | unsupported | consistency_error | policy_error | unauthorized | forbidden | not_found | payment_method_required | transmission_exists | not_ready | decision_stale | precondition_failed | shipment_ref_synced | payload_too_large | unsupported_media_type | rate_limited | preview_not_verified | not_implemented | gate_closed | tenant_not_configured | internal_error"},"status":{"type":"integer"},"requestId":{"type":"string","description":"quote it to support"},"shipmentRef":{"type":"string"},"message":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}}},"required":["type","status","requestId","errors"],"additionalProperties":true},"DryRunResponse":{"type":"object","properties":{"dryRun":{"type":"boolean","const":true},"valid":{"type":"boolean","const":true},"shipmentRef":{"oneOf":[{"type":"string"},{"type":"null"}]},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}},"knownDeviations":{"type":"array","items":{"$ref":"#/components/schemas/Finding"}}},"required":["dryRun","valid","warnings","knownDeviations"]},"FclShipment":{"type":"object","properties":{"shipmentRef":{"type":"string","pattern":"^[A-Za-z0-9._/-]{1,60}$"},"submitManifest":{"type":"boolean"},"service":{"type":"object","properties":{"mode":{"type":"string","const":"ocean"},"load":{"type":"string","const":"FCL"},"trade":{"type":"string","enum":["import","export","crossTrade"]},"scope":{"default":"port-port","type":"string","enum":["port-port","door-port","port-door","door-door"]}},"required":["mode","load"],"additionalProperties":false},"parties":{"default":{},"type":"object","properties":{"shipper":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"consignee":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"notify":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"customer":{"type":"object","properties":{"party":{"type":"string","enum":["shipper","consignee","other"]},"reference":{"type":"string","minLength":1,"maxLength":50},"details":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"customsBroker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"dgContact":{"type":"object","properties":{"company":{"type":"string","minLength":1,"maxLength":70},"person":{"type":"string","minLength":1,"maxLength":70},"phone":{"type":"string","minLength":1,"maxLength":50},"phoneType":{"default":"TE","type":"string","enum":["TE","AL","FX","EM"]}},"required":["company","person","phone"],"additionalProperties":false},"routing":{"type":"object","properties":{"pol":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"pod":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"placeOfReceipt":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"placeOfDelivery":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"acceptancePlace":{"type":"string","minLength":1,"maxLength":256},"transshipmentPorts":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"}}},"required":["pol"],"additionalProperties":false},"carriage":{"default":{},"type":"object","properties":{"carrier":{"description":"Optional. The shipping line (scac or name). It can come later, with the booking.","type":"object","properties":{"scac":{"type":"string","pattern":"^[A-Z]{4}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"vessel":{"description":"Optional. The IMO number (7 digits with the check digit) is the key; a name alone is matched against the vessel book (current and former names) and Freightools. A vessel that cannot be matched is a warning (vessel_imo_invalid, vessel_unknown, vessel_ambiguous, vessel_conflict — the IMO wins), never an error: the shipping order is created without the vessel and Freightools fills it from the carrier's manifest about 7 days before arrival.","type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"description":"Optional. The carrier's voyage number; Freightools fills it from the carrier's manifest when it is not given.","type":"string","minLength":1,"maxLength":20},"eta":{"description":"Estimated arrival (YYYY-MM-DD). Optional: it can come later.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"etd":{"description":"Estimated departure (YYYY-MM-DD). Required when booking is given (etd_required_with_booking).","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"booking":{"description":"The carrier booking number. When it is given, etd is required.","type":"string","minLength":1,"maxLength":35},"bookingDate":{"description":"The date of the carrier booking (YYYY-MM-DD). Left out, the shipping order takes the day its booking number is first written.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pickupDate":{"description":"The pickup date at origin (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoffDate":{"description":"The carrier's cut-off date (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"transshipments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"port":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"vessel":{"type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"type":"string","minLength":1,"maxLength":20},"eta":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["port"],"additionalProperties":false}}},"additionalProperties":false},"master":{"default":{},"type":"object","properties":{"issuer":{"default":"carrier","type":"string","enum":["carrier","coloader","self"]},"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"loadingPort":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"dischargeSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"goodsReceiptSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"},"manifestNumber":{"type":"string","pattern":"^\\d{6}$"}},"additionalProperties":false},"house":{"default":{},"type":"object","properties":{"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"placeOfIssue":{"type":"string","minLength":1,"maxLength":256},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"}},"additionalProperties":false},"commercial":{"default":{},"type":"object","properties":{"incoterm":{"type":"string","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAT","DAP","DPU","DDP"]},"freightTerms":{"type":"string","enum":["collect","prepaid"]}},"additionalProperties":false},"cargo":{"type":"object","properties":{"containers":{"minItems":1,"maxItems":60,"type":"array","items":{"type":"object","properties":{"number":{"type":"string","pattern":"^[A-Z]{4}\\d{7}$"},"isoType":{"type":"string","pattern":"^[0-9A-Z]{4}$"},"seal":{"type":"string","minLength":1,"maxLength":35},"grossKg":{"type":"number","exclusiveMinimum":0},"cbm":{"type":"number","exclusiveMinimum":0},"tareKg":{"type":"number","exclusiveMinimum":0},"soc":{"type":"boolean"},"reefer":{"type":"object","properties":{"active":{"type":"boolean"},"temperatureC":{"type":"number"}},"required":["active"],"additionalProperties":false},"packages":{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"type":{"type":"string","pattern":"^[A-Z0-9]{2}$"},"marks":{"type":"string","minLength":1,"maxLength":200}},"required":["count","type"],"additionalProperties":false},"goods":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"hs":{"type":"string","pattern":"^\\d{6,10}$"},"description":{"type":"string","minLength":1,"maxLength":240},"additionalHs":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{6,10}$"}},"dangerous":{"type":"object","properties":{"unNumber":{"type":"string","pattern":"^\\d{4}$"},"class":{"type":"string","pattern":"^[1-9](\\.[1-6])?$"},"packingGroup":{"type":"string","enum":["I","II","III"]},"properShippingName":{"type":"string","minLength":1,"maxLength":200}},"required":["unNumber","class"],"additionalProperties":false},"vehicles":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"}},"required":["vin"],"additionalProperties":false}},"value":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amount","currency"],"additionalProperties":false}},"required":["description"],"additionalProperties":false}}},"required":["isoType","goods"],"additionalProperties":false}},"totalCbm":{"type":"number","exclusiveMinimum":0}},"required":["containers"],"additionalProperties":false},"tracking":{"type":"object","properties":{"active":{"type":"boolean"},"alerts":{"type":"boolean"}},"required":["active"],"additionalProperties":false},"options":{"type":"object","properties":{"dryRun":{"type":"boolean"}},"additionalProperties":false}},"required":["shipmentRef","service","routing","cargo"],"additionalProperties":false,"title":"FclShipment","description":"Variant F — ocean FCL: `service.mode = \"ocean\"`, `service.load = \"FCL\"`. One or more full containers under your house B/L; every container carries its own goods lines (one Freightools good per container). Use for a shipment where you control the whole container(s). Start small: a shipment is created from shipmentRef, service, routing.pol and routing.pod, cargo.containers[] (isoType, goods[].description) and its customer — parties.consignee on an import or cross-trade, parties.shipper on an export, or parties.customer (a name and a country are enough; customer_required otherwise). Import, export or cross-trade (`service.trade`, worked out from the ends when left out). Everything else can come in a later revision of the same shipmentRef: the other party, addresses and tax ids, the carrier and the dates, weights, container numbers, seals, packages, HS codes, the B/L numbers and, on an import, master.dischargeSite — an import's customs manifest waits for them (readiness check manifest_data). commercial.incoterm left out is derived (Freightools' Instant Quote rule, warning incoterm_derived); `tracking` switches Freightools tracking for this shipment (default: the company's \"Track new shipments\"). The vessel (`carriage.vessel`, IMO preferred) and the voyage are optional in every ocean variant: a vessel that cannot be matched is a warning, never an error, and Freightools fills the vessel from the carrier's manifest about 7 days before arrival."},"LclLineMasterShipment":{"type":"object","properties":{"shipmentRef":{"type":"string","pattern":"^[A-Za-z0-9._/-]{1,60}$"},"submitManifest":{"type":"boolean"},"service":{"type":"object","properties":{"mode":{"type":"string","const":"ocean"},"load":{"type":"string","const":"LCL"},"trade":{"type":"string","enum":["import","export","crossTrade"]},"scope":{"default":"port-port","type":"string","enum":["port-port","door-port","port-door","door-door"]},"lcl":{"type":"object","properties":{"arrangement":{"type":"string","const":"lineMaster"},"consolidationRef":{"type":"string","minLength":1,"maxLength":60}},"required":["arrangement"],"additionalProperties":false}},"required":["mode","load","lcl"],"additionalProperties":false},"parties":{"default":{},"type":"object","properties":{"shipper":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"consignee":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"notify":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"customer":{"type":"object","properties":{"party":{"type":"string","enum":["shipper","consignee","other"]},"reference":{"type":"string","minLength":1,"maxLength":50},"details":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"customsBroker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"dgContact":{"type":"object","properties":{"company":{"type":"string","minLength":1,"maxLength":70},"person":{"type":"string","minLength":1,"maxLength":70},"phone":{"type":"string","minLength":1,"maxLength":50},"phoneType":{"default":"TE","type":"string","enum":["TE","AL","FX","EM"]}},"required":["company","person","phone"],"additionalProperties":false},"routing":{"type":"object","properties":{"pol":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"pod":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"placeOfReceipt":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"placeOfDelivery":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"acceptancePlace":{"type":"string","minLength":1,"maxLength":256},"transshipmentPorts":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"}}},"required":["pol"],"additionalProperties":false},"carriage":{"default":{},"type":"object","properties":{"carrier":{"description":"Optional. The shipping line (scac or name). It can come later, with the booking.","type":"object","properties":{"scac":{"type":"string","pattern":"^[A-Z]{4}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"vessel":{"description":"Optional. The IMO number (7 digits with the check digit) is the key; a name alone is matched against the vessel book (current and former names) and Freightools. A vessel that cannot be matched is a warning (vessel_imo_invalid, vessel_unknown, vessel_ambiguous, vessel_conflict — the IMO wins), never an error: the shipping order is created without the vessel and Freightools fills it from the carrier's manifest about 7 days before arrival.","type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"description":"Optional. The carrier's voyage number; Freightools fills it from the carrier's manifest when it is not given.","type":"string","minLength":1,"maxLength":20},"eta":{"description":"Estimated arrival (YYYY-MM-DD). Optional: it can come later.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"etd":{"description":"Estimated departure (YYYY-MM-DD). Required when booking is given (etd_required_with_booking).","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"booking":{"description":"The carrier booking number. When it is given, etd is required.","type":"string","minLength":1,"maxLength":35},"bookingDate":{"description":"The date of the carrier booking (YYYY-MM-DD). Left out, the shipping order takes the day its booking number is first written.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pickupDate":{"description":"The pickup date at origin (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoffDate":{"description":"The carrier's cut-off date (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"transshipments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"port":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"vessel":{"type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"type":"string","minLength":1,"maxLength":20},"eta":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["port"],"additionalProperties":false}}},"additionalProperties":false},"master":{"default":{},"type":"object","properties":{"issuer":{"default":"carrier","type":"string","enum":["carrier","coloader","self"]},"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"loadingPort":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"dischargeSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"goodsReceiptSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"},"manifestNumber":{"type":"string","pattern":"^\\d{6}$"}},"additionalProperties":false},"house":{"default":{},"type":"object","properties":{"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"placeOfIssue":{"type":"string","minLength":1,"maxLength":256},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"}},"additionalProperties":false},"commercial":{"default":{},"type":"object","properties":{"incoterm":{"type":"string","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAT","DAP","DPU","DDP"]},"freightTerms":{"type":"string","enum":["collect","prepaid"]}},"additionalProperties":false},"cargo":{"type":"object","properties":{"container":{"type":"object","properties":{"number":{"type":"string","pattern":"^[A-Z]{4}\\d{7}$"},"isoType":{"type":"string","pattern":"^[0-9A-Z]{4}$"},"seal":{"type":"string","minLength":1,"maxLength":35}},"required":["isoType"],"additionalProperties":false},"packages":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"type":{"type":"string","pattern":"^[A-Z0-9]{2}$"},"grossKg":{"type":"number","exclusiveMinimum":0},"cbm":{"type":"number","exclusiveMinimum":0},"marks":{"type":"string","minLength":1,"maxLength":200},"goods":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"hs":{"type":"string","pattern":"^\\d{6,10}$"},"description":{"type":"string","minLength":1,"maxLength":240},"additionalHs":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{6,10}$"}},"dangerous":{"type":"object","properties":{"unNumber":{"type":"string","pattern":"^\\d{4}$"},"class":{"type":"string","pattern":"^[1-9](\\.[1-6])?$"},"packingGroup":{"type":"string","enum":["I","II","III"]},"properShippingName":{"type":"string","minLength":1,"maxLength":200}},"required":["unNumber","class"],"additionalProperties":false},"vehicles":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"}},"required":["vin"],"additionalProperties":false}},"value":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amount","currency"],"additionalProperties":false}},"required":["description"],"additionalProperties":false}}},"required":["count","type","goods"],"additionalProperties":false}}},"required":["packages"],"additionalProperties":false},"tracking":{"type":"object","properties":{"active":{"type":"boolean"},"alerts":{"type":"boolean"}},"required":["active"],"additionalProperties":false},"options":{"type":"object","properties":{"dryRun":{"type":"boolean"}},"additionalProperties":false}},"required":["shipmentRef","service","routing","cargo"],"additionalProperties":false,"title":"LclLineMasterShipment","description":"Variant L — ocean LCL under a line master: `service.mode = \"ocean\"`, `service.load = \"LCL\"`, `service.lcl.arrangement = \"lineMaster\"`. Your house B/L sits directly under the shipping line's master B/L (master.issuer = carrier); packages are listed per container of the master. Use when the carrier issued the master to you. As variant F, with cargo.packages[] (count, type, goods[].description) instead of cargo.containers[]; the shared container (cargo.container) can come later."},"LclColoadShipment":{"type":"object","properties":{"shipmentRef":{"type":"string","pattern":"^[A-Za-z0-9._/-]{1,60}$"},"submitManifest":{"type":"boolean"},"service":{"type":"object","properties":{"mode":{"type":"string","const":"ocean"},"load":{"type":"string","const":"LCL"},"trade":{"type":"string","enum":["import","export","crossTrade"]},"scope":{"default":"port-port","type":"string","enum":["port-port","door-port","port-door","door-door"]},"lcl":{"type":"object","properties":{"arrangement":{"type":"string","const":"coload"},"consolidationRef":{"type":"string","minLength":1,"maxLength":60}},"required":["arrangement"],"additionalProperties":false}},"required":["mode","load","lcl"],"additionalProperties":false},"parties":{"type":"object","properties":{"shipper":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"consignee":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"notify":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"customer":{"type":"object","properties":{"party":{"type":"string","enum":["shipper","consignee","other"]},"reference":{"type":"string","minLength":1,"maxLength":50},"details":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"customsBroker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"coloader":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"required":["coloader"],"additionalProperties":false},"dgContact":{"type":"object","properties":{"company":{"type":"string","minLength":1,"maxLength":70},"person":{"type":"string","minLength":1,"maxLength":70},"phone":{"type":"string","minLength":1,"maxLength":50},"phoneType":{"default":"TE","type":"string","enum":["TE","AL","FX","EM"]}},"required":["company","person","phone"],"additionalProperties":false},"routing":{"type":"object","properties":{"pol":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"pod":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"placeOfReceipt":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"placeOfDelivery":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"acceptancePlace":{"type":"string","minLength":1,"maxLength":256},"transshipmentPorts":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"}}},"required":["pol"],"additionalProperties":false},"carriage":{"default":{},"type":"object","properties":{"carrier":{"description":"Optional. The shipping line (scac or name). It can come later, with the booking.","type":"object","properties":{"scac":{"type":"string","pattern":"^[A-Z]{4}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"vessel":{"description":"Optional. The IMO number (7 digits with the check digit) is the key; a name alone is matched against the vessel book (current and former names) and Freightools. A vessel that cannot be matched is a warning (vessel_imo_invalid, vessel_unknown, vessel_ambiguous, vessel_conflict — the IMO wins), never an error: the shipping order is created without the vessel and Freightools fills it from the carrier's manifest about 7 days before arrival.","type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"description":"Optional. The carrier's voyage number; Freightools fills it from the carrier's manifest when it is not given.","type":"string","minLength":1,"maxLength":20},"eta":{"description":"Estimated arrival (YYYY-MM-DD). Optional: it can come later.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"etd":{"description":"Estimated departure (YYYY-MM-DD). Required when booking is given (etd_required_with_booking).","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"booking":{"description":"The carrier booking number. When it is given, etd is required.","type":"string","minLength":1,"maxLength":35},"bookingDate":{"description":"The date of the carrier booking (YYYY-MM-DD). Left out, the shipping order takes the day its booking number is first written.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pickupDate":{"description":"The pickup date at origin (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoffDate":{"description":"The carrier's cut-off date (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"transshipments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"port":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"vessel":{"type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"type":"string","minLength":1,"maxLength":20},"eta":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["port"],"additionalProperties":false}}},"additionalProperties":false},"master":{"default":{},"type":"object","properties":{"issuer":{"default":"coloader","type":"string","enum":["carrier","coloader","self"]},"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"loadingPort":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"dischargeSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"goodsReceiptSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"},"manifestNumber":{"type":"string","pattern":"^\\d{6}$"}},"additionalProperties":false},"house":{"default":{},"type":"object","properties":{"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"placeOfIssue":{"type":"string","minLength":1,"maxLength":256},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"}},"additionalProperties":false},"commercial":{"default":{},"type":"object","properties":{"incoterm":{"type":"string","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAT","DAP","DPU","DDP"]},"freightTerms":{"type":"string","enum":["collect","prepaid"]}},"additionalProperties":false},"cargo":{"type":"object","properties":{"container":{"type":"object","properties":{"number":{"type":"string","pattern":"^[A-Z]{4}\\d{7}$"},"isoType":{"type":"string","pattern":"^[0-9A-Z]{4}$"},"seal":{"type":"string","minLength":1,"maxLength":35}},"required":["isoType"],"additionalProperties":false},"packages":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"type":{"type":"string","pattern":"^[A-Z0-9]{2}$"},"grossKg":{"type":"number","exclusiveMinimum":0},"cbm":{"type":"number","exclusiveMinimum":0},"marks":{"type":"string","minLength":1,"maxLength":200},"goods":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"hs":{"type":"string","pattern":"^\\d{6,10}$"},"description":{"type":"string","minLength":1,"maxLength":240},"additionalHs":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{6,10}$"}},"dangerous":{"type":"object","properties":{"unNumber":{"type":"string","pattern":"^\\d{4}$"},"class":{"type":"string","pattern":"^[1-9](\\.[1-6])?$"},"packingGroup":{"type":"string","enum":["I","II","III"]},"properShippingName":{"type":"string","minLength":1,"maxLength":200}},"required":["unNumber","class"],"additionalProperties":false},"vehicles":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"}},"required":["vin"],"additionalProperties":false}},"value":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amount","currency"],"additionalProperties":false}},"required":["description"],"additionalProperties":false}}},"required":["count","type","goods"],"additionalProperties":false}}},"required":["packages"],"additionalProperties":false},"tracking":{"type":"object","properties":{"active":{"type":"boolean"},"alerts":{"type":"boolean"}},"required":["active"],"additionalProperties":false},"options":{"type":"object","properties":{"dryRun":{"type":"boolean"}},"additionalProperties":false}},"required":["shipmentRef","service","parties","routing","cargo"],"additionalProperties":false,"title":"LclColoadShipment","description":"Variant C — ocean LCL co-load: `service.mode = \"ocean\"`, `service.load = \"LCL\"`, `service.lcl.arrangement = \"coload\"`. Your house sits under another forwarder's house (master.issuer = forwarder), which in turn sits under the line master; the master and the co-loader's document are both named. Use when you booked space with a consolidator (customs sample M5)."},"LclConsolidationShipment":{"type":"object","properties":{"shipmentRef":{"type":"string","pattern":"^[A-Za-z0-9._/-]{1,60}$"},"submitManifest":{"type":"boolean"},"service":{"type":"object","properties":{"mode":{"type":"string","const":"ocean"},"load":{"type":"string","const":"LCL"},"trade":{"type":"string","enum":["import","export","crossTrade"]},"scope":{"default":"port-port","type":"string","enum":["port-port","door-port","port-door","door-door"]},"lcl":{"type":"object","properties":{"arrangement":{"type":"string","const":"consolidation"},"consolidationRef":{"type":"string","minLength":1,"maxLength":60}},"required":["arrangement"],"additionalProperties":false}},"required":["mode","load","lcl"],"additionalProperties":false},"parties":{"default":{},"type":"object","properties":{"shipper":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"consignee":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"notify":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"customer":{"type":"object","properties":{"party":{"type":"string","enum":["shipper","consignee","other"]},"reference":{"type":"string","minLength":1,"maxLength":50},"details":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"customsBroker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"dgContact":{"type":"object","properties":{"company":{"type":"string","minLength":1,"maxLength":70},"person":{"type":"string","minLength":1,"maxLength":70},"phone":{"type":"string","minLength":1,"maxLength":50},"phoneType":{"default":"TE","type":"string","enum":["TE","AL","FX","EM"]}},"required":["company","person","phone"],"additionalProperties":false},"routing":{"type":"object","properties":{"pol":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"pod":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"placeOfReceipt":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"placeOfDelivery":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"acceptancePlace":{"type":"string","minLength":1,"maxLength":256},"transshipmentPorts":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"}}},"required":["pol"],"additionalProperties":false},"carriage":{"default":{},"type":"object","properties":{"carrier":{"description":"Optional. The shipping line (scac or name). It can come later, with the booking.","type":"object","properties":{"scac":{"type":"string","pattern":"^[A-Z]{4}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"vessel":{"description":"Optional. The IMO number (7 digits with the check digit) is the key; a name alone is matched against the vessel book (current and former names) and Freightools. A vessel that cannot be matched is a warning (vessel_imo_invalid, vessel_unknown, vessel_ambiguous, vessel_conflict — the IMO wins), never an error: the shipping order is created without the vessel and Freightools fills it from the carrier's manifest about 7 days before arrival.","type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"description":"Optional. The carrier's voyage number; Freightools fills it from the carrier's manifest when it is not given.","type":"string","minLength":1,"maxLength":20},"eta":{"description":"Estimated arrival (YYYY-MM-DD). Optional: it can come later.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"etd":{"description":"Estimated departure (YYYY-MM-DD). Required when booking is given (etd_required_with_booking).","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"booking":{"description":"The carrier booking number. When it is given, etd is required.","type":"string","minLength":1,"maxLength":35},"bookingDate":{"description":"The date of the carrier booking (YYYY-MM-DD). Left out, the shipping order takes the day its booking number is first written.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pickupDate":{"description":"The pickup date at origin (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoffDate":{"description":"The carrier's cut-off date (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"transshipments":{"maxItems":5,"type":"array","items":{"type":"object","properties":{"port":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"vessel":{"type":"object","properties":{"imo":{"type":"string","pattern":"^\\d{7}$"},"name":{"type":"string","minLength":1,"maxLength":100}},"additionalProperties":false},"voyage":{"type":"string","minLength":1,"maxLength":20},"eta":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["port"],"additionalProperties":false}}},"additionalProperties":false},"master":{"default":{},"type":"object","properties":{"issuer":{"default":"self","type":"string","enum":["carrier","coloader","self"]},"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"loadingPort":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"dischargeSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"goodsReceiptSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"},"manifestNumber":{"type":"string","pattern":"^\\d{6}$"}},"additionalProperties":false},"house":{"default":{},"type":"object","properties":{"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"placeOfIssue":{"type":"string","minLength":1,"maxLength":256},"transactionNumber":{"type":"string","pattern":"^I[0-9A-Z]{9}$"}},"additionalProperties":false},"commercial":{"default":{},"type":"object","properties":{"incoterm":{"type":"string","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAT","DAP","DPU","DDP"]},"freightTerms":{"type":"string","enum":["collect","prepaid"]}},"additionalProperties":false},"cargo":{"type":"object","properties":{"container":{"type":"object","properties":{"number":{"type":"string","pattern":"^[A-Z]{4}\\d{7}$"},"isoType":{"type":"string","pattern":"^[0-9A-Z]{4}$"},"seal":{"type":"string","minLength":1,"maxLength":35}},"required":["isoType"],"additionalProperties":false},"packages":{"minItems":1,"maxItems":20,"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"type":{"type":"string","pattern":"^[A-Z0-9]{2}$"},"grossKg":{"type":"number","exclusiveMinimum":0},"cbm":{"type":"number","exclusiveMinimum":0},"marks":{"type":"string","minLength":1,"maxLength":200},"goods":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"hs":{"type":"string","pattern":"^\\d{6,10}$"},"description":{"type":"string","minLength":1,"maxLength":240},"additionalHs":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{6,10}$"}},"dangerous":{"type":"object","properties":{"unNumber":{"type":"string","pattern":"^\\d{4}$"},"class":{"type":"string","pattern":"^[1-9](\\.[1-6])?$"},"packingGroup":{"type":"string","enum":["I","II","III"]},"properShippingName":{"type":"string","minLength":1,"maxLength":200}},"required":["unNumber","class"],"additionalProperties":false},"vehicles":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"}},"required":["vin"],"additionalProperties":false}},"value":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amount","currency"],"additionalProperties":false}},"required":["description"],"additionalProperties":false}}},"required":["count","type","goods"],"additionalProperties":false}}},"required":["packages"],"additionalProperties":false},"tracking":{"type":"object","properties":{"active":{"type":"boolean"},"alerts":{"type":"boolean"}},"required":["active"],"additionalProperties":false},"options":{"type":"object","properties":{"dryRun":{"type":"boolean"}},"additionalProperties":false}},"required":["shipmentRef","service","routing","cargo"],"additionalProperties":false,"title":"LclConsolidationShipment","description":"Variant K — ocean LCL consolidation: `service.mode = \"ocean\"`, `service.load = \"LCL\"`, `service.lcl.arrangement = \"consolidation\"`. You are the consolidator: several of your houses share one master; `service.lcl.consolidationRef` groups them. Accepted by the schema but answered 422 consolidation_unsupported until evidence set B1 settles the Freightools model."},"AirShipment":{"type":"object","properties":{"shipmentRef":{"type":"string","pattern":"^[A-Za-z0-9._/-]{1,60}$"},"submitManifest":{"type":"boolean"},"service":{"type":"object","properties":{"mode":{"type":"string","const":"air"},"trade":{"type":"string","enum":["import","export","crossTrade"]},"scope":{"default":"port-port","type":"string","enum":["port-port","door-port","port-door","door-door"]}},"required":["mode"],"additionalProperties":false},"parties":{"default":{},"type":"object","properties":{"shipper":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"consignee":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"notify":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false},"customer":{"type":"object","properties":{"party":{"type":"string","enum":["shipper","consignee","other"]},"reference":{"type":"string","minLength":1,"maxLength":50},"details":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"customsBroker":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":70},"address":{"type":"string","minLength":1,"maxLength":70},"city":{"type":"string","minLength":1,"maxLength":35},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"zip":{"type":"string","minLength":1,"maxLength":10},"phone":{"type":"string","minLength":1,"maxLength":50},"email":{"type":"string","maxLength":100,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"partnerCode":{"type":"string","minLength":1,"maxLength":50},"taxId":{"type":"string","minLength":1,"maxLength":20},"taxIdType":{"type":"string","enum":["vat","company","passport","other"]}},"required":["name","country"],"additionalProperties":false}},"additionalProperties":false},"dgContact":{"type":"object","properties":{"company":{"type":"string","minLength":1,"maxLength":70},"person":{"type":"string","minLength":1,"maxLength":70},"phone":{"type":"string","minLength":1,"maxLength":50},"phoneType":{"default":"TE","type":"string","enum":["TE","AL","FX","EM"]}},"required":["company","person","phone"],"additionalProperties":false},"routing":{"type":"object","properties":{"aol":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"aod":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"acceptancePlace":{"type":"string","minLength":1,"maxLength":256},"placeOfReceipt":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"placeOfDelivery":{"type":"object","properties":{"country":{"type":"string","pattern":"^[A-Z]{2}$"},"city":{"type":"string","minLength":1,"maxLength":35},"zip":{"type":"string","minLength":1,"maxLength":10},"address":{"type":"string","minLength":1,"maxLength":70}},"required":["country","city","address"],"additionalProperties":false},"transshipmentAirports":{"maxItems":5,"type":"array","items":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"}}},"required":["aol","aod"],"additionalProperties":false},"carriage":{"default":{},"type":"object","properties":{"airline":{"type":"object","properties":{"iata":{"type":"string","pattern":"^[A-Z0-9]{2}$"},"icao":{"type":"string","pattern":"^[A-Z]{3}$"}},"additionalProperties":false},"flight":{"type":"object","properties":{"number":{"type":"string","pattern":"^(?:[A-Z0-9]{2})?\\d{1,4}[A-Z]?$"},"date":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"required":["number","date"],"additionalProperties":false},"eta":{"type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"booking":{"type":"string","minLength":1,"maxLength":35},"bookingDate":{"description":"The date of the carrier booking (YYYY-MM-DD). Left out, the shipping order takes the day its booking number is first written.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pickupDate":{"description":"The pickup date at origin (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"cutoffDate":{"description":"The carrier's cut-off date (YYYY-MM-DD). Optional.","type":"string","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"additionalProperties":false},"master":{"default":{},"type":"object","properties":{"issuer":{"default":"carrier","type":"string","const":"carrier"},"document":{"type":"object","properties":{"number":{"type":"string","pattern":"^\\d{3}-?\\d{8}$"}},"additionalProperties":false},"dischargeSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"},"goodsReceiptSite":{"type":"string","pattern":"^[A-Z]{2}[A-Z2-9]{3}$"}},"additionalProperties":false},"house":{"default":{},"type":"object","properties":{"document":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":35},"type":{"type":"string","enum":["original","waybill","telex"]}},"additionalProperties":false},"placeOfIssue":{"type":"string","minLength":1,"maxLength":256}},"additionalProperties":false},"commercial":{"default":{},"type":"object","properties":{"incoterm":{"type":"string","enum":["EXW","FCA","FAS","FOB","CFR","CIF","CPT","CIP","DAT","DAP","DPU","DDP"]},"freightTerms":{"type":"string","enum":["collect","prepaid"]},"freightCharge":{"type":"object","properties":{"amount":{"type":"number","minimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"perKg":{"type":"boolean"},"rateTypeCode":{"type":"string","minLength":1,"maxLength":10}},"required":["amount","currency"],"additionalProperties":false}},"additionalProperties":false},"cargo":{"type":"object","properties":{"pieces":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"count":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"type":{"type":"string","pattern":"^[A-Z0-9]{2}$"},"grossKg":{"type":"number","exclusiveMinimum":0},"cbm":{"type":"number","exclusiveMinimum":0},"dimensionsCm":{"type":"object","properties":{"l":{"type":"number","exclusiveMinimum":0},"w":{"type":"number","exclusiveMinimum":0},"h":{"type":"number","exclusiveMinimum":0}},"required":["l","w","h"],"additionalProperties":false},"chargeableKg":{"type":"number","exclusiveMinimum":0},"goods":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"object","properties":{"hs":{"type":"string","pattern":"^\\d{6,10}$"},"description":{"type":"string","minLength":1,"maxLength":240},"additionalHs":{"maxItems":10,"type":"array","items":{"type":"string","pattern":"^\\d{6,10}$"}},"dangerous":{"type":"object","properties":{"unNumber":{"type":"string","pattern":"^\\d{4}$"},"class":{"type":"string","pattern":"^[1-9](\\.[1-6])?$"},"packingGroup":{"type":"string","enum":["I","II","III"]},"properShippingName":{"type":"string","minLength":1,"maxLength":200}},"required":["unNumber","class"],"additionalProperties":false},"vehicles":{"maxItems":200,"type":"array","items":{"type":"object","properties":{"vin":{"type":"string","pattern":"^[A-HJ-NPR-Z0-9]{17}$"}},"required":["vin"],"additionalProperties":false}},"value":{"type":"object","properties":{"amount":{"type":"number","exclusiveMinimum":0},"currency":{"type":"string","pattern":"^[A-Z]{3}$"}},"required":["amount","currency"],"additionalProperties":false}},"required":["description"],"additionalProperties":false}}},"required":["count","type","goods"],"additionalProperties":false}}},"required":["pieces"],"additionalProperties":false},"tracking":{"type":"object","properties":{"active":{"type":"boolean"},"alerts":{"type":"boolean"}},"required":["active"],"additionalProperties":false},"options":{"type":"object","properties":{"dryRun":{"type":"boolean"}},"additionalProperties":false}},"required":["shipmentRef","service","routing","cargo"],"additionalProperties":false,"title":"AirShipment","description":"Variant A — air house: `service.mode = \"air\"` (no `service.load`). House AWB under a master AWB; pieces instead of containers (cargo.pieces[] with count, type, goods[].description), routing.aol and routing.aod; the airline (ICAO/IATA), the flight and the arrival can come later. Use for every air shipment (import, export or cross-trade, as for ocean). Created in Freightools today; the customs send path for air is blocked until Freightools adds the air customs tool (CR-AIR), which the readiness check air_manifest_path reports."},"ShipmentBody":{"description":"One JSON per shipment (an import to Israel, an export from Israel or a cross-trade). The variant is chosen by the discriminator fields `service.mode` (ocean | air), `service.load` (FCL | LCL) and `service.lcl.arrangement` (lineMaster | coload | consolidation): F = ocean FCL, L = LCL under a line master, C = LCL co-load, K = LCL consolidation (422 consolidation_unsupported until evidence set B1), A = air import house. Each variant schema below lists its required members — few: a shipment can start from its route, its cargo and its customer and be completed by later revisions (see \"Start small\" in the guide); unknown fields are rejected (unknown_field) and blocks of another variant are not_applicable_for_variant. `submitManifest` and `options` are not part of the data hash (plan §4.6). Field-by-field reference with validation rules and what customs receives: /docs/guide#3-the-shipment-json; the seven request examples attached to this operation are also browsable on the portal page API & integration.","oneOf":[{"$ref":"#/components/schemas/FclShipment"},{"$ref":"#/components/schemas/LclLineMasterShipment"},{"$ref":"#/components/schemas/LclColoadShipment"},{"$ref":"#/components/schemas/LclConsolidationShipment"},{"$ref":"#/components/schemas/AirShipment"}]},"DecisionRequest":{"type":"object","properties":{"action":{"type":"string","enum":["keep","correction","cancel_and_resend","cancel_only","refer_to_operator"],"description":"keep | correction | cancel_and_resend | cancel_only | refer_to_operator (plan §4.8)"},"revision":{"anyOf":[{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}],"description":"The current revision, as its number (rev) or id; anything else is 409 decision_stale"},"transmission":{"description":"The latest non-cancel transmission id; omit to decide about the latest one","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"note":{"type":"string","maxLength":2000}},"required":["action","revision"],"additionalProperties":false,"description":"POST /v1/shipments/{id}/manifest/decisions body"},"ManifestActionRequest":{"type":"object","properties":{"action":{"type":"string","enum":["send","preview"],"description":"send = the initial customs transmission (manual trigger); preview = IsPreview (501 until verified)"}},"required":["action"],"additionalProperties":false,"description":"POST /v1/shipments/{id}/manifest body"},"CloseActionRequest":{"type":"object","properties":{"note":{"type":"string","minLength":1,"maxLength":2000},"outcome":{"description":"confirmed_not_sent: operator_review bound to an unknown_outcome transmission, admins only","type":"string","enum":["closed","confirmed_not_sent"]}},"required":["note"],"additionalProperties":false,"description":"POST /v1/shipments/{id}/actions/{aid}/close body"},"DeleteDocumentRequest":{"type":"object","properties":{"reason":{"type":"string","minLength":1,"maxLength":500}},"required":["reason"],"additionalProperties":false,"description":"DELETE /v1/shipments/{id}/documents/{did} body"}}}}