{
"statusCode": 409,
"statusReasonCode": "CLAIM_ALREADY_EXISTS",
"error": "An open claim already exists for shipment 1Z999AA1234567890. Please contact Opereit support if you want to fix the previous claim."
}
{
"statusCode": 500,
"statusReasonCode": "INTERNAL_ERROR",
"error": "Internal server error"
}
Claim Management
Create a claim
Submit a new claim and its associated shipment and incidence details. This kicks off Opereit’s review process and prepares the necessary documentation.
If a shipment with the same tracking_number already exists in your organization (e.g. from a previous claim) and it doesn’t have an open claim on it, the new claim is attached to that existing shipment record — the origin/destination you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.
{
"statusCode": 409,
"statusReasonCode": "CLAIM_ALREADY_EXISTS",
"error": "An open claim already exists for shipment 1Z999AA1234567890. Please contact Opereit support if you want to fix the previous claim."
}
{
"statusCode": 500,
"statusReasonCode": "INTERNAL_ERROR",
"error": "Internal server error"
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Opereit for Developers","colors":{"primary":"#0C55C4","light":"#0C55C4","dark":"#0C55C4"},"logo":{"light":"https://mintcdn.com/opereit/9j1Urm3fK_DUvypy/logo/light.svg?fit=max\u0026auto=format\u0026n=9j1Urm3fK_DUvypy\u0026q=85\u0026s=4608af95a88861de68b83c03ce59241a","dark":"https://mintcdn.com/opereit/9j1Urm3fK_DUvypy/logo/dark.svg?fit=max\u0026auto=format\u0026n=9j1Urm3fK_DUvypy\u0026q=85\u0026s=fb62fc24ca6459562d8c48eceafe81b3"},"favicon":"https://mintcdn.com/opereit/9j1Urm3fK_DUvypy/favicon.png?fit=max\u0026auto=format\u0026n=9j1Urm3fK_DUvypy\u0026q=85\u0026s=9c40a05d586bc0e2b398bdf62372e2c8","api":{"examples":{"languages":["typescript",""]}},"appearance":{"default":"system"},"background":{"decoration":"grid"},"navbar":{"links":[{"href":"mailto:hello@opereit.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.obsydianai.com"}},"footer":{"socials":{"github":"https://github.com/opereit","linkedin":"https://linkedin.com/company/obsydian-ai"}},"fonts":{"family":"Inter","weight":400},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"opereit","hasAudioNarration":false,"actualSubdomain":"opereit","customDomains":["developers.opereit.ai"],"gitSource":{"type":"github","owner":"opereit","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ac7d44c43cdc5abc7fad3fb","collectionId":"1d641e6e-2417-4257-b99b-98557f460209","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ac7d44c43cdc5abc7fad3fb"},"entitlements":{},"buildId":"6ac7d44c43cdc5abc7fad3fb","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"API reference","count":15},{"language":"default","tag":"Guides","count":6},{"language":"default","tag":"Claim Management","count":5},{"language":"default","tag":"Contracts","count":4},{"language":"default","tag":"Invoice Audits","count":4},{"language":"default","tag":"Claim documents","count":2},{"language":"default","tag":"Connectors","count":2},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"Start here","count":1},{"language":"default","tag":"Webhooks","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/claims/create","slug":"/api-reference/endpoint/claims/create","pageMetadata":{"title":"Create a claim","openapi":"POST /v1/claims","description":"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit's review process and prepares the necessary documentation.\n\nIf a shipment with the same `tracking_number` already exists in your organization (e.g. from a previous claim) and it doesn't have an open claim on it, the new claim is attached to that existing shipment record — the `origin`/`destination` you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.","href":"/api-reference/endpoint/claims/create"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit’s review process and prepares the necessary documentation.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If a shipment with the same \", _jsx(_components.code, {\n children: \"tracking_number\"\n }), \" already exists in your organization (e.g. from a previous claim) and it doesn’t have an open claim on it, the new claim is attached to that existing shipment record — the \", _jsx(_components.code, {\n children: \"origin\"\n }), \"/\", _jsx(_components.code, {\n children: \"destination\"\n }), \" you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.\"]\n })]\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":"Create a claim","openapi":"POST /v1/claims","description":"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit's review process and prepares the necessary documentation.\n\nIf a shipment with the same `tracking_number` already exists in your organization (e.g. from a previous claim) and it doesn't have an open claim on it, the new claim is attached to that existing shipment record — the `origin`/`destination` you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.","href":"/api-reference/endpoint/claims/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a claim","description":"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit's review process and prepares the necessary documentation.\n\nIf a shipment with the same `tracking_number` already exists in your organization (e.g. from a previous claim) and it doesn't have an open claim on it, the new claim is attached to that existing shipment record — the `origin`/`destination` you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.","operationId":"createClaim","requestBody":"f0baeff4-a50a-4b1b-97e0-9167afc8ea24","responses":{"201":"7c6dc55b-1c14-441d-ae63-56405ef3bbe9","400":"75418f56-7649-4dfe-8b34-21d039a339ee","401":"19d35593-2ea2-4f32-97c8-7c8dea0928de","409":"35c9fb9a-9e11-49f8-97b8-0f7200cadc93","500":"baf8ac07-affa-4d42-bdb5-9e235161dad1"},"method":"post","type":"path","servers":["16b9c834-f8bc-42c0-b91e-791246f619ea"],"security":["40c4879f-b35a-4dc4-a01d-29382a6b8901"],"path":"/v1/claims","baseUrlOptions":["https://api.opereit.ai"],"title":"Create a claim","codeSamples":[],"requestExampleLanguages":["typescript",""],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment","incidence"],"properties":{"shipment":{"type":"object","required":["tracking_number","carrier","origin","destination","line_items"],"properties":{"tracking_number":{"type":"string","minLength":1,"description":"The carrier's tracking number for this shipment. Used to detect duplicate claims — see the endpoint description above.","example":"1Z999AA1234567890","isRequired":true,"uniqueKey":"shipment.tracking_number","typeLabel":"string"},"carrier":{"type":"string","enum":["BPOST","BRT","CHRONOPOST","CORREOS","CORREOS_EXPRESS","CTT","DPD","EVRI","FEDEX","GLS","INPOST","MAERSK","PAACK","PC_COMPONENTES","POSTAG","SEUR","UPS"],"description":"The carrier that shipped the parcel. Must be one of the listed values — an unrecognized carrier is rejected with `400 INVALID_REQUEST_BODY`.","isRequired":true,"uniqueKey":"shipment.carrier","typeLabel":"enum\u003cstring>"},"origin":{"type":"object","required":["postcode","country"],"properties":{"postcode":{"type":"string","minLength":1,"description":"Origin postcode.","isRequired":true,"uniqueKey":"shipment.origin.postcode","typeLabel":"string"},"country":{"type":"string","minLength":1,"description":"Origin country, ISO 3166-1 alpha-2.","isRequired":true,"uniqueKey":"shipment.origin.country","typeLabel":"string"}},"isRequired":true,"uniqueKey":"shipment.origin","typeLabel":"object"},"destination":{"type":"object","required":["postcode","country","city","address","customer_name"],"properties":{"postcode":{"type":"string","minLength":1,"description":"Destination postcode.","isRequired":true,"uniqueKey":"shipment.destination.postcode","typeLabel":"string"},"country":{"type":"string","minLength":1,"description":"Destination country, ISO 3166-1 alpha-2.","isRequired":true,"uniqueKey":"shipment.destination.country","typeLabel":"string"},"city":{"type":"string","minLength":1,"description":"Destination city.","isRequired":true,"uniqueKey":"shipment.destination.city","typeLabel":"string"},"address":{"type":"string","minLength":1,"description":"Destination street address.","isRequired":true,"uniqueKey":"shipment.destination.address","typeLabel":"string"},"customer_name":{"type":"string","minLength":1,"description":"Recipient's name.","isRequired":true,"uniqueKey":"shipment.destination.customer_name","typeLabel":"string"},"customer_phone":{"type":"string","minLength":6,"maxLength":20,"description":"Recipient's phone number. Optional; 6-20 characters when provided.","uniqueKey":"shipment.destination.customer_phone","typeLabel":"string"}},"isRequired":true,"uniqueKey":"shipment.destination","typeLabel":"object"},"line_items":{"type":"array","minItems":1,"description":"Items in the shipment covered by this claim. At least one required.","items":{"type":"object","required":["description","quantity","unit_price","currency"],"properties":{"description":{"type":"string","minLength":1,"description":"Item description.","isRequired":true,"uniqueKey":"shipment.line_items.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"description":"Number of units.","isRequired":true,"uniqueKey":"shipment.line_items.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"integer","minimum":1,"description":"Price per unit, in the smallest currency unit (e.g. cents).","isRequired":true,"uniqueKey":"shipment.line_items.items.[INDEX].unit_price","typeLabel":"integer"},"currency":{"type":"string","minLength":3,"maxLength":3,"description":"ISO 4217 currency code, e.g. `EUR`.","example":"EUR","isRequired":true,"uniqueKey":"shipment.line_items.items.[INDEX].currency","typeLabel":"string"}},"uniqueKey":"shipment.line_items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipment.line_items","typeLabel":"object[]"},"provider":{"type":"string","description":"Optional shipping platform/aggregator the shipment was booked through (e.g. a multi-carrier shipping tool), if different from the carrier. Known values: `BPOST`, `BRT`, `CHRONOPOST`, `CORREOS`, `CORREOS_EXPRESS`, `CTT`, `DPD`, `EVRI`, `FEDEX`, `GLS`, `INPOST`, `MAERSK`, `PAACK`, `PC_COMPONENTES`, `POSTAG`, `SENDCLOUD`, `SEUR`, `UPS`, `WING`.","uniqueKey":"shipment.provider","typeLabel":"string"}},"isRequired":true,"uniqueKey":"shipment","typeLabel":"object"},"incidence":{"type":"object","required":["type","claimed_amount"],"properties":{"type":{"type":"string","enum":["DAMAGED","LOST"],"description":"What happened to the shipment.","isRequired":true,"uniqueKey":"incidence.type","typeLabel":"enum\u003cstring>"},"claimed_amount":{"type":"integer","minimum":1,"description":"Total amount being claimed, in the smallest currency unit (e.g. cents).","isRequired":true,"uniqueKey":"incidence.claimed_amount","typeLabel":"integer"},"description":{"type":"string","description":"Optional free-text narrative of what happened.","uniqueKey":"incidence.description","typeLabel":"string"},"currency":{"type":"string","minLength":3,"maxLength":3,"default":"EUR","description":"ISO 4217 currency code. Defaults to `EUR` if omitted.","uniqueKey":"incidence.currency","typeLabel":"string"}},"isRequired":true,"uniqueKey":"incidence","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"shipment":{"tracking_number":"1Z999AA1234567890","origin":{"postcode":"\u003cstring>","country":"\u003cstring>"},"destination":{"postcode":"\u003cstring>","country":"\u003cstring>","city":"\u003cstring>","address":"\u003cstring>","customer_name":"\u003cstring>","customer_phone":"\u003cstring>"},"line_items":[{"description":"\u003cstring>","quantity":2,"unit_price":2,"currency":"EUR"}],"provider":"\u003cstring>"},"incidence":{"claimed_amount":2,"description":"\u003cstring>","currency":"EUR"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7c6dc55b-1c14-441d-ae63-56405ef3bbe9":{"description":"Claim created.","content":{"application/json":{"schema":{"type":"object","description":"The claim just created, as returned by the create-claim endpoint.","required":["id","number","status","status_reason","date","carrier_id","created_at","updated_at","total_amount","shipment","incidence"],"properties":{"id":{"type":"string","description":"Unique claim ID.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"number":{"oneOf":[{"type":"string","description":"Human-readable claim reference. `null` until assigned by the Opereit team.","isRequired":true,"uniqueKey":"number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable claim reference. `null` until assigned by the Opereit team.","isRequired":true,"uniqueKey":"number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"number","typeLabel":"string | null"},"status":{"type":"string","enum":["CREATED","UNDER_REVIEW","PENDING_ACTION","PENDING_REFUND","PENDING_REFUND_AMOUNT_CONFIRMED","RESOLVED","CANCELED","REJECTED","CLOSED"],"description":"Always `CREATED` on this response.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"status_reason":{"type":"null","description":"Always `null` on this response — a newly created claim starts at `CREATED`, which doesn't carry a status reason. See [Status reasons](/guides/claims#status-reasons).","isRequired":true,"uniqueKey":"status_reason","typeLabel":"null"},"date":{"type":"string","format":"date","description":"Date the claim was filed.","isRequired":true,"uniqueKey":"date","typeLabel":"string\u003cdate>"},"carrier_id":{"type":"string","isRequired":true,"uniqueKey":"carrier_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"},"total_amount":{"type":"integer","description":"Equal to `incidence.claimed_amount`, in the smallest currency unit.","isRequired":true,"uniqueKey":"total_amount","typeLabel":"integer"},"shipment":{"type":"object","required":["id","tracking_number","carrier_id","created_at","origin","destination","line_items"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"shipment.id","typeLabel":"string"},"tracking_number":{"type":"string","isRequired":true,"uniqueKey":"shipment.tracking_number","typeLabel":"string"},"carrier_id":{"type":"string","isRequired":true,"uniqueKey":"shipment.carrier_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"shipment.created_at","typeLabel":"string\u003cdate-time>"},"origin":{"type":"object","properties":{"postcode":{"type":"string","uniqueKey":"shipment.origin.postcode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"shipment.origin.country","typeLabel":"string"}},"description":"Reflects the shipment's stored origin. If the tracking number already had a shipment on file, this is the original origin, not necessarily what you sent in this request.","isRequired":true,"uniqueKey":"shipment.origin","typeLabel":"object"},"destination":{"type":"object","properties":{"postcode":{"type":"string","uniqueKey":"shipment.destination.postcode","typeLabel":"string"},"country":{"type":"string","uniqueKey":"shipment.destination.country","typeLabel":"string"},"city":{"oneOf":[{"type":"string","uniqueKey":"shipment.destination.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shipment.destination.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.destination.city","typeLabel":"string | null"},"address":{"oneOf":[{"type":"string","uniqueKey":"shipment.destination.address.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"shipment.destination.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.destination.address","typeLabel":"string | null"},"customer_name":{"oneOf":[{"type":"string","description":"Recipient's name, snake_case here (see `Claim.shipment.destination.customerName` for the get-by-id casing).","uniqueKey":"shipment.destination.customer_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Recipient's name, snake_case here (see `Claim.shipment.destination.customerName` for the get-by-id casing).","uniqueKey":"shipment.destination.customer_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.destination.customer_name","typeLabel":"string | null"}},"description":"Same caveat as `origin` above — reflects the stored shipment, which may predate this request.","isRequired":true,"uniqueKey":"shipment.destination","typeLabel":"object"},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"shipment.line_items.items.[INDEX].id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"shipment.line_items.items.[INDEX].description","typeLabel":"string"},"quantity":{"type":"integer","uniqueKey":"shipment.line_items.items.[INDEX].quantity","typeLabel":"integer"},"unit_price":{"type":"integer","uniqueKey":"shipment.line_items.items.[INDEX].unit_price","typeLabel":"integer"},"total":{"type":"integer","uniqueKey":"shipment.line_items.items.[INDEX].total","typeLabel":"integer"}},"uniqueKey":"shipment.line_items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"shipment.line_items","typeLabel":"object[]"},"service_type":{"oneOf":[{"type":"string","description":"Carrier service used. Currently always `STANDARD` for newly created shipments.","uniqueKey":"shipment.service_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier service used. Currently always `STANDARD` for newly created shipments.","uniqueKey":"shipment.service_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.service_type","typeLabel":"string | null"},"shipped_at":{"oneOf":[{"type":"string","format":"date-time","description":"For a shipment created by this request, equals the shipment's `created_at`. For a reused existing shipment (see the tracking-number note above), carries whatever was set when that shipment was first created.","uniqueKey":"shipment.shipped_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"For a shipment created by this request, equals the shipment's `created_at`. For a reused existing shipment (see the tracking-number note above), carries whatever was set when that shipment was first created.","uniqueKey":"shipment.shipped_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.shipped_at","typeLabel":"string\u003cdate-time> | null"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","description":"Same behavior as `shipped_at`.","uniqueKey":"shipment.delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Same behavior as `shipped_at`.","uniqueKey":"shipment.delivered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.delivered_at","typeLabel":"string\u003cdate-time> | null"},"number_of_items":{"oneOf":[{"type":"integer","description":"Total quantity across all submitted line items.","uniqueKey":"shipment.number_of_items.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Total quantity across all submitted line items.","uniqueKey":"shipment.number_of_items.oneOf.1","typeLabel":"null"}],"uniqueKey":"shipment.number_of_items","typeLabel":"integer | null"}},"isRequired":true,"uniqueKey":"shipment","typeLabel":"object"},"incidence":{"type":"object","required":["id","type","claimed_amount","currency","line_items"],"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"incidence.id","typeLabel":"string"},"type":{"type":"string","enum":["DAMAGED","LOST"],"description":"What happened to the shipment.","isRequired":true,"uniqueKey":"incidence.type","typeLabel":"enum\u003cstring>"},"claimed_amount":{"type":"integer","isRequired":true,"uniqueKey":"incidence.claimed_amount","typeLabel":"integer"},"currency":{"type":"string","isRequired":true,"uniqueKey":"incidence.currency","typeLabel":"string"},"line_items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"incidence.line_items.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"incidence.line_items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"incidence.line_items","typeLabel":"object[]"},"description":{"oneOf":[{"type":"string","uniqueKey":"incidence.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"incidence.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"incidence.description","typeLabel":"string | null"},"recovered_amount":{"oneOf":[{"type":"integer","uniqueKey":"incidence.recovered_amount.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"incidence.recovered_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"incidence.recovered_amount","typeLabel":"integer | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"incidence.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"incidence.updated_at","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"incidence","typeLabel":"object"},"provider_id":{"oneOf":[{"type":"string","uniqueKey":"provider_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"provider_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"provider_id","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","number":"\u003cstring>","status":"CREATED","status_reason":null,"date":"2023-12-25","carrier_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","total_amount":123,"shipment":{"id":"\u003cstring>","tracking_number":"\u003cstring>","carrier_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","origin":{"postcode":"\u003cstring>","country":"\u003cstring>"},"destination":{"postcode":"\u003cstring>","country":"\u003cstring>","city":"\u003cstring>","address":"\u003cstring>","customer_name":"\u003cstring>"},"line_items":[{"id":"\u003cstring>","description":"\u003cstring>","quantity":123,"unit_price":123,"total":123}],"service_type":"\u003cstring>","shipped_at":"2023-11-07T05:31:56Z","delivered_at":"2023-11-07T05:31:56Z","number_of_items":123},"incidence":{"id":"\u003cstring>","type":"DAMAGED","claimed_amount":123,"currency":"\u003cstring>","line_items":[{"id":"\u003cstring>"}],"description":"\u003cstring>","recovered_amount":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"},"provider_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"75418f56-7649-4dfe-8b34-21d039a339ee":{"description":"The request body failed validation. `details.fieldErrors` is keyed by the top-level field (`shipment` or `incidence`) — it does not drill into which nested property failed, so a single key can carry more than one message.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned by every endpoint.","required":["statusCode","statusReasonCode","error"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code — same value as the response status.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"statusReasonCode":{"type":"string","enum":["INVALID_REQUEST_BODY","INVALID_QUERY_PARAMETERS","UNSUPPORTED_DOCUMENT_CONTENT_TYPE","CLAIM_NOT_FOUND","CLAIM_ALREADY_EXISTS","CONTRACT_NOT_FOUND","INVOICE_AUDIT_NOT_FOUND","INTERNAL_ERROR","AUTHENTICATION_REQUIRED","INVALID_CREDENTIALS_FORMAT","INVALID_CREDENTIALS_ENCODING","INVALID_CREDENTIALS"],"description":"Machine-readable error code.","isRequired":true,"uniqueKey":"statusReasonCode","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present on `400` responses. `formErrors` holds errors not tied to a specific field; `fieldErrors` maps a top-level request field to the list of validation messages raised under it.","properties":{"formErrors":{"type":"array","items":{"type":"string","uniqueKey":"details.formErrors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.formErrors","typeLabel":"string[]"},"fieldErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.fieldErrors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.fieldErrors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"details.fieldErrors","typeLabel":"object"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":400,"statusReasonCode":"INVALID_REQUEST_BODY","error":"Invalid request body","details":{"formErrors":[],"fieldErrors":{"shipment":["Invalid option: expected one of \"BPOST\"|\"BRT\"|\"CHRONOPOST\"|...|\"UPS\""],"incidence":["Claimed amount must be a positive integer (smallest currency unit)"]}}},"examples":{"Example":{"title":"Example","value":{"statusCode":400,"statusReasonCode":"INVALID_REQUEST_BODY","error":"Invalid request body","details":{"formErrors":[],"fieldErrors":{"shipment":["Invalid option: expected one of \"BPOST\"|\"BRT\"|\"CHRONOPOST\"|...|\"UPS\""],"incidence":["Claimed amount must be a positive integer (smallest currency unit)"]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"19d35593-2ea2-4f32-97c8-7c8dea0928de":{"description":"Authentication is missing or invalid. Also returned as `WWW-Authenticate: Basic realm=\"Opereit API\"` on the response headers.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned by every endpoint.","required":["statusCode","statusReasonCode","error"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code — same value as the response status.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"statusReasonCode":{"type":"string","enum":["INVALID_REQUEST_BODY","INVALID_QUERY_PARAMETERS","UNSUPPORTED_DOCUMENT_CONTENT_TYPE","CLAIM_NOT_FOUND","CLAIM_ALREADY_EXISTS","CONTRACT_NOT_FOUND","INVOICE_AUDIT_NOT_FOUND","INTERNAL_ERROR","AUTHENTICATION_REQUIRED","INVALID_CREDENTIALS_FORMAT","INVALID_CREDENTIALS_ENCODING","INVALID_CREDENTIALS"],"description":"Machine-readable error code.","isRequired":true,"uniqueKey":"statusReasonCode","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present on `400` responses. `formErrors` holds errors not tied to a specific field; `fieldErrors` maps a top-level request field to the list of validation messages raised under it.","properties":{"formErrors":{"type":"array","items":{"type":"string","uniqueKey":"details.formErrors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.formErrors","typeLabel":"string[]"},"fieldErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.fieldErrors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.fieldErrors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"details.fieldErrors","typeLabel":"object"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":401,"statusReasonCode":"AUTHENTICATION_REQUIRED","error":"Authentication required"},"examples":{"Example":{"title":"Example","value":{"statusCode":401,"statusReasonCode":"AUTHENTICATION_REQUIRED","error":"Authentication required"}}},"exampleType":"examples"}},"exampleType":"examples"},"35c9fb9a-9e11-49f8-97b8-0f7200cadc93":{"description":"An open claim already exists for this shipment's tracking number.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned by every endpoint.","required":["statusCode","statusReasonCode","error"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code — same value as the response status.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"statusReasonCode":{"type":"string","enum":["INVALID_REQUEST_BODY","INVALID_QUERY_PARAMETERS","UNSUPPORTED_DOCUMENT_CONTENT_TYPE","CLAIM_NOT_FOUND","CLAIM_ALREADY_EXISTS","CONTRACT_NOT_FOUND","INVOICE_AUDIT_NOT_FOUND","INTERNAL_ERROR","AUTHENTICATION_REQUIRED","INVALID_CREDENTIALS_FORMAT","INVALID_CREDENTIALS_ENCODING","INVALID_CREDENTIALS"],"description":"Machine-readable error code.","isRequired":true,"uniqueKey":"statusReasonCode","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present on `400` responses. `formErrors` holds errors not tied to a specific field; `fieldErrors` maps a top-level request field to the list of validation messages raised under it.","properties":{"formErrors":{"type":"array","items":{"type":"string","uniqueKey":"details.formErrors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.formErrors","typeLabel":"string[]"},"fieldErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.fieldErrors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.fieldErrors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"details.fieldErrors","typeLabel":"object"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":409,"statusReasonCode":"CLAIM_ALREADY_EXISTS","error":"An open claim already exists for shipment 1Z999AA1234567890. Please contact Opereit support if you want to fix the previous claim."},"examples":{"Example":{"title":"Example","value":{"statusCode":409,"statusReasonCode":"CLAIM_ALREADY_EXISTS","error":"An open claim already exists for shipment 1Z999AA1234567890. Please contact Opereit support if you want to fix the previous claim."}}},"exampleType":"examples"}},"exampleType":"examples"},"baf8ac07-affa-4d42-bdb5-9e235161dad1":{"description":"Unexpected server error.","content":{"application/json":{"schema":{"type":"object","description":"Error envelope returned by every endpoint.","required":["statusCode","statusReasonCode","error"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code — same value as the response status.","isRequired":true,"uniqueKey":"statusCode","typeLabel":"integer"},"statusReasonCode":{"type":"string","enum":["INVALID_REQUEST_BODY","INVALID_QUERY_PARAMETERS","UNSUPPORTED_DOCUMENT_CONTENT_TYPE","CLAIM_NOT_FOUND","CLAIM_ALREADY_EXISTS","CONTRACT_NOT_FOUND","INVOICE_AUDIT_NOT_FOUND","INTERNAL_ERROR","AUTHENTICATION_REQUIRED","INVALID_CREDENTIALS_FORMAT","INVALID_CREDENTIALS_ENCODING","INVALID_CREDENTIALS"],"description":"Machine-readable error code.","isRequired":true,"uniqueKey":"statusReasonCode","typeLabel":"enum\u003cstring>"},"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"type":"object","description":"Present on `400` responses. `formErrors` holds errors not tied to a specific field; `fieldErrors` maps a top-level request field to the list of validation messages raised under it.","properties":{"formErrors":{"type":"array","items":{"type":"string","uniqueKey":"details.formErrors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.formErrors","typeLabel":"string[]"},"fieldErrors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"details.fieldErrors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"details.fieldErrors.additionalProperties","typeLabel":"string[]"},"uniqueKey":"details.fieldErrors","typeLabel":"object"}},"uniqueKey":"details","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"statusCode":500,"statusReasonCode":"INTERNAL_ERROR","error":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"statusCode":500,"statusReasonCode":"INTERNAL_ERROR","error":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"40c4879f-b35a-4dc4-a01d-29382a6b8901":{"apiKey":{"type":"http","scheme":"basic","description":"HTTP Basic Auth using your API key. Send `Authorization: Basic base64(key_id:key_secret)`.","scopes":[]}}},"servers":{"16b9c834-f8bc-42c0-b91e-791246f619ea":{"url":"https://api.opereit.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"HTTP Basic Auth using your API key. Send `Authorization: Basic base64(key_id:key_secret)`.","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"HTTP Basic Auth using your API key. Send `Authorization: Basic base64(key_id:key_secret)`.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"opereit","siteName":"Opereit for Developers","title":"Create a claim - Opereit for Developers","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T13:35:26.522Z","gitLastModified":"2026-08-25T13:35:05.000Z","originalFileLocation":"api-reference/endpoint/claims/create.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=\"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit\u0026#x27;s review process and prepares the necessary documentation. If a shipment with the same tracking_number already exists in your organization (e.g. from a previous claim) and it doesn\u0026#x27;t have an open claim on it, the new claim is attached to that existing shipment record — the origin/destination you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Opereit for Developers\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_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/opereit/KKL-I9qKEVNYIEaR/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a claim - Opereit for Developers\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit\u0026#x27;s review process and prepares the necessary documentation. If a shipment with the same tracking_number already exists in your organization (e.g. from a previous claim) and it doesn\u0026#x27;t have an open claim on it, the new claim is attached to that existing shipment record — the origin/destination you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Opereit for Developers\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.opereit.ai/api-reference/endpoint/claims/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://opereit.mintlify.app/_mintlify/api/og/v2?division=Claim+Management\u0026amp;title=Create+a+claim\u0026amp;description=Submit+a+new+claim+and+its+associated+shipment+and+incidence+details.+This+kicks+off+Opereit%27s+review+process+and+prepares+the+necessary+documentation.%0A%0AIf+a+sh\u0026amp;theme=f936422abecfeaf0fc9e3af5\u0026amp;signature=b64adc385d3e50bb0a52cc53bc861ed56bc81eb38d57a5108d01ec9b5aa69955\">\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=\"Create a claim - Opereit for Developers\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit\u0026#x27;s review process and prepares the necessary documentation. If a shipment with the same tracking_number already exists in your organization (e.g. from a previous claim) and it doesn\u0026#x27;t have an open claim on it, the new claim is attached to that existing shipment record — the origin/destination you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://opereit.mintlify.app/_mintlify/api/og/v2?division=Claim+Management\u0026amp;title=Create+a+claim\u0026amp;description=Submit+a+new+claim+and+its+associated+shipment+and+incidence+details.+This+kicks+off+Opereit%27s+review+process+and+prepares+the+necessary+documentation.%0A%0AIf+a+sh\u0026amp;theme=f936422abecfeaf0fc9e3af5\u0026amp;signature=b64adc385d3e50bb0a52cc53bc861ed56bc81eb38d57a5108d01ec9b5aa69955\">\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/opereit/KKL-I9qKEVNYIEaR/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Opereit for Developers\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0C55C4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.opereit.ai/api-reference/endpoint/claims/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/claims/create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.opereit.ai/#organization\",\"name\":\"Opereit for Developers\",\"url\":\"https://developers.opereit.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/opereit/9j1Urm3fK_DUvypy/logo/light.svg?fit=max\u0026auto=format\u0026n=9j1Urm3fK_DUvypy\u0026q=85\u0026s=4608af95a88861de68b83c03ce59241a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.opereit.ai#website\",\"name\":\"Opereit for Developers\",\"url\":\"https://developers.opereit.ai\",\"publisher\":{\"@id\":\"https://developers.opereit.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create#webpage\",\"url\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create\",\"name\":\"Create a claim\",\"description\":\"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit's review process and prepares the necessary documentation. If a shipment with the same tracking_number already exists in your organization (e.g. from a previous claim) and it doesn't have an open claim on it, the new claim is attached to that existing shipment record — the origin/destination you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.\",\"dateModified\":\"2026-08-25T13:35:05.000Z\",\"isPartOf\":{\"@id\":\"https://developers.opereit.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Claim Management\",\"item\":\"https://developers.opereit.ai/api-reference/endpoint/claims/list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a claim\",\"item\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create#apireference\",\"headline\":\"Create a claim\",\"name\":\"Create a claim\",\"description\":\"Submit a new claim and its associated shipment and incidence details. This kicks off Opereit's review process and prepares the necessary documentation. If a shipment with the same tracking_number already exists in your organization (e.g. from a previous claim) and it doesn't have an open claim on it, the new claim is attached to that existing shipment record — the origin/destination you send in this request are only used the first time a shipment is created for that tracking number, and are ignored on later requests for the same tracking number.\",\"url\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create\",\"mainEntityOfPage\":{\"@id\":\"https://developers.opereit.ai/api-reference/endpoint/claims/create#webpage\"},\"dateModified\":\"2026-08-25T13:35:05.000Z\",\"publisher\":{\"@id\":\"https://developers.opereit.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.opereit.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Opereit for Developers\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Opereit for Developers","nav":{"global":{"anchors":[]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Start here","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Claim Management","pages":[{"title":"List claims","openapi":"GET /v1/claims","description":"Returns a cursor-paginated list of claims for your organization, ordered by internal ID ascending (oldest first).","href":"/api-reference/endpoint/claims/list"},{"title":"Create a claim","openapi":"POST /v1/claims","href":"/api-reference/endpoint/claims/create"},{"title":"Get a claim","openapi":"GET /v1/claims/{id}","description":"Retrieve a single claim by ID, including its full shipment and incidence details.","href":"/api-reference/endpoint/claims/get"}]},{"group":"Claim documents","pages":[{"title":"Initiate document upload","openapi":"POST /v1/claims/{id}/documents","href":"/api-reference/endpoint/claims/documents/initiate"},{"title":"Confirm document upload","openapi":"POST /v1/claims/{id}/documents/complete","href":"/api-reference/endpoint/claims/documents/complete"}]},{"group":"Contracts","pages":[{"title":"Upload contract","openapi":"POST /v1/contracts","href":"/api-reference/endpoint/contracts/upload"},{"title":"List contracts","openapi":"GET /v1/contracts","href":"/api-reference/endpoint/contracts/list"},{"title":"List contract rates","openapi":"GET /v1/contracts/{contract_id}/rates","href":"/api-reference/endpoint/contracts/list-rates"},{"title":"List contract surcharges","openapi":"GET /v1/contracts/{contract_id}/surcharges","href":"/api-reference/endpoint/contracts/list-surcharges"}]},{"group":"Invoice Audits","pages":[{"title":"Create invoice audit","openapi":"POST /v1/invoice-audits","href":"/api-reference/endpoint/invoice-audits/create"},{"title":"List invoice audits","openapi":"GET /v1/invoice-audits","href":"/api-reference/endpoint/invoice-audits/list"},{"title":"List line items","openapi":"GET /v1/invoice-audits/{audit_id}/line-items","href":"/api-reference/endpoint/invoice-audits/list-line-items"},{"title":"List findings","openapi":"GET /v1/invoice-audits/{audit_id}/findings","href":"/api-reference/endpoint/invoice-audits/list-findings"}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks"}]}]}]},"title":"Create a claim - Opereit for Developers","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-rfhihCWU.js","utils-BmH1XFxk.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BcNsxPKB.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BAES3tkd.js","snippetPresets-DCMQBKLP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D6l_bzE9.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BOktbnNh.js","shallow-BCs8SgM7.js","getApiPlaygroundDisplay-DEmW5bJB.js","CodeSnippet-CpZOpB9C.js","CodeSnippets-BOBDqibl.js","Page-D5fEM6aW.js","getPastedJson-DH2JBvmr.js","icon-BBJH-kKh.js","MethodPill-D2Sd5NLC.js","DuplicateIcon-CGgfL2qN.js","createIcon-BKudBBzi.js","DynamicMarkdown-85clUA0i.js","SectionHeading-D0JiMgDx.js","axios-vUo_bRtp.js","Markdown-Cfiy0xZO.js","clsx-rL8ZCCw4.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-aeztFa9U.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BywkCr5C.js"]}