Your identifier of the Shipment. Provide either shipment_uuid or shipment_id.
Maximum string length: 50
Body
application/json
Same fields and constraints as Create Shipment; no field is required. Most fields replace the stored value entirely (whole arrays, whole address objects); tags, events, linked_shipments, and documents are add-only.
Carrier tracking number — optional, but needed (with carrier_reference) for tracking. A–Z a–z 0–9 _ - . /, no spaces, at least one digit. Stored uppercase.
One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either country or country_code. The email and phone here are contact data — they are never subscribed to tracking notifications.
One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either country or country_code. The email and phone here are contact data — they are never subscribed to tracking notifications.
One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either country or country_code. The email and phone here are contact data — they are never subscribed to tracking notifications.
One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either country or country_code. The email and phone here are contact data — they are never subscribed to tracking notifications.
One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either country or country_code. The email and phone here are contact data — they are never subscribed to tracking notifications.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Perform.AI","description":"Perform.AI developer documentation. REST APIs for tracking, booking, returns, and delivery predictions. Real-time webhooks and an MCP server for AI assistants.","colors":{"primary":"#6FA900","light":"#93D900","dark":"#456708"},"logo":{"light":"https://mintcdn.com/perform-ai/bpZlF368Aqz3so-O/logo/light.svg?fit=max\u0026auto=format\u0026n=bpZlF368Aqz3so-O\u0026q=85\u0026s=ed60084d2cb4ac41f82c70bcd49f9015","dark":"https://mintcdn.com/perform-ai/bpZlF368Aqz3so-O/logo/dark.svg?fit=max\u0026auto=format\u0026n=bpZlF368Aqz3so-O\u0026q=85\u0026s=97bb86fa7fa8efe9148004c74a873b53"},"favicon":"https://mintcdn.com/perform-ai/h_wboKDQm_MSwzQD/favicon.svg?fit=max\u0026auto=format\u0026n=h_wboKDQm_MSwzQD\u0026q=85\u0026s=aed8d7deabf27a15f3935f4ccb8f29e4","navbar":{"links":[{"href":"https://www.perform.ai","label":"Website"},{"href":"https://www.perform.ai/contact","label":"Contact Us"}],"primary":{"type":"button","label":"Login","href":"https://www.perform.ai/login"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/parcelperform"}},"seo":{"metatags":{"google-site-verification":"qG96ee4d5MxPcm5ZdG8FzeZe-O1tLDxnuP0lVqGhShs"},"indexing":"navigable"},"integrations":{"gtm":{"tagId":"GTM-K62H8N3R"}},"banner":{"content":"**Parcel Perform is now Perform.AI.** [Read more](https://www.perform.ai/parcel-perform-is-now-perform-ai)","dismissible":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"perform-ai","hasAudioNarration":false,"actualSubdomain":"perform-ai","customDomains":["developers.perform.ai"],"gitSource":{"type":"github","owner":"perform-ai-techhub","repo":"dev-portal-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aebee2a5c6aac3c074f10c8","collectionId":"03513452-2fa9-40f7-b12f-de637cca04f6","liveDeploymentHistoryId":"6aebee2a5c6aac3c074f10c8","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aed96617c6274a48b5b1808","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"Product Documentation","count":60},{"language":"default","tag":"Developers","count":32},{"language":"default","tag":"API Reference","count":21},{"language":"default","tag":"Returns","count":14},{"language":"default","tag":"Shipments","count":11},{"language":"default","tag":"AI Commerce Visibility","count":10},{"language":"default","tag":"Checkout","count":9},{"language":"default","tag":"Logistics","count":8},{"language":"default","tag":"Integrations","count":7},{"language":"default","tag":"Post-Purchase","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"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":"vite-origin","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":"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}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"html:not(.dark) #navbar .bg-background-light{background-color:#000000}html:not(.dark) #navbar .border-gray-100{border-color:rgb(255 255 255 / 0.12)}html:not(.dark) #navbar img.nav-logo.block{display:none}html:not(.dark) #navbar img.nav-logo.hidden{display:block}html:not(.dark) #navbar a.link{color:rgb(163 163 163);background-color:transparent}html:not(.dark) #navbar a.link:hover{color:rgb(245 245 245);background-color:rgb(255 255 255 / 0.06)}html:not(.dark) #navbar a.link[aria-current=\"location\"]{color:rgb(250 250 250);background-color:rgb(255 255 255 / 0.08)}html:not(.dark) #navbar .text-gray-950,html:not(.dark) #navbar .text-gray-900,html:not(.dark) #navbar .text-gray-800,html:not(.dark) #navbar .text-gray-700,html:not(.dark) #navbar .text-gray-600,html:not(.dark) #navbar .text-gray-500{color:rgb(212 212 212)}html:not(.dark) #navbar button.group\\/search{color:rgb(255 255 255 / 0.55);--tw-ring-color: rgb(140 140 140 / 0.45)}html:not(.dark) #navbar button.group\\/search:hover{--tw-ring-color: rgb(180 180 180 / 0.5)}html:not(.dark) #navbar button.group\\/search .bg-white{background-color:rgb(30 30 30);color:rgb(170 170 170)}html:not(.dark) #navbar a[class*=\"border-gray-950\"]{color:rgb(212 212 212);border-color:rgb(255 255 255 / 0.18)}html:not(.dark) #navbar a[class*=\"border-gray-950\"]:hover{color:#ffffff;background-color:rgb(255 255 255 / 0.05)}html:not(.dark) #navbar a.bg-primary{background-color:#93d900}html:not(.dark) #navbar a.bg-primary .text-white{color:#0a0a0a}#banner{background-color:#93d900}#banner,#banner p,#banner span{color:#0a0a0a}#banner a{color:#0a0a0a;font-weight:600;text-decoration:underline}#banner button,#banner svg{color:#0a0a0a}"}],"page":{"pagePath":"api-reference/v5/shipments/update-shipment-v52","slug":"/api-reference/v5/shipments/update-shipment-v52","pageMetadata":{"title":"Update Shipment (v5.2)","description":"Same as [Update Shipment](#tag/Shipments) v5.0, plus the **`tags_action`**\nfield controlling how the `tags` array is applied:\n\n- `add` (default) — appends the provided tags, like v5.0.\n- `remove` — removes the provided tags from the Shipment.\n- `replace` — replaces the Shipment's tags with the provided ones.\n System-generated tags (SLA, routing, and similar) are preserved.\n\nSending `tags_action` without any `tags` values returns a 299 warning.","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5-2-0/shipment/update/","href":"/api-reference/v5/shipments/update-shipment-v52","autogeneratedByOpenApi":true},"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 a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsxs(_components.p, {\n children: [\"Same as \", _jsx(_components.a, {\n href: \"#tag/Shipments\",\n children: \"Update Shipment\"\n }), \" v5.0, plus the \", _jsx(_components.strong, {\n children: _jsx(_components.code, {\n children: \"tags_action\"\n })\n }), \"\\nfield controlling how the \", _jsx(_components.code, {\n children: \"tags\"\n }), \" array is applied:\"]\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"add\"\n }), \" (default) — appends the provided tags, like v5.0.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"remove\"\n }), \" — removes the provided tags from the Shipment.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"replace\"\n }), \" — replaces the Shipment’s tags with the provided ones.\\nSystem-generated tags (SLA, routing, and similar) are preserved.\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Sending \", _jsx(_components.code, {\n children: \"tags_action\"\n }), \" without any \", _jsx(_components.code, {\n children: \"tags\"\n }), \" values returns a 299 warning.\"]\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":"Update Shipment (v5.2)","description":"Same as [Update Shipment](#tag/Shipments) v5.0, plus the **`tags_action`**\nfield controlling how the `tags` array is applied:\n\n- `add` (default) — appends the provided tags, like v5.0.\n- `remove` — removes the provided tags from the Shipment.\n- `replace` — replaces the Shipment's tags with the provided ones.\n System-generated tags (SLA, routing, and similar) are preserved.\n\nSending `tags_action` without any `tags` values returns a 299 warning.","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5-2-0/shipment/update/","href":"/api-reference/v5/shipments/update-shipment-v52","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Shipments"],"summary":"Update Shipment (v5.2)","operationId":"post-v5-2-0-shipment-update","description":"Same as [Update Shipment](#tag/Shipments) v5.0, plus the **`tags_action`**\nfield controlling how the `tags` array is applied:\n\n- `add` (default) — appends the provided tags, like v5.0.\n- `remove` — removes the provided tags from the Shipment.\n- `replace` — replaces the Shipment's tags with the provided ones.\n System-generated tags (SLA, routing, and similar) are preserved.\n\nSending `tags_action` without any `tags` values returns a 299 warning.","parameters":["2a0b66f4-21d9-4934-a1da-65328599bc1b","71e2a2d5-22ad-4f41-b2ec-37e9e17e60d0"],"requestBody":"8ab2fe24-4964-4fbc-a639-e7507ec7ceea","responses":{"200":"6c7b4f59-2d75-48d5-836e-82b351b2bdbe","299":"e1246520-af0e-454a-be7b-0cb2c0be1823","400":"6ff37e09-d321-4c01-9fc5-a06d9fe1ca34","403":"6f1bad3f-6478-4a5f-acd7-8203fa4a105c","429":"10c1a517-ba92-49dc-abc6-d782d2a19718","500":"ea3b7ba6-e1db-441f-bdc9-83715584f30f"},"method":"post","type":"path","servers":["f98d71a9-ed14-43dc-963b-4c83cdf95b91"],"security":["da71927a-e136-48db-9b8c-4103161bbc43"],"path":"/v5-2-0/shipment/update/","baseUrlOptions":["https://api.perform.ai"],"title":"Update Shipment (v5.2)","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2a0b66f4-21d9-4934-a1da-65328599bc1b":{"name":"shipment_uuid","in":"query","schema":{"type":"string","format":"uuid","description":"Perform.AI identifier of the Shipment. Provide either `shipment_uuid` or `shipment_id`.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Perform.AI identifier of the Shipment. Provide either `shipment_uuid` or `shipment_id`."},"71e2a2d5-22ad-4f41-b2ec-37e9e17e60d0":{"name":"shipment_id","in":"query","schema":{"type":"string","maxLength":50,"description":"Your identifier of the Shipment. Provide either `shipment_uuid` or `shipment_id`.","uniqueKey":"","typeLabel":"string"},"description":"Your identifier of the Shipment. Provide either `shipment_uuid` or `shipment_id`."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Same fields and constraints as Create Shipment; no field is required. Most fields replace the stored value entirely (whole arrays, whole address objects); `tags`, `events`, `linked_shipments`, and `documents` are add-only.","required":["shipment_id"],"properties":{"shipment_id":{"type":"string","maxLength":50,"description":"Your unique identifier. Unique across the account; cannot be changed after creation. Accepts `A–Z a–z 0–9 _ - .`, no spaces.","isRequired":true,"uniqueKey":"shipment_id","typeLabel":"string"},"tracking_number":{"type":"string","minLength":6,"maxLength":50,"description":"Carrier tracking number — optional, but needed (with `carrier_reference`) for tracking. `A–Z a–z 0–9 _ - . /`, no spaces, at least one digit. Stored uppercase.","uniqueKey":"tracking_number","typeLabel":"string"},"carrier_reference":{"type":"string","maxLength":50,"description":"A carrier reference configured under **Settings > Carriers**. An unconfigured value blocks creation.","uniqueKey":"carrier_reference","typeLabel":"string"},"shipment_reference":{"type":"string","maxLength":50,"uniqueKey":"shipment_reference","typeLabel":"string"},"additional_reference":{"type":"string","maxLength":50,"uniqueKey":"additional_reference","typeLabel":"string"},"order_uuid":{"type":"string","format":"uuid","description":"Attach to an existing order by its Perform.AI identifier. Preferred over `order_id` if both are sent.","uniqueKey":"order_uuid","typeLabel":"string\u003cuuid>"},"order_id":{"type":"string","maxLength":50,"description":"Your order identifier. Creates the order if it doesn't exist.","uniqueKey":"order_id","typeLabel":"string"},"order_reference":{"type":"string","maxLength":50,"description":"Settable only together with a new `order_id`.","uniqueKey":"order_reference","typeLabel":"string"},"order_source_type":{"type":"string","maxLength":500,"uniqueKey":"order_source_type","typeLabel":"string"},"order_source_name":{"type":"string","maxLength":500,"uniqueKey":"order_source_name","typeLabel":"string"},"tags":{"type":"array","items":{"type":"string","maxLength":100,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"description":"Stored lowercase.","uniqueKey":"tags","typeLabel":"string[]"},"notification_email":{"type":"array","items":{"type":"string","format":"email","maxLength":100,"uniqueKey":"notification_email.items.[INDEX]","typeLabel":"string\u003cemail>"},"description":"Recipients of tracking email notifications.","uniqueKey":"notification_email","typeLabel":"string\u003cemail>[]"},"notification_phone":{"type":"array","items":{"type":"string","maxLength":30,"uniqueKey":"notification_phone.items.[INDEX]","typeLabel":"string"},"description":"Recipients of tracking SMS notifications, as `+{country code}{number}`.","uniqueKey":"notification_phone","typeLabel":"string[]"},"tracking_page_reference":{"type":"string","maxLength":50,"description":"Assigns the Shipment to a tracking page for notification branding and tracking links. An unconfigured value returns a 299 warning.","uniqueKey":"tracking_page_reference","typeLabel":"string"},"recipient_address":{"type":"object","description":"One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either `country` or `country_code`. The `email` and `phone` here are contact data — they are never subscribed to tracking notifications.","properties":{"address_name":{"type":"string","maxLength":50,"description":"Name or description of the address.","uniqueKey":"recipient_address.address_name","typeLabel":"string"},"location_type":{"type":"string","maxLength":50,"uniqueKey":"recipient_address.location_type","typeLabel":"string"},"entity_reference":{"type":"string","maxLength":50,"description":"Reference for the entity behind the address.","uniqueKey":"recipient_address.entity_reference","typeLabel":"string"},"salutation":{"type":"string","maxLength":50,"uniqueKey":"recipient_address.salutation","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"description":"First or full name.","uniqueKey":"recipient_address.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"recipient_address.last_name","typeLabel":"string"},"line1":{"type":"string","maxLength":150,"uniqueKey":"recipient_address.line1","typeLabel":"string"},"line2":{"type":"string","maxLength":150,"uniqueKey":"recipient_address.line2","typeLabel":"string"},"line3":{"type":"string","maxLength":150,"uniqueKey":"recipient_address.line3","typeLabel":"string"},"street_name":{"type":"string","maxLength":500,"description":"Street name, when kept separate from the address lines.","uniqueKey":"recipient_address.street_name","typeLabel":"string"},"house_number":{"type":"string","maxLength":50,"uniqueKey":"recipient_address.house_number","typeLabel":"string"},"city":{"type":"string","maxLength":75,"uniqueKey":"recipient_address.city","typeLabel":"string"},"postal_code":{"type":"string","maxLength":25,"uniqueKey":"recipient_address.postal_code","typeLabel":"string"},"state_or_province":{"type":"string","maxLength":75,"uniqueKey":"recipient_address.state_or_province","typeLabel":"string"},"region":{"type":"string","maxLength":75,"uniqueKey":"recipient_address.region","typeLabel":"string"},"country":{"type":"string","maxLength":75,"description":"Country name; resolved through a country identifier and stored as the identified name. Provide this or `country_code`.","uniqueKey":"recipient_address.country","typeLabel":"string"},"country_code":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2. Provide this or `country`.","uniqueKey":"recipient_address.country_code","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":100,"description":"Contact email. Not subscribed to notifications.","uniqueKey":"recipient_address.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","maxLength":30,"description":"Contact phone, `+` then country calling code and number. Not subscribed to notifications.","uniqueKey":"recipient_address.phone","typeLabel":"string"},"fax":{"type":"string","maxLength":16,"description":"`+` followed by up to 15 digits.","uniqueKey":"recipient_address.fax","typeLabel":"string"},"company":{"type":"string","maxLength":150,"uniqueKey":"recipient_address.company","typeLabel":"string"},"tax_id":{"type":"string","maxLength":100,"uniqueKey":"recipient_address.tax_id","typeLabel":"string"}},"uniqueKey":"recipient_address","typeLabel":"object"},"sender_address":{"type":"object","description":"One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either `country` or `country_code`. The `email` and `phone` here are contact data — they are never subscribed to tracking notifications.","properties":{"address_name":{"type":"string","maxLength":50,"description":"Name or description of the address.","uniqueKey":"sender_address.address_name","typeLabel":"string"},"location_type":{"type":"string","maxLength":50,"uniqueKey":"sender_address.location_type","typeLabel":"string"},"entity_reference":{"type":"string","maxLength":50,"description":"Reference for the entity behind the address.","uniqueKey":"sender_address.entity_reference","typeLabel":"string"},"salutation":{"type":"string","maxLength":50,"uniqueKey":"sender_address.salutation","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"description":"First or full name.","uniqueKey":"sender_address.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"sender_address.last_name","typeLabel":"string"},"line1":{"type":"string","maxLength":150,"uniqueKey":"sender_address.line1","typeLabel":"string"},"line2":{"type":"string","maxLength":150,"uniqueKey":"sender_address.line2","typeLabel":"string"},"line3":{"type":"string","maxLength":150,"uniqueKey":"sender_address.line3","typeLabel":"string"},"street_name":{"type":"string","maxLength":500,"description":"Street name, when kept separate from the address lines.","uniqueKey":"sender_address.street_name","typeLabel":"string"},"house_number":{"type":"string","maxLength":50,"uniqueKey":"sender_address.house_number","typeLabel":"string"},"city":{"type":"string","maxLength":75,"uniqueKey":"sender_address.city","typeLabel":"string"},"postal_code":{"type":"string","maxLength":25,"uniqueKey":"sender_address.postal_code","typeLabel":"string"},"state_or_province":{"type":"string","maxLength":75,"uniqueKey":"sender_address.state_or_province","typeLabel":"string"},"region":{"type":"string","maxLength":75,"uniqueKey":"sender_address.region","typeLabel":"string"},"country":{"type":"string","maxLength":75,"description":"Country name; resolved through a country identifier and stored as the identified name. Provide this or `country_code`.","uniqueKey":"sender_address.country","typeLabel":"string"},"country_code":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2. Provide this or `country`.","uniqueKey":"sender_address.country_code","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":100,"description":"Contact email. Not subscribed to notifications.","uniqueKey":"sender_address.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","maxLength":30,"description":"Contact phone, `+` then country calling code and number. Not subscribed to notifications.","uniqueKey":"sender_address.phone","typeLabel":"string"},"fax":{"type":"string","maxLength":16,"description":"`+` followed by up to 15 digits.","uniqueKey":"sender_address.fax","typeLabel":"string"},"company":{"type":"string","maxLength":150,"uniqueKey":"sender_address.company","typeLabel":"string"},"tax_id":{"type":"string","maxLength":100,"uniqueKey":"sender_address.tax_id","typeLabel":"string"}},"uniqueKey":"sender_address","typeLabel":"object"},"to_address":{"type":"object","description":"One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either `country` or `country_code`. The `email` and `phone` here are contact data — they are never subscribed to tracking notifications.","properties":{"address_name":{"type":"string","maxLength":50,"description":"Name or description of the address.","uniqueKey":"to_address.address_name","typeLabel":"string"},"location_type":{"type":"string","maxLength":50,"uniqueKey":"to_address.location_type","typeLabel":"string"},"entity_reference":{"type":"string","maxLength":50,"description":"Reference for the entity behind the address.","uniqueKey":"to_address.entity_reference","typeLabel":"string"},"salutation":{"type":"string","maxLength":50,"uniqueKey":"to_address.salutation","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"description":"First or full name.","uniqueKey":"to_address.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"to_address.last_name","typeLabel":"string"},"line1":{"type":"string","maxLength":150,"uniqueKey":"to_address.line1","typeLabel":"string"},"line2":{"type":"string","maxLength":150,"uniqueKey":"to_address.line2","typeLabel":"string"},"line3":{"type":"string","maxLength":150,"uniqueKey":"to_address.line3","typeLabel":"string"},"street_name":{"type":"string","maxLength":500,"description":"Street name, when kept separate from the address lines.","uniqueKey":"to_address.street_name","typeLabel":"string"},"house_number":{"type":"string","maxLength":50,"uniqueKey":"to_address.house_number","typeLabel":"string"},"city":{"type":"string","maxLength":75,"uniqueKey":"to_address.city","typeLabel":"string"},"postal_code":{"type":"string","maxLength":25,"uniqueKey":"to_address.postal_code","typeLabel":"string"},"state_or_province":{"type":"string","maxLength":75,"uniqueKey":"to_address.state_or_province","typeLabel":"string"},"region":{"type":"string","maxLength":75,"uniqueKey":"to_address.region","typeLabel":"string"},"country":{"type":"string","maxLength":75,"description":"Country name; resolved through a country identifier and stored as the identified name. Provide this or `country_code`.","uniqueKey":"to_address.country","typeLabel":"string"},"country_code":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2. Provide this or `country`.","uniqueKey":"to_address.country_code","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":100,"description":"Contact email. Not subscribed to notifications.","uniqueKey":"to_address.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","maxLength":30,"description":"Contact phone, `+` then country calling code and number. Not subscribed to notifications.","uniqueKey":"to_address.phone","typeLabel":"string"},"fax":{"type":"string","maxLength":16,"description":"`+` followed by up to 15 digits.","uniqueKey":"to_address.fax","typeLabel":"string"},"company":{"type":"string","maxLength":150,"uniqueKey":"to_address.company","typeLabel":"string"},"tax_id":{"type":"string","maxLength":100,"uniqueKey":"to_address.tax_id","typeLabel":"string"}},"uniqueKey":"to_address","typeLabel":"object"},"from_address":{"type":"object","description":"One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either `country` or `country_code`. The `email` and `phone` here are contact data — they are never subscribed to tracking notifications.","properties":{"address_name":{"type":"string","maxLength":50,"description":"Name or description of the address.","uniqueKey":"from_address.address_name","typeLabel":"string"},"location_type":{"type":"string","maxLength":50,"uniqueKey":"from_address.location_type","typeLabel":"string"},"entity_reference":{"type":"string","maxLength":50,"description":"Reference for the entity behind the address.","uniqueKey":"from_address.entity_reference","typeLabel":"string"},"salutation":{"type":"string","maxLength":50,"uniqueKey":"from_address.salutation","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"description":"First or full name.","uniqueKey":"from_address.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"from_address.last_name","typeLabel":"string"},"line1":{"type":"string","maxLength":150,"uniqueKey":"from_address.line1","typeLabel":"string"},"line2":{"type":"string","maxLength":150,"uniqueKey":"from_address.line2","typeLabel":"string"},"line3":{"type":"string","maxLength":150,"uniqueKey":"from_address.line3","typeLabel":"string"},"street_name":{"type":"string","maxLength":500,"description":"Street name, when kept separate from the address lines.","uniqueKey":"from_address.street_name","typeLabel":"string"},"house_number":{"type":"string","maxLength":50,"uniqueKey":"from_address.house_number","typeLabel":"string"},"city":{"type":"string","maxLength":75,"uniqueKey":"from_address.city","typeLabel":"string"},"postal_code":{"type":"string","maxLength":25,"uniqueKey":"from_address.postal_code","typeLabel":"string"},"state_or_province":{"type":"string","maxLength":75,"uniqueKey":"from_address.state_or_province","typeLabel":"string"},"region":{"type":"string","maxLength":75,"uniqueKey":"from_address.region","typeLabel":"string"},"country":{"type":"string","maxLength":75,"description":"Country name; resolved through a country identifier and stored as the identified name. Provide this or `country_code`.","uniqueKey":"from_address.country","typeLabel":"string"},"country_code":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2. Provide this or `country`.","uniqueKey":"from_address.country_code","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":100,"description":"Contact email. Not subscribed to notifications.","uniqueKey":"from_address.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","maxLength":30,"description":"Contact phone, `+` then country calling code and number. Not subscribed to notifications.","uniqueKey":"from_address.phone","typeLabel":"string"},"fax":{"type":"string","maxLength":16,"description":"`+` followed by up to 15 digits.","uniqueKey":"from_address.fax","typeLabel":"string"},"company":{"type":"string","maxLength":150,"uniqueKey":"from_address.company","typeLabel":"string"},"tax_id":{"type":"string","maxLength":100,"uniqueKey":"from_address.tax_id","typeLabel":"string"}},"uniqueKey":"from_address","typeLabel":"object"},"return_address":{"type":"object","description":"One of the Shipment's five address roles (recipient, sender, to, from, return). Provide either `country` or `country_code`. The `email` and `phone` here are contact data — they are never subscribed to tracking notifications.","properties":{"address_name":{"type":"string","maxLength":50,"description":"Name or description of the address.","uniqueKey":"return_address.address_name","typeLabel":"string"},"location_type":{"type":"string","maxLength":50,"uniqueKey":"return_address.location_type","typeLabel":"string"},"entity_reference":{"type":"string","maxLength":50,"description":"Reference for the entity behind the address.","uniqueKey":"return_address.entity_reference","typeLabel":"string"},"salutation":{"type":"string","maxLength":50,"uniqueKey":"return_address.salutation","typeLabel":"string"},"first_name":{"type":"string","maxLength":150,"description":"First or full name.","uniqueKey":"return_address.first_name","typeLabel":"string"},"last_name":{"type":"string","maxLength":150,"uniqueKey":"return_address.last_name","typeLabel":"string"},"line1":{"type":"string","maxLength":150,"uniqueKey":"return_address.line1","typeLabel":"string"},"line2":{"type":"string","maxLength":150,"uniqueKey":"return_address.line2","typeLabel":"string"},"line3":{"type":"string","maxLength":150,"uniqueKey":"return_address.line3","typeLabel":"string"},"street_name":{"type":"string","maxLength":500,"description":"Street name, when kept separate from the address lines.","uniqueKey":"return_address.street_name","typeLabel":"string"},"house_number":{"type":"string","maxLength":50,"uniqueKey":"return_address.house_number","typeLabel":"string"},"city":{"type":"string","maxLength":75,"uniqueKey":"return_address.city","typeLabel":"string"},"postal_code":{"type":"string","maxLength":25,"uniqueKey":"return_address.postal_code","typeLabel":"string"},"state_or_province":{"type":"string","maxLength":75,"uniqueKey":"return_address.state_or_province","typeLabel":"string"},"region":{"type":"string","maxLength":75,"uniqueKey":"return_address.region","typeLabel":"string"},"country":{"type":"string","maxLength":75,"description":"Country name; resolved through a country identifier and stored as the identified name. Provide this or `country_code`.","uniqueKey":"return_address.country","typeLabel":"string"},"country_code":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2. Provide this or `country`.","uniqueKey":"return_address.country_code","typeLabel":"string"},"email":{"type":"string","format":"email","maxLength":100,"description":"Contact email. Not subscribed to notifications.","uniqueKey":"return_address.email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","maxLength":30,"description":"Contact phone, `+` then country calling code and number. Not subscribed to notifications.","uniqueKey":"return_address.phone","typeLabel":"string"},"fax":{"type":"string","maxLength":16,"description":"`+` followed by up to 15 digits.","uniqueKey":"return_address.fax","typeLabel":"string"},"company":{"type":"string","maxLength":150,"uniqueKey":"return_address.company","typeLabel":"string"},"tax_id":{"type":"string","maxLength":100,"uniqueKey":"return_address.tax_id","typeLabel":"string"}},"uniqueKey":"return_address","typeLabel":"object"},"shipment_value":{"type":"string","description":"Money string, e.g. `150 SGD`.","uniqueKey":"shipment_value","typeLabel":"string"},"total_shipping_cost":{"type":"string","description":"Money string. Computed from `shipping_costs` if not provided.","uniqueKey":"total_shipping_cost","typeLabel":"string"},"shipping_costs":{"type":"array","items":{"type":"object","required":["name"],"description":"One shipping cost component. Provide `total_cost` directly, or `unit_cost` + `unit_quantity` to have it calculated. All entries in a request must use the same currency.","properties":{"name":{"type":"string","description":"Name of the cost component.","isRequired":true,"uniqueKey":"shipping_costs.items.[INDEX].name","typeLabel":"string"},"reference":{"type":"string","uniqueKey":"shipping_costs.items.[INDEX].reference","typeLabel":"string"},"unit_quantity":{"type":"number","exclusiveMinimum":0,"uniqueKey":"shipping_costs.items.[INDEX].unit_quantity","typeLabel":"number"},"unit_cost":{"type":"string","description":"Money string, e.g. `2.50 SGD`.","uniqueKey":"shipping_costs.items.[INDEX].unit_cost","typeLabel":"string"},"total_cost":{"type":"string","description":"Money string, e.g. `150 SGD`.","uniqueKey":"shipping_costs.items.[INDEX].total_cost","typeLabel":"string"}},"uniqueKey":"shipping_costs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"shipping_costs","typeLabel":"object[]"},"cod_value":{"type":"string","description":"Money string.","uniqueKey":"cod_value","typeLabel":"string"},"payment_type":{"type":"string","maxLength":75,"uniqueKey":"payment_type","typeLabel":"string"},"length":{"type":"string","description":"Measurement string, e.g. `15 cm`. Stored in cm.","uniqueKey":"length","typeLabel":"string"},"width":{"type":"string","description":"Measurement string. Stored in cm.","uniqueKey":"width","typeLabel":"string"},"height":{"type":"string","description":"Measurement string. Stored in cm.","uniqueKey":"height","typeLabel":"string"},"weight":{"type":"string","description":"Measurement string, e.g. `1.5 kg`.","uniqueKey":"weight","typeLabel":"string"},"item_count":{"type":"integer","minimum":0,"uniqueKey":"item_count","typeLabel":"integer"},"packaging_type":{"type":"string","maxLength":75,"uniqueKey":"packaging_type","typeLabel":"string"},"note":{"type":"string","maxLength":500,"uniqueKey":"note","typeLabel":"string"},"description_of_goods":{"type":"string","maxLength":500,"uniqueKey":"description_of_goods","typeLabel":"string"},"handling_instructions":{"type":"string","maxLength":500,"uniqueKey":"handling_instructions","typeLabel":"string"},"sales_channel":{"type":"string","maxLength":100,"uniqueKey":"sales_channel","typeLabel":"string"},"shipping_service":{"type":"string","maxLength":50,"uniqueKey":"shipping_service","typeLabel":"string"},"expected_delivery_from":{"type":"string","description":"ISO 8601. Start of the expected delivery window.","uniqueKey":"expected_delivery_from","typeLabel":"string"},"expected_delivery_to":{"type":"string","description":"ISO 8601. Requires `expected_delivery_from`.","uniqueKey":"expected_delivery_to","typeLabel":"string"},"events":{"type":"array","items":{"type":"object","description":"One manual event. Provide `description` **or** `standard_key`; if both, `standard_key` wins and `description` is ignored (299 warning). The Shipment must already have a tracking number and an assigned carrier.","properties":{"description":{"type":"string","maxLength":250,"uniqueKey":"events.items.[INDEX].description","typeLabel":"string"},"standard_key":{"type":"string","maxLength":5,"description":"A Perform.AI standard event key. The key list is available from your account team.","uniqueKey":"events.items.[INDEX].standard_key","typeLabel":"string"},"date_time":{"type":"string","description":"ISO 8601. Defaults to the current time (UTC) when omitted.","uniqueKey":"events.items.[INDEX].date_time","typeLabel":"string"},"location":{"type":"object","properties":{"place":{"type":"string","maxLength":250,"description":"Required if `location` is provided.","uniqueKey":"events.items.[INDEX].location.place","typeLabel":"string"}},"uniqueKey":"events.items.[INDEX].location","typeLabel":"object"},"additional_info":{"type":"object","description":"Custom fields. Keys max 50 chars, values max 150.","uniqueKey":"events.items.[INDEX].additional_info","typeLabel":"object"}},"uniqueKey":"events.items.[INDEX]","typeLabel":"object"},"uniqueKey":"events","typeLabel":"object[]"},"linked_shipments":{"type":"array","items":{"type":"object","required":["tracking_number","carrier_reference"],"description":"Another carrier's record of the same physical shipment. Its events are incorporated into the main Shipment.","properties":{"tracking_number":{"type":"string","minLength":6,"maxLength":50,"isRequired":true,"uniqueKey":"linked_shipments.items.[INDEX].tracking_number","typeLabel":"string"},"carrier_reference":{"type":"string","maxLength":50,"description":"Must be configured in **Settings > Carriers**.","isRequired":true,"uniqueKey":"linked_shipments.items.[INDEX].carrier_reference","typeLabel":"string"}},"uniqueKey":"linked_shipments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"linked_shipments","typeLabel":"object[]"},"documents":{"type":"array","items":{"type":"object","required":["document_id","name","type","link"],"description":"A document attached by link. The link must be public, IP-allowlisted, or time-expiring; a document Perform.AI cannot download is not stored.","properties":{"document_id":{"type":"string","maxLength":50,"description":"Your unique ID for the document within the Shipment.","isRequired":true,"uniqueKey":"documents.items.[INDEX].document_id","typeLabel":"string"},"name":{"type":"string","maxLength":50,"isRequired":true,"uniqueKey":"documents.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","maxLength":25,"description":"E.g. invoice, manifest, customs declaration.","isRequired":true,"uniqueKey":"documents.items.[INDEX].type","typeLabel":"string"},"link":{"type":"string","format":"uri","description":"Where Perform.AI downloads the document from.","isRequired":true,"uniqueKey":"documents.items.[INDEX].link","typeLabel":"string\u003curi>"},"file_format":{"type":"string","maxLength":25,"uniqueKey":"documents.items.[INDEX].file_format","typeLabel":"string"},"created_date":{"type":"string","description":"ISO 8601. Defaults to the current time (UTC).","uniqueKey":"documents.items.[INDEX].created_date","typeLabel":"string"},"additional_info":{"type":"object","uniqueKey":"documents.items.[INDEX].additional_info","typeLabel":"object"}},"uniqueKey":"documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"documents","typeLabel":"object[]"},"line_items":{"type":"array","items":{"type":"object","description":"One product line in the Shipment.","properties":{"product_name":{"type":"string","maxLength":500,"uniqueKey":"line_items.items.[INDEX].product_name","typeLabel":"string"},"product_id":{"type":"string","maxLength":50,"uniqueKey":"line_items.items.[INDEX].product_id","typeLabel":"string"},"product_reference":{"type":"string","maxLength":50,"description":"Another reference for the line item, e.g. an SKU.","uniqueKey":"line_items.items.[INDEX].product_reference","typeLabel":"string"},"product_category":{"type":"string","maxLength":500,"uniqueKey":"line_items.items.[INDEX].product_category","typeLabel":"string"},"product_description":{"type":"string","maxLength":500,"uniqueKey":"line_items.items.[INDEX].product_description","typeLabel":"string"},"product_origin_country_code":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country of origin.","uniqueKey":"line_items.items.[INDEX].product_origin_country_code","typeLabel":"string"},"hs_code":{"type":"string","maxLength":20,"description":"Harmonized System code, mainly for customs.","uniqueKey":"line_items.items.[INDEX].hs_code","typeLabel":"string"},"customs_description":{"type":"string","maxLength":500,"uniqueKey":"line_items.items.[INDEX].customs_description","typeLabel":"string"},"quantity":{"type":"integer","minimum":1,"maximum":1000000,"default":1,"uniqueKey":"line_items.items.[INDEX].quantity","typeLabel":"integer"},"product_image_url":{"type":"string","format":"uri","maxLength":1024,"description":"JPG/PNG/GIF up to 5 MB; stored at up to 1 MB and 1024×1024.","uniqueKey":"line_items.items.[INDEX].product_image_url","typeLabel":"string\u003curi>"},"product_url":{"type":"string","format":"uri","maxLength":1024,"uniqueKey":"line_items.items.[INDEX].product_url","typeLabel":"string\u003curi>"},"product_weight":{"type":"number","minimum":0,"description":"Weight of a single unit.","uniqueKey":"line_items.items.[INDEX].product_weight","typeLabel":"number"},"product_weight_unit":{"type":"string","maxLength":5,"uniqueKey":"line_items.items.[INDEX].product_weight_unit","typeLabel":"string"},"line_item_weight":{"type":"number","minimum":0,"uniqueKey":"line_items.items.[INDEX].line_item_weight","typeLabel":"number"},"line_item_weight_unit":{"type":"string","maxLength":5,"uniqueKey":"line_items.items.[INDEX].line_item_weight_unit","typeLabel":"string"},"currency_code":{"type":"string","description":"ISO 4217 currency for the cost fields. Must match across all line items in a Shipment.","uniqueKey":"line_items.items.[INDEX].currency_code","typeLabel":"string"},"product_cost":{"type":"number","minimum":0,"uniqueKey":"line_items.items.[INDEX].product_cost","typeLabel":"number"},"subtotal_cost":{"type":"number","minimum":0,"description":"Before discount and tax.","uniqueKey":"line_items.items.[INDEX].subtotal_cost","typeLabel":"number"},"discount_amount":{"type":"number","minimum":0,"uniqueKey":"line_items.items.[INDEX].discount_amount","typeLabel":"number"},"tax_amount":{"type":"number","minimum":0,"uniqueKey":"line_items.items.[INDEX].tax_amount","typeLabel":"number"},"misc_cost":{"type":"number","minimum":0,"uniqueKey":"line_items.items.[INDEX].misc_cost","typeLabel":"number"},"total_price":{"type":"number","minimum":0,"description":"After discount and tax.","uniqueKey":"line_items.items.[INDEX].total_price","typeLabel":"number"},"return_id":{"type":"string","maxLength":50,"description":"Return this line item belongs to, if any.","uniqueKey":"line_items.items.[INDEX].return_id","typeLabel":"string"},"return_reason":{"type":"string","maxLength":512,"uniqueKey":"line_items.items.[INDEX].return_reason","typeLabel":"string"},"additional_info":{"type":"object","description":"Custom fields. Keys max 50 chars, values max 150.","uniqueKey":"line_items.items.[INDEX].additional_info","typeLabel":"object"}},"uniqueKey":"line_items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"line_items","typeLabel":"object[]"},"additional_info":{"type":"object","description":"Custom fields. Keys max 50 chars, values max 150.","uniqueKey":"additional_info","typeLabel":"object"},"tags_action":{"type":"string","enum":["add","remove","replace"],"default":"add","description":"How the provided `tags` are applied.","uniqueKey":"tags_action","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"example":{"tags":["priority"],"tags_action":"replace"},"examples":{"Example":{"title":"Example","value":{"tags":["priority"],"tags_action":"replace"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"6c7b4f59-2d75-48d5-836e-82b351b2bdbe":{"description":"Shipment updated.","content":{"application/json":{"schema":{"type":"object","description":"Response of Create Shipment and Update Shipment.","properties":{"api_response":{"type":"string","uniqueKey":"api_response","typeLabel":"string"},"data":{"type":"object","properties":{"shipment_uuid":{"type":"string","format":"uuid","uniqueKey":"data.shipment_uuid","typeLabel":"string\u003cuuid>"},"order_uuid":{"oneOf":[{"type":"string","description":"Present when the Shipment is attached to an order.","uniqueKey":"data.order_uuid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when the Shipment is attached to an order.","uniqueKey":"data.order_uuid.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.order_uuid","typeLabel":"string | null"},"documents":{"type":"array","items":{"type":"object","uniqueKey":"data.documents.items.[INDEX]","typeLabel":"object"},"description":"Identifiers of documents stored from the request.","uniqueKey":"data.documents","typeLabel":"object[]"},"created_date":{"type":"string","uniqueKey":"data.created_date","typeLabel":"string"},"updated_date":{"type":"string","description":"Present on Update Shipment responses.","uniqueKey":"data.updated_date","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"api_response":"200","data":{"shipment_uuid":"5b8ed503-20d2-46cf-8675-ce77a059f691","order_uuid":null,"documents":[],"created_date":"2026-09-19T03:26:29+00:00","updated_date":"2026-09-19T03:26:31+00:00"}},"examples":{"Example":{"title":"Example","value":{"api_response":"200","data":{"shipment_uuid":"5b8ed503-20d2-46cf-8675-ce77a059f691","order_uuid":null,"documents":[],"created_date":"2026-09-19T03:26:29+00:00","updated_date":"2026-09-19T03:26:31+00:00"}}}},"exampleType":"examples"}},"exampleType":"examples"},"e1246520-af0e-454a-be7b-0cb2c0be1823":{"description":"Updated with warnings — v5.0 catalogue plus `tags_action was provided without any tags values`.","content":{"application/json":{"schema":{"type":"object","description":"HTTP 299 — the request succeeded, but parts of it could not be applied. The `warnings` object maps each affected field to its messages.","required":["api_response","warnings"],"properties":{"api_response":{"type":"string","description":"Always `\"299\"`.","isRequired":true,"uniqueKey":"api_response","typeLabel":"string"},"warnings":{"type":"object","description":"Affected field → array of warning messages.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"warnings.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"warnings.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"warnings","typeLabel":"object"},"data":{"type":"object","description":"The endpoint's normal success payload, when it has one.","uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"api_response":"\u003cstring>","warnings":{},"data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"6ff37e09-d321-4c01-9fc5-a06d9fe1ca34":{"description":"Field validation failed — v5.0 catalogue plus invalid `tags_action` values and attempts to remove non-existent or system-generated tags.","content":{"application/json":{"schema":{"type":"object","description":"HTTP 400 — one or more fields failed validation; nothing was persisted. For fields inside arrays, errors are keyed by the item's position as a string (\"0\", \"1\", …), then the field name.","required":["api_response","message","errors"],"properties":{"api_response":{"type":"string","description":"Always `\"4030\"`.","isRequired":true,"uniqueKey":"api_response","typeLabel":"string"},"message":{"type":"string","description":"Always `validation_error`.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","description":"Affected field → array of error messages (or a nested object for array items).","isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"api_response":"\u003cstring>","message":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"6f1bad3f-6478-4a5f-acd7-8203fa4a105c":{"description":"The Bearer token is expired, invalid, or missing — or the account lacks access.","content":{"application/json":{"schema":{"type":"object","description":"An error generated at the API gateway — authorization (`403`) or throttling (`429`). Note `api_response` is a number here, unlike application-level responses where it is a string.","required":["api_response","message"],"properties":{"api_response":{"type":"integer","description":"`403` or `429`.","isRequired":true,"uniqueKey":"api_response","typeLabel":"integer"},"message":{"type":"string","description":"E.g. `Key not authorized`, `Quota exceeded`, `Throttled`.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"api_response":403,"message":"Key not authorized"},"examples":{"Example":{"title":"Example","value":{"api_response":403,"message":"Key not authorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"10c1a517-ba92-49dc-abc6-d782d2a19718":{"description":"Rate limit exceeded (40 requests per second per account).","content":{"application/json":{"schema":{"type":"object","description":"An error generated at the API gateway — authorization (`403`) or throttling (`429`). Note `api_response` is a number here, unlike application-level responses where it is a string.","required":["api_response","message"],"properties":{"api_response":{"type":"integer","description":"`403` or `429`.","isRequired":true,"uniqueKey":"api_response","typeLabel":"integer"},"message":{"type":"string","description":"E.g. `Key not authorized`, `Quota exceeded`, `Throttled`.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"api_response":429,"message":"Throttled"},"examples":{"Example":{"title":"Example","value":{"api_response":429,"message":"Throttled"}}},"exampleType":"examples"}},"exampleType":"examples"},"ea3b7ba6-e1db-441f-bdc9-83715584f30f":{"description":"Internal system error.","content":{"application/json":{"schema":{"type":"object","description":"A request-level error such as `4000` (invalid request format), `4041` (no results found), or a `5XX` system error.","required":["api_response","message"],"properties":{"api_response":{"type":"string","description":"Error code as a string, e.g. `\"4000\"`, `\"4041\"`, `\"500\"`.","isRequired":true,"uniqueKey":"api_response","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"api_response":"500","message":"System error"},"examples":{"Example":{"title":"Example","value":{"api_response":"500","message":"System error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"da71927a-e136-48db-9b8c-4103161bbc43":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Used by every functional endpoint. Generate the token with `POST /auth/oauth/token/` and send it as `Authorization: Bearer {token}`.","scopes":[]}}},"servers":{"f98d71a9-ed14-43dc-963b-4c83cdf95b91":{"url":"https://api.perform.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Used by every functional endpoint. Generate the token with `POST /auth/oauth/token/` and send it as `Authorization: Bearer {token}`.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Used by every functional endpoint. Generate the token with `POST /auth/oauth/token/` and send it as `Authorization: Bearer {token}`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"specs/public-api-v5.yaml"},"subdomain":"perform-ai","siteName":"Perform.AI","title":"Update Shipment (v5.2) - Perform.AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-23T08:39:48.734Z","originalFileLocation":"api-reference/v5/shipments/update-shipment-v52.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=\"Same as Update Shipment v5.0, plus the tags_action field controlling how the tags array is applied: - add (default) — appends the provided tags, like v5.0. - remove — removes the provided tags from the Shipment. - replace — replaces the Shipment\u0026#x27;s tags with the provided ones. System-generated tags (SLA, routing, and similar) are preserved. Sending tags_action without any tags values returns a 299 warning.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Perform.AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_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/perform-ai/56l942lZh159TuRd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Shipment (v5.2) - Perform.AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Same as Update Shipment v5.0, plus the tags_action field controlling how the tags array is applied: - add (default) — appends the provided tags, like v5.0. - remove — removes the provided tags from the Shipment. - replace — replaces the Shipment\u0026#x27;s tags with the provided ones. System-generated tags (SLA, routing, and similar) are preserved. Sending tags_action without any tags values returns a 299 warning.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Perform.AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://perform-ai.mintlify.site/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Update+Shipment+%28v5.2%29\u0026amp;description=Same+as+%5BUpdate+Shipment%5D%28%23tag%2FShipments%29+v5.0%2C+plus+the+**%60tags_action%60**%0Afield+controlling+how+the+%60tags%60+array+is+applied%3A%0A%0A-+%60add%60+%28default%29+%E2%80%94+appends+the+p\u0026amp;theme=d25d5a4f8e3daa9a3911e449\u0026amp;signature=8b1f965f961ca16a54d041fc972b6522746e5c77c836cf70ddea1401fa281876\">\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=\"Update Shipment (v5.2) - Perform.AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Same as Update Shipment v5.0, plus the tags_action field controlling how the tags array is applied: - add (default) — appends the provided tags, like v5.0. - remove — removes the provided tags from the Shipment. - replace — replaces the Shipment\u0026#x27;s tags with the provided ones. System-generated tags (SLA, routing, and similar) are preserved. Sending tags_action without any tags values returns a 299 warning.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://perform-ai.mintlify.site/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Update+Shipment+%28v5.2%29\u0026amp;description=Same+as+%5BUpdate+Shipment%5D%28%23tag%2FShipments%29+v5.0%2C+plus+the+**%60tags_action%60**%0Afield+controlling+how+the+%60tags%60+array+is+applied%3A%0A%0A-+%60add%60+%28default%29+%E2%80%94+appends+the+p\u0026amp;theme=d25d5a4f8e3daa9a3911e449\u0026amp;signature=8b1f965f961ca16a54d041fc972b6522746e5c77c836cf70ddea1401fa281876\">\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/perform-ai/56l942lZh159TuRd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Perform.AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6FA900\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"qG96ee4d5MxPcm5ZdG8FzeZe-O1tLDxnuP0lVqGhShs\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v5/shipments/update-shipment-v52.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.perform.ai/#organization\",\"name\":\"Perform.AI\",\"url\":\"https://developers.perform.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/perform-ai/bpZlF368Aqz3so-O/logo/light.svg?fit=max\u0026auto=format\u0026n=bpZlF368Aqz3so-O\u0026q=85\u0026s=ed60084d2cb4ac41f82c70bcd49f9015\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.perform.ai#website\",\"name\":\"Perform.AI\",\"url\":\"https://developers.perform.ai\",\"publisher\":{\"@id\":\"https://developers.perform.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52#webpage\",\"url\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52\",\"name\":\"Update Shipment (v5.2)\",\"description\":\"Same as Update Shipment v5.0, plus the tags_action field controlling how the tags array is applied: - add (default) — appends the provided tags, like v5.0. - remove — removes the provided tags from the Shipment. - replace — replaces the Shipment's tags with the provided ones. System-generated tags (SLA, routing, and similar) are preserved. Sending tags_action without any tags values returns a 299 warning.\",\"dateModified\":\"2026-09-23T08:39:48.734Z\",\"isPartOf\":{\"@id\":\"https://developers.perform.ai#website\"},\"breadcrumb\":{\"@id\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Shipments\",\"item\":\"https://developers.perform.ai/api-reference/v5/shipments/create-shipment\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Shipment (v5.2)\",\"item\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52#apireference\",\"headline\":\"Update Shipment (v5.2)\",\"name\":\"Update Shipment (v5.2)\",\"description\":\"Same as Update Shipment v5.0, plus the tags_action field controlling how the tags array is applied: - add (default) — appends the provided tags, like v5.0. - remove — removes the provided tags from the Shipment. - replace — replaces the Shipment's tags with the provided ones. System-generated tags (SLA, routing, and similar) are preserved. Sending tags_action without any tags values returns a 299 warning.\",\"url\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52\",\"mainEntityOfPage\":{\"@id\":\"https://developers.perform.ai/api-reference/v5/shipments/update-shipment-v52#webpage\"},\"dateModified\":\"2026-09-23T08:39:48.734Z\",\"publisher\":{\"@id\":\"https://developers.perform.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.perform.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Perform.AI\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Perform.AI","nav":{"global":null,"tabs":[{"tab":"Product Documentation","pages":[{"title":"Product Documentation","href":"/products/welcome"}]},{"tab":"Developers","pages":[{"title":"Developers","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference overview","sidebarTitle":"Overview","href":"/api-reference/overview"}]},{"group":"Authentication","pages":[{"title":"Generate Bearer access token","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /auth/oauth/token/","href":"/api-reference/v5/authentication/generate-bearer-access-token"}]},{"group":"Shipments","pages":[{"title":"Create Shipment","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5/shipment/","href":"/api-reference/v5/shipments/create-shipment"},{"title":"Update Shipment","description":"Updates an existing Shipment, identified by the `shipment_uuid` **or**\n`shipment_id` query parameter.\n\n**Replace vs add:** most fields **replace** the stored value entirely —\nincluding the whole `line_items` array, the whole `shipping_costs`\narray, and each address object as a unit. Four fields are **add-only**:\n`tags`, `events`, `linked_shipments`, and `documents` — values you send\nare appended, never removed (use the v5.2 endpoint's `tags_action` to\nremove or replace tags).\n\n**Immutability:** `shipment_id` can be set once on a Shipment created\nwithout one, and never changed after. `tracking_number` and\n`carrier_reference` can be changed only while the Shipment has no track\nevents. A Return Shipment cannot be updated after a successful carrier\nbooking.","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5/shipment/update/","href":"/api-reference/v5/shipments/update-shipment"},{"title":"Update Shipment (v5.2)","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5-2-0/shipment/update/","href":"/api-reference/v5/shipments/update-shipment-v52"},{"title":"List Shipments","description":"Searches your Shipments and returns key information for each match,\nincluding its latest event. Use [Retrieve Shipment Details](#tag/Shipments)\nfor the full record of a single Shipment.\n\n**A date range is required:** provide exactly one of the pairs\n`created_date_*`, `updated_date_*`, or `latest_event_date_*` — both ends\ntogether, `_from` ≤ `_to`, and `_from` at most **13 months** in the past\n(the data retention window). Format `yyyy-mm-ddThh:mm:ss`, processed as\nUTC.\n\n**AND/OR filters:** parameters marked *AND/OR* accept bracket syntax —\n`field=['a','b']` matches both (AND), `field=[['a','b']]` matches either\n(OR), `field=['x',['a','b']]` mixes them. String values must be quoted;\nURL-encode the brackets and quotes if your client requires it.\n\n**Pagination:** cursor-based. `limit` is 25–100 (default 25). Pass the\n`next_page` value from each response into the next request; the first\npage is `next_page=0`. You have reached the last page when the response\nno longer returns a `next_page` value.\n\n**No match:** a valid search with zero results returns **HTTP 404** with\n`api_response` `4041` — not an empty array.","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/shipment/list/","href":"/api-reference/v5/shipments/list-shipments"},{"title":"Retrieve Shipment Details","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/shipment/details/","href":"/api-reference/v5/shipments/retrieve-shipment-details"},{"title":"Retrieve Shipment Details (v5.2)","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5-2-0/shipment/details/","href":"/api-reference/v5/shipments/retrieve-shipment-details-v52"}]},{"group":"Booking","pages":[{"title":"Create Booking","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5/booking/","href":"/api-reference/v5/booking/create-booking"}]},{"group":"Documents","pages":[{"title":"List Documents","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/shipments/documents/","href":"/api-reference/v5/documents/list-documents"},{"title":"Retrieve a Document","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/shipments/documents/{document_uuid}/","href":"/api-reference/v5/documents/retrieve-a-document"},{"title":"List Labels","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/shipments/documents/labels/","href":"/api-reference/v5/documents/list-labels"}]},{"group":"PUDO locations","pages":[{"title":"Retrieve PUDO Locations","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/pudo-locations/","href":"/api-reference/v5/pudo-locations/retrieve-pudo-locations"}]},{"group":"Carrier configurations","pages":[{"title":"Retrieve Carrier Configurations","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml get /v5/carrier-configs/","href":"/api-reference/v5/carrier-configurations/retrieve-carrier-configurations"}]},{"group":"Events","pages":[{"title":"Create Events","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5/events/create/","href":"/api-reference/v5/events/create-events"}]},{"group":"Returns","pages":[{"title":"Create Return","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5/return/","href":"/api-reference/v5/returns/create-return"},{"title":"Update Return","deprecated":null,"version":null,"openapi":"/specs/public-api-v5.yaml post /v5/return/update/","href":"/api-reference/v5/returns/update-return"}]},{"group":"Webhooks","pages":[{"title":"Shipment update (format 5.0)","openapi":"specs/public-api-v5.yaml webhook shipment-update-v5-0","href":"/api-reference/webhooks/shipment-update-v5-0"},{"title":"Shipment update (format 5.2)","openapi":"specs/public-api-v5.yaml webhook shipment-update-v5-2","href":"/api-reference/webhooks/shipment-update-v5-2"},{"title":"Shipment update (format 5.3)","openapi":"specs/public-api-v5.yaml webhook shipment-update-v5-3","href":"/api-reference/webhooks/shipment-update-v5-3"}]},{"group":"Checkout","pages":[{"title":"Predict Checkout EDD","openapi":"specs/checkout-v1.yaml POST /v1/edd/checkout/","href":"/api-reference/checkout/predict-checkout-edd"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Update Shipment (v5.2) - Perform.AI","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-DcUtcwZ_.js","dist-CJ9Oly2E.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-C5EfhVm0.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CxAy5y67.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","AssistantPageLink-Mk6P3qvh.js"]}