{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ovrsea API Documentation","colors":{"primary":"#00565B","light":"#ADEEDD","dark":"#00323E"},"logo":{"light":"https://mintcdn.com/ovrsea/onpNkGu9yYxliWE0/static/logo.png?fit=max\u0026auto=format\u0026n=onpNkGu9yYxliWE0\u0026q=85\u0026s=3e38b1c088daf74082de9c5404954f4d","dark":"https://mintcdn.com/ovrsea/onpNkGu9yYxliWE0/static/logo.png?fit=max\u0026auto=format\u0026n=onpNkGu9yYxliWE0\u0026q=85\u0026s=3e38b1c088daf74082de9c5404954f4d"},"favicon":"https://mintcdn.com/ovrsea/i6rK67YYJR_IXZ0i/static/favicon.svg?fit=max\u0026auto=format\u0026n=i6rK67YYJR_IXZ0i\u0026q=85\u0026s=074e7b69db6999168291a633087262f9","api":{"playground":{"display":"none"}},"navbar":{"links":[{"href":"mailto:antoine@ovrsea.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.ovrsea.com"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/ovrsea","medium":"https://medium.com/ovrsea"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Discover Ovrsea","icon":"ship","href":"https://ovrsea.com"},{"anchor":"Tech @ Ovrsea","icon":"gear","href":"https://ovrsea.notion.site/Tech-Ovrsea-c2733b15d6a54a8abcd5df5e003a1eae"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ovrsea","hasAudioNarration":false,"actualSubdomain":"ovrsea","customDomains":["apidoc.ovrsea.com"],"gitSource":{"type":"github","owner":"ovrsea","repo":"themis","deployBranch":"prod","contentDirectory":"microservices/api-adapter/src/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ac4ce5553fe36dcc0c01750","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":41},{"language":"default","tag":"Data Models","count":22},{"language":"default","tag":"Endpoints","count":15},{"language":"default","tag":"AI \u0026 Agents","count":4},{"language":"default","tag":"Purchase Orders","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Channels","count":2},{"language":"default","tag":"Invoices","count":2},{"language":"default","tag":"Locations","count":2},{"language":"default","tag":"Reporting","count":2}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/shipments/fetch-a-shipment","slug":"/api-reference/shipments/fetch-a-shipment","pageMetadata":{"title":"Fetch a shipment","description":"Fetch a shipment given its OVRSEA shipment id","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipments/{ovrsea_shipment_id}","href":"/api-reference/shipments/fetch-a-shipment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Fetch a shipment given its OVRSEA shipment id\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Fetch a shipment","description":"Fetch a shipment given its OVRSEA shipment id","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipments/{ovrsea_shipment_id}","href":"/api-reference/shipments/fetch-a-shipment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Fetch a shipment","tags":["Shipments"],"description":"Fetch a shipment given its OVRSEA shipment id","parameters":["8a6786e6-bcc9-4298-80f9-ea7011cdd1fc"],"responses":{"200":"93fe4e4c-50fc-4493-948e-6b6222197010","404":"4a18ca14-93a3-41a0-aadb-decea710ad0c"},"method":"get","type":"path","servers":["841461c0-36b7-4968-91d1-118fd984c74f"],"security":[],"path":"/v1/shipments/{ovrsea_shipment_id}","baseUrlOptions":["https://api.cf.ovrsea.com"],"title":"Fetch a shipment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8a6786e6-bcc9-4298-80f9-ea7011cdd1fc":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"in":"path","name":"ovrsea_shipment_id","required":true}},"responses":{"93fe4e4c-50fc-4493-948e-6b6222197010":{"description":"Shipment found","content":{"application/json":{"schema":{"type":"object","modelName":"Shipment","tag":["Shipments"],"properties":{"name":{"type":"string","example":"June Air Export USA","uniqueKey":"name","typeLabel":"string"},"ovrsea_shipment_id":{"type":"string","example":"CDEF","uniqueKey":"ovrsea_shipment_id","typeLabel":"string"},"status":{"type":"string","enum":["booking_request","awaiting_booking","booked","draft","in_progress","finished","cancelled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"created_at","typeLabel":"string"},"incoterm":{"type":"string","enum":["exw","fca","fas","fob","cpt","cfr","cif","cip","dap","ddp","dpu","dat"],"example":"fob","uniqueKey":"incoterm","typeLabel":"enum\u003cstring>"},"freight_mode":{"type":"string","enum":["air","ocean","rail","truck"],"uniqueKey":"freight_mode","typeLabel":"enum\u003cstring>"},"load_type":{"type":"string","enum":["fcl","lcl","both"],"uniqueKey":"load_type","typeLabel":"enum\u003cstring>"},"freight_type":{"type":"string","enum":["port_to_door","door_to_port","door_to_door","port_to_port"],"uniqueKey":"freight_type","typeLabel":"enum\u003cstring>"},"route":{"type":"object","properties":{"pickup_location_id":{"type":"string","example":"23","uniqueKey":"route.pickup_location_id","typeLabel":"string"},"origin_port_unlocode":{"type":"string","example":"FR/FOS","uniqueKey":"route.origin_port_unlocode","typeLabel":"string"},"destination_port_unlocode":{"type":"string","example":"US/NYC","uniqueKey":"route.destination_port_unlocode","typeLabel":"string"},"delivery_location_id":{"type":"string","example":"45","uniqueKey":"route.delivery_location_id","typeLabel":"string"}},"uniqueKey":"route","typeLabel":"object"},"cargo_ready_date":{"modelName":"SimpleDate","type":"string","example":"2021-10-11","uniqueKey":"cargo_ready_date","typeLabel":"string"},"desired_delivery_date":{"modelName":"SimpleDate","type":"string","example":"2021-10-11","uniqueKey":"desired_delivery_date","typeLabel":"string"},"specific_instructions":{"type":"string","description":"Optional field containing specific instruction given by the client","uniqueKey":"specific_instructions","typeLabel":"string"},"cargo":{"type":"object","properties":{"total_weight":{"modelName":"Weight","type":"object","description":"Weight","properties":{"value":{"type":"number","format":"float","example":350.25,"uniqueKey":"cargo.total_weight.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","enum":["kg","lbs"],"example":"kg","uniqueKey":"cargo.total_weight.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cargo.total_weight","typeLabel":"object"},"total_volume":{"modelName":"Volume","type":"object","description":"Unit volume in cbm","properties":{"value":{"type":"number","format":"float","example":10.25,"uniqueKey":"cargo.total_volume.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","example":"cbm","uniqueKey":"cargo.total_volume.unit","typeLabel":"string"}},"uniqueKey":"cargo.total_volume","typeLabel":"object"},"total_teus":{"type":"integer","description":"Shipment total of Twenty-Equivalent Units","example":5,"uniqueKey":"cargo.total_teus","typeLabel":"integer"},"containers":{"type":"array","items":{"type":"object","modelName":"Container","properties":{"container_type":{"type":"string","enum":["twenty_foot_standard","twenty_foot_reefer","twenty_foot_flat_rack","twenty_foot_open_top","forty_foot_standard","forty_foot_reefer","forty_foot_flat_rack","forty_foot_open_top","forty_foot_highcube_standard","forty_foot_highcube_reefer","forty_foot_highcube_flat_rack","forty_foot_highcube_open_top","forty_five_foot_highcube_standard"],"uniqueKey":"cargo.containers.items.[INDEX].container_type","typeLabel":"enum\u003cstring>"},"container_number":{"type":"string","example":"TEMU8667058","uniqueKey":"cargo.containers.items.[INDEX].container_number","typeLabel":"string"},"seal_number":{"type":"string","example":1332641,"uniqueKey":"cargo.containers.items.[INDEX].seal_number","typeLabel":"string"},"purchase_order_references":{"type":"array","items":{"type":"string","example":4500346155,"uniqueKey":"cargo.containers.items.[INDEX].purchase_order_references.items.[INDEX]","typeLabel":"string"},"uniqueKey":"cargo.containers.items.[INDEX].purchase_order_references","typeLabel":"string[]"}},"uniqueKey":"cargo.containers.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cargo.containers","typeLabel":"object[]"},"loads":{"type":"array","items":{"type":"object","modelName":"Load","properties":{"count":{"type":"number","example":3,"uniqueKey":"cargo.loads.items.[INDEX].count","typeLabel":"number"},"type":{"type":"string","enum":["pallet","package","rigid_crate"],"format":"LoadType","uniqueKey":"cargo.loads.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"weight":{"modelName":"Weight","type":"object","description":"Weight","properties":{"value":{"type":"number","format":"float","example":350.25,"uniqueKey":"cargo.loads.items.[INDEX].weight.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","enum":["kg","lbs"],"example":"kg","uniqueKey":"cargo.loads.items.[INDEX].weight.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cargo.loads.items.[INDEX].weight","typeLabel":"object"},"volume_unit":{"type":"string","example":"cm","description":"(deprecated)","uniqueKey":"cargo.loads.items.[INDEX].volume_unit","typeLabel":"string"},"length":{"type":"object","modelName":"Size","description":"Size","properties":{"value":{"type":"number","format":"float","example":10.25,"uniqueKey":"cargo.loads.items.[INDEX].length.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","enum":["cm","in"],"example":"cm","uniqueKey":"cargo.loads.items.[INDEX].length.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cargo.loads.items.[INDEX].length","typeLabel":"object"},"width":{"type":"object","modelName":"Size","description":"Size","properties":{"value":{"type":"number","format":"float","example":10.25,"uniqueKey":"cargo.loads.items.[INDEX].width.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","enum":["cm","in"],"example":"cm","uniqueKey":"cargo.loads.items.[INDEX].width.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cargo.loads.items.[INDEX].width","typeLabel":"object"},"height":{"type":"object","modelName":"Size","description":"Size","properties":{"value":{"type":"number","format":"float","example":10.25,"uniqueKey":"cargo.loads.items.[INDEX].height.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","enum":["cm","in"],"example":"cm","uniqueKey":"cargo.loads.items.[INDEX].height.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cargo.loads.items.[INDEX].height","typeLabel":"object"}},"uniqueKey":"cargo.loads.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cargo.loads","typeLabel":"object[]"}},"uniqueKey":"cargo","typeLabel":"object"},"transported_goods":{"type":"object","properties":{"goods_description":{"type":"string","example":"Description of the shipped goods","uniqueKey":"transported_goods.goods_description","typeLabel":"string"},"is_stackable":{"type":"boolean","default":true,"uniqueKey":"transported_goods.is_stackable","typeLabel":"boolean"},"is_hazardous":{"type":"boolean","default":false,"uniqueKey":"transported_goods.is_hazardous","typeLabel":"boolean"},"hazardous_description":{"type":"string","example":"UN1993","uniqueKey":"transported_goods.hazardous_description","typeLabel":"string"},"contains_lithium":{"type":"boolean","default":false,"uniqueKey":"transported_goods.contains_lithium","typeLabel":"boolean"},"lithium_packaging_type":{"type":"string","enum":["alone","contained","packed"],"uniqueKey":"transported_goods.lithium_packaging_type","typeLabel":"enum\u003cstring>"},"contains_magnets":{"type":"boolean","default":false,"uniqueKey":"transported_goods.contains_magnets","typeLabel":"boolean"},"needs_controlled_temperature":{"type":"boolean","default":false,"uniqueKey":"transported_goods.needs_controlled_temperature","typeLabel":"boolean"},"temperature_range_description":{"type":"string","example":"5-25°C","uniqueKey":"transported_goods.temperature_range_description","typeLabel":"string"}},"uniqueKey":"transported_goods","typeLabel":"object"},"commercial_value":{"modelName":"Price","type":"object","properties":{"amount":{"type":"number","format":"float","example":150357.99,"uniqueKey":"commercial_value.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","enum":["AED","AUD","BHD","BRL","CAD","CHF","CNY","DKK","EUR","GBP","HKD","IDR","INR","JPY","MXN","KRW","KWD","MYR","NOK","NZD","PLN","SEK","SGD","THB","TND","TWD","USD","XOF","XPF","ZAR"],"example":"USD","uniqueKey":"commercial_value.currency","typeLabel":"enum\u003cstring>"}},"uniqueKey":"commercial_value","typeLabel":"object"},"needs_ad_valorem_insurance":{"type":"boolean","default":false,"uniqueKey":"needs_ad_valorem_insurance","typeLabel":"boolean"},"purchase_order_references":{"type":"array","items":{"type":"string","example":4500346155,"uniqueKey":"purchase_order_references.items.[INDEX]","typeLabel":"string"},"uniqueKey":"purchase_order_references","typeLabel":"string[]"},"main_tracking_dates":{"type":"object","properties":{"pickup_date":{"modelName":"TrackingDate","type":"object","properties":{"date":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"main_tracking_dates.pickup_date.date","typeLabel":"string"},"status":{"type":"string","enum":["estimated","actual","planned","problem"],"uniqueKey":"main_tracking_dates.pickup_date.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"main_tracking_dates.pickup_date","typeLabel":"object"},"departure_date":{"modelName":"TrackingDate","type":"object","properties":{"date":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"main_tracking_dates.departure_date.date","typeLabel":"string"},"status":{"type":"string","enum":["estimated","actual","planned","problem"],"uniqueKey":"main_tracking_dates.departure_date.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"main_tracking_dates.departure_date","typeLabel":"object"},"arrival_date":{"modelName":"TrackingDate","type":"object","properties":{"date":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"main_tracking_dates.arrival_date.date","typeLabel":"string"},"status":{"type":"string","enum":["estimated","actual","planned","problem"],"uniqueKey":"main_tracking_dates.arrival_date.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"main_tracking_dates.arrival_date","typeLabel":"object"},"delivery_date":{"modelName":"TrackingDate","type":"object","properties":{"date":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"main_tracking_dates.delivery_date.date","typeLabel":"string"},"status":{"type":"string","enum":["estimated","actual","planned","problem"],"uniqueKey":"main_tracking_dates.delivery_date.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"main_tracking_dates.delivery_date","typeLabel":"object"}},"uniqueKey":"main_tracking_dates","typeLabel":"object"},"booking_information":{"type":"object","properties":{"carrier":{"type":"string","example":"CMA CGM","uniqueKey":"booking_information.carrier","typeLabel":"string"},"master_bill":{"type":"string","example":"LHV1190703558","uniqueKey":"booking_information.master_bill","typeLabel":"string"},"house_bill":{"type":"string","example":"HOUSEREF12357","uniqueKey":"booking_information.house_bill","typeLabel":"string"},"ocean_booking":{"type":"object","properties":{"booking_number":{"type":"string","example":"TWLEH2106004","uniqueKey":"booking_information.ocean_booking.booking_number","typeLabel":"string"},"voyage":{"type":"string","example":"033E","uniqueKey":"booking_information.ocean_booking.voyage","typeLabel":"string"},"vessel":{"type":"string","example":"CMA CGM Jacques Saadé","uniqueKey":"booking_information.ocean_booking.vessel","typeLabel":"string"}},"uniqueKey":"booking_information.ocean_booking","typeLabel":"object"},"air_booking":{"type":"object","properties":{"flight_number":{"type":"string","example":"AF256","uniqueKey":"booking_information.air_booking.flight_number","typeLabel":"string"},"chargeable_weight":{"modelName":"Weight","type":"object","description":"Weight","properties":{"value":{"type":"number","format":"float","example":350.25,"uniqueKey":"booking_information.air_booking.chargeable_weight.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","enum":["kg","lbs"],"example":"kg","uniqueKey":"booking_information.air_booking.chargeable_weight.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"booking_information.air_booking.chargeable_weight","typeLabel":"object"}},"uniqueKey":"booking_information.air_booking","typeLabel":"object"}},"uniqueKey":"booking_information","typeLabel":"object"},"invoice_status":{"type":"string","enum":["available","awaiting_invoice","due","paid","partially_paid"],"uniqueKey":"invoice_status","typeLabel":"enum\u003cstring>"},"invoice_references":{"type":"array","items":{"type":"string","example":"FAC2022-9567","uniqueKey":"invoice_references.items.[INDEX]","typeLabel":"string"},"uniqueKey":"invoice_references","typeLabel":"string[]"},"accepted_quote":{"type":"object","properties":{"id":{"type":"string","example":"325","uniqueKey":"accepted_quote.id","typeLabel":"string"},"request_date":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"accepted_quote.request_date","typeLabel":"string"},"accepted_date":{"modelName":"DateWithTime","type":"string","example":"2021-09-20T10:02:09+01:00","uniqueKey":"accepted_quote.accepted_date","typeLabel":"string"}},"uniqueKey":"accepted_quote","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"June Air Export USA","ovrsea_shipment_id":"CDEF","status":"booking_request","created_at":"2021-09-20T10:02:09+01:00","incoterm":"fob","freight_mode":"air","load_type":"fcl","freight_type":"port_to_door","route":{"pickup_location_id":"23","origin_port_unlocode":"FR/FOS","destination_port_unlocode":"US/NYC","delivery_location_id":"45"},"cargo_ready_date":"2021-10-11","desired_delivery_date":"2021-10-11","specific_instructions":"\u003cstring>","cargo":{"total_weight":{"value":350.25,"unit":"kg"},"total_volume":{"value":10.25,"unit":"cbm"},"total_teus":5,"containers":[{"container_type":"twenty_foot_standard","container_number":"TEMU8667058","seal_number":1332641,"purchase_order_references":[4500346155]}],"loads":[{"count":3,"type":"pallet","weight":{"value":350.25,"unit":"kg"},"volume_unit":"cm","length":{"value":10.25,"unit":"cm"},"width":{"value":10.25,"unit":"cm"},"height":{"value":10.25,"unit":"cm"}}]},"transported_goods":{"goods_description":"Description of the shipped goods","is_stackable":true,"is_hazardous":false,"hazardous_description":"UN1993","contains_lithium":false,"lithium_packaging_type":"alone","contains_magnets":false,"needs_controlled_temperature":false,"temperature_range_description":"5-25°C"},"commercial_value":{"amount":150357.99,"currency":"USD"},"needs_ad_valorem_insurance":false,"purchase_order_references":[4500346155],"main_tracking_dates":{"pickup_date":{"date":"2021-09-20T10:02:09+01:00","status":"estimated"},"departure_date":{"date":"2021-09-20T10:02:09+01:00","status":"estimated"},"arrival_date":{"date":"2021-09-20T10:02:09+01:00","status":"estimated"},"delivery_date":{"date":"2021-09-20T10:02:09+01:00","status":"estimated"}},"booking_information":{"carrier":"CMA CGM","master_bill":"LHV1190703558","house_bill":"HOUSEREF12357","ocean_booking":{"booking_number":"TWLEH2106004","voyage":"033E","vessel":"CMA CGM Jacques Saadé"},"air_booking":{"flight_number":"AF256","chargeable_weight":{"value":350.25,"unit":"kg"}}},"invoice_status":"available","invoice_references":["FAC2022-9567"],"accepted_quote":{"id":"325","request_date":"2021-09-20T10:02:09+01:00","accepted_date":"2021-09-20T10:02:09+01:00"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4a18ca14-93a3-41a0-aadb-decea710ad0c":{"description":"Shipment not found","content":{"application/json":{"schema":{"description":"Shipment not found","type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"841461c0-36b7-4968-91d1-118fd984c74f":{"url":"https://api.cf.ovrsea.com"}}},"originalFileLocation":"openapi.json"},"subdomain":"ovrsea","siteName":"Ovrsea API Documentation","title":"Fetch a shipment - Ovrsea API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T10:08:09.316Z","originalFileLocation":"api-reference/shipments/fetch-a-shipment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Fetch a shipment given its OVRSEA shipment id\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ovrsea API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Fetch a shipment - Ovrsea API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Fetch a shipment given its OVRSEA shipment id\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ovrsea API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ovrsea.mintlify.site/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Fetch+a+shipment\u0026amp;description=Fetch+a+shipment+given+its+OVRSEA+shipment+id\u0026amp;theme=1d5cbc086c71492f169ca812\u0026amp;signature=5fab29a0829fce65bb2967158c4a6cb420f76e3e5331a595042ad6dadba9aeb9\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Fetch a shipment - Ovrsea API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Fetch a shipment given its OVRSEA shipment id\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ovrsea.mintlify.site/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Fetch+a+shipment\u0026amp;description=Fetch+a+shipment+given+its+OVRSEA+shipment+id\u0026amp;theme=1d5cbc086c71492f169ca812\u0026amp;signature=5fab29a0829fce65bb2967158c4a6cb420f76e3e5331a595042ad6dadba9aeb9\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ovrsea/8np9s-D7exwjeLvU/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ovrsea API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00565B\">\u003clink data-mint-head rel=\"canonical\" href=\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/shipments/fetch-a-shipment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://apidoc.ovrsea.com/#organization\",\"name\":\"Ovrsea API Documentation\",\"url\":\"https://apidoc.ovrsea.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ovrsea/onpNkGu9yYxliWE0/static/logo.png?fit=max\u0026auto=format\u0026n=onpNkGu9yYxliWE0\u0026q=85\u0026s=3e38b1c088daf74082de9c5404954f4d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://apidoc.ovrsea.com#website\",\"name\":\"Ovrsea API Documentation\",\"url\":\"https://apidoc.ovrsea.com\",\"publisher\":{\"@id\":\"https://apidoc.ovrsea.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment#webpage\",\"url\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment\",\"name\":\"Fetch a shipment\",\"description\":\"Fetch a shipment given its OVRSEA shipment id\",\"dateModified\":\"2026-09-23T10:08:09.316Z\",\"isPartOf\":{\"@id\":\"https://apidoc.ovrsea.com#website\"},\"breadcrumb\":{\"@id\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-all-shipments\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Shipments\",\"item\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-all-shipments\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Fetch a shipment\",\"item\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment#apireference\",\"headline\":\"Fetch a shipment\",\"name\":\"Fetch a shipment\",\"description\":\"Fetch a shipment given its OVRSEA shipment id\",\"url\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment\",\"mainEntityOfPage\":{\"@id\":\"https://apidoc.ovrsea.com/api-reference/shipments/fetch-a-shipment#webpage\"},\"dateModified\":\"2026-09-23T10:08:09.316Z\",\"publisher\":{\"@id\":\"https://apidoc.ovrsea.com/#organization\"},\"isPartOf\":{\"@id\":\"https://apidoc.ovrsea.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ovrsea API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ovrsea API Documentation","nav":{"global":{"anchors":[{"anchor":"Discover Ovrsea","icon":"ship","href":"https://ovrsea.com"},{"anchor":"Tech @ Ovrsea","icon":"gear","href":"https://ovrsea.notion.site/Tech-Ovrsea-c2733b15d6a54a8abcd5df5e003a1eae"}]},"tabs":[{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","href":"/introduction"},{"title":"Authentication","href":"/authentication"},{"title":"Pagination","href":"/pagination"}]},{"group":"Webhooks","pages":[{"title":"Shipment webhooks","href":"/shipment-webhooks"}]},{"group":"Endpoints","pages":[{"group":"Shipments","pages":[{"title":"Fetch all shipments","description":"Fetch all shipments of the account","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipments","href":"/api-reference/shipments/fetch-all-shipments"},{"title":"Fetch a shipment","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/shipments/{ovrsea_shipment_id}","href":"/api-reference/shipments/fetch-a-shipment"}]},{"group":"Invoices","pages":[{"title":"Fetch all invoices","description":"This endpoint returns all the invoices of the account.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices","href":"/api-reference/invoices/fetch-all-invoices"},{"title":"Fetch an invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/invoices/{reference}","href":"/api-reference/invoices/fetch-an-invoice"}]},{"group":"Locations","pages":[{"title":"Get all locations","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/locations","href":"/api-reference/locations/get-all-locations"},{"title":"Get one location","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/locations/{id}","href":"/api-reference/locations/get-one-location"}]},{"group":"Documents","pages":[{"title":"Fetch all documents","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/documents","href":"/api-reference/documents/fetch-all-documents"}]},{"group":"Tracking","pages":[{"title":"Fetch a shipment's tracking.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tracking/{ovrsea_shipment_id}","href":"/api-reference/tracking/fetch-a-shipments-tracking"}]},{"group":"Purchase Orders","pages":[{"title":"Fetch all purchase orders","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchaseOrders","href":"/api-reference/purchase-orders/fetch-all-purchase-orders"},{"title":"Create a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/purchaseOrders","href":"/api-reference/purchase-orders/create-a-purchase-order"},{"title":"Update a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/purchaseOrders","href":"/api-reference/purchase-orders/update-a-purchase-order"},{"title":"Fetch a purchase order","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/purchaseOrders/{reference}","href":"/api-reference/purchase-orders/fetch-a-purchase-order"}]},{"group":"Users","pages":[{"title":"Fetch all users","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/users","href":"/api-reference/users/fetch-all-users"}]},{"group":"Reporting","pages":[{"title":"Fetch products delivery overview reporting","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reporting/products","href":"/api-reference/reporting/fetch-products-delivery-overview-reporting"},{"title":"Fetch Hermes shipments reporting","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/reporting/shipments","href":"/api-reference/reporting/fetch-hermes-shipments-reporting"}]}]},{"group":"Data Models","pages":[{"title":null,"href":"/models/Shipment"},{"title":null,"href":"/models/Container"},{"title":null,"href":"/models/Coordinates"},{"title":null,"href":"/models/DateWithTime"},{"title":null,"href":"/models/Document"},{"title":null,"href":"/models/Invoice"},{"title":null,"href":"/models/Load"},{"title":null,"href":"/models/Location"},{"title":null,"href":"/models/Port"},{"title":null,"href":"/models/Price"},{"title":null,"href":"/models/Product"},{"title":null,"href":"/models/PurchaseOrder"},{"title":null,"href":"/models/Quantity"},{"title":null,"href":"/models/SimpleDate"},{"title":null,"href":"/models/Size"},{"title":null,"href":"/models/Tracking"},{"title":null,"href":"/models/TrackingDate"},{"title":null,"href":"/models/TrackingEvent"},{"title":null,"href":"/models/TrackingStep"},{"title":null,"href":"/models/User"},{"title":null,"href":"/models/Volume"},{"title":null,"href":"/models/Weight"}]}]},{"tab":"AI \u0026 Agents","pages":[{"title":"AI \u0026 Agents","href":"/ai/introduction"}]}]},"basePath":"","title":"Fetch a shipment - Ovrsea API Documentation","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}