Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.
Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the Request-ID response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.
Current persisted shipment data plus evolving lifecycle and results. Responses are reconstructed from the shipment and its relations; there is no copy of the original request. Each shipment has one logical booking. Full event and print histories are retrieved through their own paginated endpoints. A failed document workflow may still have a carrier booking; never blindly rebook such a result. Amounts and measurements include their own currency or unit. Measurements may be normalized when stored, so a response can use kg/cm rather than the input units while retaining the physical quantity. All shipment, parcel and item amounts share one currency; all weights, including dangerous goods, share one unit; all parcel dimensions share one unit. Document dimensions are independent.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Smart Send","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/smartsend/gD6ngks0jD1vt7-p/logo/light.svg?fit=max\u0026auto=format\u0026n=gD6ngks0jD1vt7-p\u0026q=85\u0026s=0497a6140076e33327e53bc8816acd0a","dark":"https://mintcdn.com/smartsend/gD6ngks0jD1vt7-p/logo/dark.svg?fit=max\u0026auto=format\u0026n=gD6ngks0jD1vt7-p\u0026q=85\u0026s=6cba7d8a5a060bc19d62dfbafe721b3f"},"favicon":"https://mintcdn.com/smartsend/CR8KGBMF8mjwYEX7/favicon.svg?fit=max\u0026auto=format\u0026n=CR8KGBMF8mjwYEX7\u0026q=85\u0026s=6f74e0e7460ca009ca020cf9abb8b360","navbar":{"links":[{"href":"https://app.smartsend.io/login","label":"Login"}],"primary":{"type":"button","label":"Register","href":"https://app.smartsend.io/register"}},"footer":{"socials":{"facebook":"https://www.facebook.com/SmartSendio","github":"https://github.com/smartsendio","linkedin":"https://www.linkedin.com/company/3554139"}},"icons":{"library":"fontawesome"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"variables":{"linkAppBase":"https://app.smartsend.io","linkAppRegister":"https://app.smartsend.io/register","linkAppForgotPassword":"https://app.smartsend.io/forgot-password","linkAppDashboard":"https://app.smartsend.io/dashboard","linkAppShipments":"https://app.smartsend.io/team/shipments","linkAppShipmentsCreate":"https://app.smartsend.io/team/shipments/create","linkAppAddressBook":"https://app.smartsend.io/team/addresses","linkAppAddressBookCreate":"https://app.smartsend.io/team/addresses/create","linkAppBilling":"https://app.smartsend.io/billing","linkAppTeamActivities":"https://app.smartsend.io/team/activities","linkAppTeamsCreate":"https://app.smartsend.io/teams/create","linkAppTeamSettingsGeneral":"https://app.smartsend.io/team/settings/general","linkAppTeamSettingsMembers":"https://app.smartsend.io/team/settings/members","linkAppTeamSettingsPreferences":"https://app.smartsend.io/team/settings/preferences","linkAppTeamSettingsSender":"https://app.smartsend.io/team/settings/sender","linkAppTeamSettingsCustoms":"https://app.smartsend.io/team/settings/customs","linkAppTeamSettingsCarriers":"https://app.smartsend.io/team/settings/carriers","linkAppTeamSettingsPrint":"https://app.smartsend.io/team/settings/printing","linkAppTeamSettingsWebhooks":"https://app.smartsend.io/team/settings/webhooks","linkAppUserSettingsProfile":"https://app.smartsend.io/settings/profile","linkAppUserSettingsPassword":"https://app.smartsend.io/settings/password","linkAppUserSettingsSessions":"https://app.smartsend.io/settings/sessions","linkAppUserSettingsPreferences":"https://app.smartsend.io/settings/preferences","linkAppUserSettingsAppearance":"https://app.smartsend.io/settings/appearance","linkAppUserSettingsApi":"https://app.smartsend.io/settings/api","linkAppApiTokens":"https://app.smartsend.io/api-tokens","linkSmartsendPricing":"https://www.smartsend.io/pricing","linkSmartsendStatus":"https://status.smartsend.io","linkSmartsendStatusJson":"https://status.smartsend.io/json","linkSmartsendMcp":"https://mcp.smartsend.io","linkSmartsendClaudePlugin":"https://github.com/smartsendio/claude-plugin","linkSmartsendSkill":"https://github.com/smartsendio/claude-plugin/blob/main/plugins/smartsend/skills/smartsend/SKILL.md","linkClaudeCode":"https://code.claude.com/docs/en/overview","linkClaudeDesktop":"https://claude.com/download","linkClaudeWeb":"https://claude.ai","linkAgentSkills":"https://www.anthropic.com/news/skills","linkModelContextProtocol":"https://modelcontextprotocol.io","linkAgenticCommerceProtocol":"https://www.agenticcommerce.dev/","linkShopifyCheckout":"https://admin.shopify.com/settings/checkout","linkShopifyCheckoutCustomerInfo":"https://admin.shopify.com/settings/checkout#customer-info","linkShopifyCheckoutAdvancedPreferences":"https://admin.shopify.com/settings/checkout#:rh0:","linkShopifyShipping":"https://admin.shopify.com/settings/shipping","linkShopifyShippingCustomizations":"https://admin.shopify.com/settings/shipping#customization-header","linkShopifyDomains":"https://admin.shopify.com/settings/domains","linkShopifyAccount":"https://admin.shopify.com/settings/account","linkShopifyAppSmartSend":"https://apps.shopify.com/smart-send","linkShopifyAppRetailBarcodeLabels":"https://apps.shopify.com/retail-barcode-labels","linkShopifyDocsAddressCollection":"https://help.shopify.com/en/manual/checkout-settings/address-collection-preferences","linkShopifyDocsBarcodes":"https://help.shopify.com/en/manual/fulfillment/setup/packaging/barcodes","linkShopifyDocsRetailBarcodeLabels":"https://help.shopify.com/en/manual/sell-in-person/hardware/barcode-printer/retail-barcode-labels","linkShopifyDocsCollaboratorAccounts":"https://help.shopify.com/en/manual/your-account/users/security/collaborator-accounts#collaborator-codes","linkShopifyDocsShippingRates":"https://help.shopify.com/en/manual/shipping/setting-up-and-managing-your-shipping/setting-up-shipping-rates#create-flat-shipping-rates","linkShopifyDocsCarrierCalculatedShipping":"https://help.shopify.com/en/manual/fulfillment/setup/shipping-rates/third-party-carrier-calculated-shipping","linkShopifyDocsHsCodes":"https://help.shopify.com/en/manual/international/shipping/hs-codes","linkShopifyDocsHsCodesProducts":"https://help.shopify.com/en/manual/products/details/hs-codes","linkShopifyDocsMarkets":"https://help.shopify.com/en/manual/markets","linkShopifyDocsDutiesImportTaxes":"https://help.shopify.com/en/manual/markets/pricing/duties-and-import-taxes","linkShopifyDocsCollectingVatNumbers":"https://help.shopify.com/en/manual/taxes/eu-taxes/collecting-vat-numbers","linkShopifyDocsShopifyTax":"https://help.shopify.com/en/manual/taxes/shopify-tax","linkShopifyDocsVatInvoices":"https://help.shopify.com/en/manual/taxes/tax-overrides/vat-invoices","linkShopifyDocsEuTaxes":"https://help.shopify.com/en/manual/taxes/eu-taxes","linkShopifyDocsReturns":"https://help.shopify.com/en/manual/orders/refund-cancel-order","linkShopifyDocsChargingDuties":"https://help.shopify.com/en/manual/international/duties-and-import-taxes/charging-duties","linkShopifyChangelogTaxValidation":"https://changelog.shopify.com/posts/tax-number-validation-at-checkout","linkShopifyAgenticStorefronts":"https://www.shopify.com/news/winter-26-edition-agentic-storefronts","linkShopifyMagic":"https://www.shopify.com/magic","linkPostnordWebsite":"https://www.postnord.com/","linkPostnordCustomerPortal":"https://portal.postnord.com/","linkPostnordCompanySettings":"https://portal.postnord.com/manage-company-settings/","linkPostnordSignup":"https://www.postnord.dk/erhverv/sadan-bliver-du-erhvervskunde/","linkGlsWebsite":"https://gls-group.eu/","linkGlsAuthenticate":"https://gls-group.com/authenticate","linkBringWebsite":"https://www.bring.com/","linkMybring":"https://www.mybring.com/","linkBringSignup":"https://www.bring.dk/bliv-kunde","linkDaoWebsite":"https://www.dao.as/","linkDaoSignup":"https://dao.as/erhverv-bliv-kunde-hos-dao/","linkBifrostWebsite":"https://bifrostlogistics.com/","linkBifrostContact":"https://bifrostlogistics.com/kontakta-oss/","linkWooShipmentTracking":"https://woocommerce.com/products/shipment-tracking/?aff=4229","linkWooSubscriptions":"https://woocommerce.com/products/woocommerce-subscriptions/?aff=4229","linkWooSequentialOrderNumbers":"https://woocommerce.com/products/sequential-order-numbers-pro/?aff=4229","linkWooMultilingual":"https://wordpress.org/plugins/woocommerce-multilingual/","linkWooTax":"https://woocommerce.com/products/tax/","linkWooCustomsFees":"https://woocommerce.com/products/customs-fees/","linkWooStripeTax":"https://woocommerce.com/products/stripe-tax/","linkWooIntroductionVideoDa":"https://www.youtube.com/embed/EHz8Fp2tOw8","linkWooIntroductionVideoEn":"https://www.youtube.com/embed/I_UK_uYaM7U","linkWooSmartSendPlugin":"https://wordpress.org/plugins/smart-send-logistics/","linkWpCodeSnippets":"https://wordpress.org/plugins/code-snippets/","linkWpChildThemes":"https://developer.wordpress.org/themes/advanced-topics/child-themes/","linkWooSystemStatusReport":"https://woocommerce.com/document/understanding-the-woocommerce-system-status-report/","linkWooAiProductDiscovery":"https://woocommerce.com/posts/ai-product-discovery/","linkWooProductDescriptions":"https://woocommerce.com/posts/seo-product-descriptions/","linkWooAiMarketing":"https://woocommerce.com/posts/ai-marketing/","linkGoogleCloudConsole":"https://console.cloud.google.com/","linkGoogleMapsGetApiKey":"https://developers.google.com/maps/documentation/javascript/get-api-key","linkGoogleMapsBilling":"https://developers.google.com/maps/documentation/javascript/usage-and-billing","linkGoogleMapsErrors":"https://developers.google.com/maps/documentation/javascript/error-messages","linkViesVatValidation":"https://ec.europa.eu/taxation_customs/vies/","linkOpenLabelMaker":"https://openlabelmaker.com/editor/","linkOpenLabelMakerDymo11354":"https://openlabelmaker.com/labels/dymo-11354/","linkZebraDesigner":"https://www.zebra.com/gb/en/software/printer-software/zebradesigner.html","linkZebraLabelMaterialsVideo":"https://www.youtube.com/embed/aUVzl0g9i6U","linkZebraNucleusConnector":"https://www.zebra.com/us/en/support-downloads/software/printer-software/zebra-nucleus-connector.html","linkZebraNucleusConnectorAndroid":"https://play.google.com/store/apps/details?id=com.zebra.atssetuputility","linkZebraNucleusConnectorIos":"https://apps.apple.com/us/app/zebra-nucleus-connector/id6733730721","linkZebraNucleusConnectorDocs":"https://docs.zebra.com/us/en/printers/software/znc-android/","linkZebraPrintQualityAssistant":"https://docs.zebra.com/us/en/printers/software/znc-android/c-xpsu-print-quality/t-xpsu-working-with-the-print-quality-assistant.html","linkZebraZd421PrintQuality":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/print-operations/adjusting-the-print-quality.html","linkZebraZd421Darkness":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/color-touch-display-and-controls/print-menu/print-print-quality-darkness.html","linkZebraZd421Cleaning":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/maintenance/cleaning.html","linkZebraZd421MediaCalibration":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/c-zd620-420-setup/c-zd421-zd621-ug-smartcal-media-calibration.html","linkZebraSetupUtilities":"https://www.zebra.com/gb/en/support-downloads/printer-software/printer-setup-utilities.html","linkZebraGk420dFeedButtonModes":"https://docs.zebra.com/us/en/printers/desktop/gk420d-desktop-printer-user-guide/c-gk420d-ug-troubleshooting/r-gk420d-ug-feed-button-modes.html","linkZebraGk420dManualCalibration":"https://docs.zebra.com/us/en/printers/desktop/gk420d-desktop-printer-user-guide/c-gk420d-ug-troubleshooting/t-gk420d-ug-manual-calibration.html","linkZebraGk420dStatusLight":"https://docs.zebra.com/us/en/printers/desktop/gk420d-desktop-printer-user-guide/c-gk420d-ug-troubleshooting/r-gk420d-ug-status-light-descriptions.html","linkZebraZd421IndicatorLights":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/controls-and-indicators/meaning-of-the-indicator-light-patterns/status-typical-operating-conditions.html","linkZebraZd420IndicatorLights":"https://docs.zebra.com/us/en/printers/desktop/bm-zd620-and-zd420-desktop-printers-user-guide-ditamap/c-zd620-420-controls-and-indicators/r-zd620-420-meaning-of-the-indicator-light-patterns.html","linkZebraGk420dNetworkLabel":"https://docs.zebra.com/us/en/printers/desktop/gk420d-desktop-printer-user-guide/c-gk420d-ug-printer-options/c-gk420d-ug-zebranet-10-100-internal--wired--print-server-option/c-gk420d-ug-printer-network-configuration-status-label.html","linkZebraZd421ConfigurationReport":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/c-zd421-zd621-ug-tools/r-mlk-ug-printer-diagnostics/t-zd620zd420-ug-printing-the-printer-and-network-configuration-reports.html","linkZebraZd421PrintQualityReport":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/c-zd421-zd621-ug-tools/r-mlk-ug-printer-diagnostics/c-zd410d-ug-perform-a-print-quality-report-feed-self-test/t-zd421-zd621-ug-printing-a-print-quality-report.html","linkZebraZd420MediaCalibration":"https://docs.zebra.com/us/en/printers/desktop/bm-zd620-and-zd420-desktop-printers-user-guide-ditamap/c-zd620-420-setup/t-zd620-420-running-a-smartcal-media-calibration.html","linkZebraZd420ConfigurationReport":"https://docs.zebra.com/us/en/printers/desktop/bm-zd620-and-zd420-desktop-printers-user-guide-ditamap/c-zd620-420-tools/c-zd200t-ug-printer-diagnostics/t-zd620zd420-ug-printing-the-printer-and-network-configuration-reports.html","linkZebraZd421PrintheadReplacement":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/maintenance/cleaning/replacing-the-printhead.html","linkZebraZd421NetworkReset":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/tools/printer-diagnostics/resetting-the-printer-s-network-settings-to-their-factory-defaults.html","linkZebraZd420NetworkReset":"https://docs.zebra.com/us/en/printers/desktop/bm-zd620-and-zd420-desktop-printers-user-guide-ditamap/c-zd620-420-tools/c-zd200t-ug-printer-diagnostics/t-zd410d-ug-resetting-network-factory-defaults-pause-cancel-self-test.html","linkZebraZd421PrinterReset":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/c-zd421-zd621-ug-tools/r-mlk-ug-printer-diagnostics/c-resetting-defaults/t-zd620-zd420-ug-resetting-non-network-printer-configuration-settings-to-their-factory-defaults.html","linkZebraZd420PrinterReset":"https://docs.zebra.com/us/en/printers/desktop/bm-zd620-and-zd420-desktop-printers-user-guide-ditamap/c-zd620-420-tools/c-zd200t-ug-printer-diagnostics/t-zd620-zd420-ug-resetting-non-network-printer-configuration-settings-to-their-factory-defaults.html","linkZebraZd421ResetButton":"https://docs.zebra.com/us/en/printers/desktop/zd421-and-zd621-desktop-printers-user-guide/c-zd421-zd621-ug-tools/r-mlk-ug-printer-diagnostics/c-zd421-zd621-ug-reset-button-functions.html","linkZebraZd420ResetButton":"https://docs.zebra.com/us/en/printers/desktop/bm-zd620-and-zd420-desktop-printers-user-guide-ditamap/c-zd620-420-tools/c-zd200t-ug-printer-diagnostics/c-zd620-zd420-ug-reset-button-functions.html","linkGs1BarcodeQuality":"https://gs1.se/en/guides/how-to-guides/barcode-quality/","linkWooShippingZones":"https://woocommerce.com/document/setting-up-shipping-zones/","linkWordPressPhpCodingStandards":"https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/","linkWooPluginSource":"https://github.com/smartsendio/woocommerce/tree/4b5ba30f1d87107ace9eeacf6667ef8f5823bcd1/smart-send-logistics","linkWooShipmentTrackingApi":"https://woocommerce.com/document/shipment-tracking/shipment-tracking-add-tracking-programmatically/","linkWooSubscriptionsHooks":"https://woocommerce.com/document/subscriptions/develop/filter-reference/"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://smartsend.io"}]},"languages":[{"language":"en","default":true,"href":""},{"language":"da","href":"da"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smartsend","hasAudioNarration":false,"actualSubdomain":"smartsend","customDomains":["docs.smartsend.io"],"gitSource":{"type":"github","owner":"smartsendio","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad171d26b807dc20cd57faf","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"en","tag":"API","count":69},{"language":"en","tag":"Documentation","count":53},{"language":"da","tag":"Dokumentation","count":53},{"language":"en","tag":"API v2","count":47},{"language":"en","tag":"Knowledge","count":22},{"language":"da","tag":"Viden","count":22},{"language":"en","tag":"Integrations","count":20},{"language":"da","tag":"Integrationer","count":20},{"language":"en","tag":"Shopify","count":18},{"language":"da","tag":"Shopify","count":18},{"language":"en","tag":"API v1","count":17},{"language":"en","tag":"Carriers","count":15},{"language":"da","tag":"Transportører","count":15},{"language":"en","tag":"Shipments","count":11},{"language":"en","tag":"Troubleshooting","count":11},{"language":"da","tag":"Fejlfinding","count":11},{"language":"da","tag":"WooCommerce","count":10},{"language":"da","tag":"AI","count":8},{"language":"da","tag":"Funktioner","count":8},{"language":"da","tag":"Grundlæggende","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"html[data-current-path=\"/status/incidents\"] [data-component-part=\"update-label\"],html[data-current-path=\"/da/status/incidents\"] [data-component-part=\"update-label\"]{background-color:rgba(115, 115, 115, 0.12)!important;color:rgb(82, 82, 82)!important}html.dark[data-current-path=\"/status/incidents\"] [data-component-part=\"update-label\"],html.dark[data-current-path=\"/da/status/incidents\"] [data-component-part=\"update-label\"]{color:rgb(212, 212, 212)!important}"}],"page":{"pagePath":"api-reference/shipments/get-shipment","slug":"/api-reference/shipments/get-shipment","pageMetadata":{"title":"Get shipment","description":"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/shipments/{shipment}","href":"/api-reference/shipments/get-shipment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.\"\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":"Get shipment","description":"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/shipments/{shipment}","href":"/api-reference/shipments/get-shipment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getShipment","summary":"Get shipment","description":"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.","tags":["Shipments"],"security":["dd554f86-64e5-4a2e-8c08-932ff367eabc","d2c228c4-88dc-4e66-b6a9-a92cad85a408"],"parameters":["7bba0178-4e2c-4aca-974e-5d6fbf25446e","b99f2434-8f20-4dbf-86ce-3af2e92f52b8","f922d03d-5e55-444e-ab5d-948dfe9b308f","b4ec54b6-2fab-4a1c-a638-b4546ae4c620"],"responses":{"200":"7f17cf5b-3d28-40de-a4e6-320f8dfe6599","401":"00f1bafe-d0bb-4d40-82fd-5aa6924edebc","403":"7e8e92be-8579-490a-b581-924c2e7daced","404":"ab94b8e8-f99c-48cb-99a9-22b764e8521d","422":"d65c7046-aeb3-45de-bf1b-dbcf04de68b5","429":"178b704f-483f-4a91-b515-dc04d6015977","500":"04c052c5-cd4c-4163-a03c-d2a937fb77b1","503":"6d6f81b5-9004-4195-8345-66c411099042"},"method":"get","type":"path","servers":["0eef3548-4f3c-4df2-b0fa-31d5d5218725"],"path":"/v2/teams/{teamUuid}/shipments/{shipment}","baseUrlOptions":["https://api.smartsend.io"],"title":"Get shipment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7bba0178-4e2c-4aca-974e-5d6fbf25446e":{"name":"teamUuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Team uuid. All resources are scoped to this team.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Team uuid. All resources are scoped to this team."},"b99f2434-8f20-4dbf-86ce-3af2e92f52b8":{"name":"Accept-Language","in":"header","required":false,"schema":{"type":"string","default":"en","examples":["da-DK, da;q=0.9, en;q=0.8"],"isRequired":false,"description":"Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used.","uniqueKey":"","typeLabel":"string"},"description":"Preferred language(s) for translatable content using BCP 47 language tags. Supports quality values (q-factors) for priority ordering. The API negotiates the best available language based on this header, the team's configured language, and available translations. If omitted, the team's default language is used."},"f922d03d-5e55-444e-ab5d-948dfe9b308f":{"name":"Request-ID","in":"header","required":false,"schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$","isRequired":false,"description":"Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the `Request-ID` response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.","uniqueKey":"","typeLabel":"string"},"description":"Optional client-supplied request identifier. When provided and matching the validation pattern, the value is echoed back in the `Request-ID` response header. Otherwise the server generates one. Use this to correlate requests between client and server when reporting issues.","examples":{"uuid":{"summary":"UUID v7","value":"019c486f-c237-76f5-85e1-ba7017a77024"},"opaque":{"summary":"Opaque client-generated key","value":"booking-12345-at-1768609378"}}},"b4ec54b6-2fab-4a1c-a638-b4546ae4c620":{"name":"shipment","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"UUID of the shipment in this team.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"UUID of the shipment in this team."}},"responses":{"7f17cf5b-3d28-40de-a4e6-320f8dfe6599":{"description":"Current shipment state and results.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}},"Retry-After":{"description":"Delay in seconds before the next polling or retry request. Booking polling normally uses 5.","schema":{"type":"integer","minimum":1,"examples":[5]}},"Cache-Control":{"description":"Shipment, document, tracking and print responses contain private data and expiring URLs.","schema":{"type":"string","const":"private, no-store"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"uuid":{"type":"string","description":"Resource UUID.","format":"uuid","examples":["22222222-2222-4222-8222-222222222222"],"isRequired":true,"uniqueKey":"data.uuid","typeLabel":"string\u003cuuid>"},"state":{"type":"string","enum":["pending","queued","booking","booked","failed","cancelling","cancelled","voided"],"description":"Booking state:\n\n- `pending`: Accepted in an open batch.\n- `queued`: Waiting to start booking.\n- `booking`: The carrier/document/code workflow is running.\n- `booked`: The carrier has accepted the booking and all required documents/codes are ready.\n- `failed`: The workflow failed or reached its final deadline.\n- `cancelling`: Cancellation is running.\n- `cancelled`: Cancelled internally without confirmed carrier cancellation; also used for unstarted batch members stopped before booking.\n- `voided`: Cancelled internally and confirmed cancelled by the carrier.\n\nA rare late success may change `failed` to `booked` or `cancelled` to `voided`. Delivery status belongs to tracking.","isRequired":true,"uniqueKey":"data.state","typeLabel":"enum\u003cstring>"},"invoice_number":{"oneOf":[{"type":"null","description":"Customs invoice number when applicable. Use reference for the public order reference.","examples":["INV-1001121"],"isRequired":true,"uniqueKey":"data.invoice_number.oneOf.0","typeLabel":"null"},{"type":"string","description":"Customs invoice number when applicable. Use reference for the public order reference.","examples":["INV-1001121"],"isRequired":true,"uniqueKey":"data.invoice_number.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.invoice_number","typeLabel":"null | string"},"reference":{"oneOf":[{"type":"null","description":"Public reference, e.g. order number or SKU, which may be forwarded to the carrier or printed. Not necessarily unique.","examples":["Order-5521"],"isRequired":true,"uniqueKey":"data.reference.oneOf.0","typeLabel":"null"},{"type":"string","description":"Public reference, e.g. order number or SKU, which may be forwarded to the carrier or printed. Not necessarily unique.","examples":["Order-5521"],"isRequired":true,"uniqueKey":"data.reference.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.reference","typeLabel":"null | string"},"identifier":{"oneOf":[{"type":"null","description":"Private integration reference, e.g. a database ID. Not used for deduplication and not forwarded to carrier labels. Not necessarily unique.","examples":["shop-order-1042"],"isRequired":true,"uniqueKey":"data.identifier.oneOf.0","typeLabel":"null"},{"type":"string","description":"Private integration reference, e.g. a database ID. Not used for deduplication and not forwarded to carrier labels. Not necessarily unique.","examples":["shop-order-1042"],"isRequired":true,"uniqueKey":"data.identifier.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.identifier","typeLabel":"null | string"},"uri":{"oneOf":[{"type":"null","format":"uri","description":"URI linking to the source of this shipment (webshop order URL, deep link, or any URI scheme)","examples":["https://shop.example.com/admin/orders/1042"],"isRequired":true,"uniqueKey":"data.uri.oneOf.0","typeLabel":"null"},{"type":"string","format":"uri","description":"URI linking to the source of this shipment (webshop order URL, deep link, or any URI scheme)","examples":["https://shop.example.com/admin/orders/1042"],"isRequired":true,"uniqueKey":"data.uri.oneOf.1","typeLabel":"string\u003curi>"}],"isRequired":true,"uniqueKey":"data.uri","typeLabel":"null | string\u003curi>"},"delivery":{"type":"object","properties":{"carrier":{"type":"object","properties":{"code":{"type":"string","description":"Carrier code.","examples":["postnord"],"isRequired":true,"uniqueKey":"data.delivery.carrier.code","typeLabel":"string"},"name":{"type":"string","description":"Carrier display name.","examples":["PostNord"],"isRequired":true,"uniqueKey":"data.delivery.carrier.name","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","format":"uri","examples":["https://assets.example.com/carriers/postnord/logo.svg"],"isRequired":true,"uniqueKey":"data.delivery.carrier.logo_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","examples":["https://assets.example.com/carriers/postnord/logo.svg"],"isRequired":true,"uniqueKey":"data.delivery.carrier.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.carrier.logo_url","typeLabel":"string\u003curi> | null"},"icon_url":{"oneOf":[{"type":"string","format":"uri","examples":["https://assets.example.com/carriers/postnord/icon.svg"],"isRequired":true,"uniqueKey":"data.delivery.carrier.icon_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","examples":["https://assets.example.com/carriers/postnord/icon.svg"],"isRequired":true,"uniqueKey":"data.delivery.carrier.icon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.carrier.icon_url","typeLabel":"string\u003curi> | null"}},"required":["code","name","logo_url","icon_url"],"description":"Carrier whose service and account are used for booking. Its code identifies the carrier part of service_code.","isRequired":true,"uniqueKey":"data.delivery.carrier","typeLabel":"object"},"last_mile_carrier":{"oneOf":[{"type":"object","description":"Expected final delivery partner from the selected shipping route. Null means unknown. If carrier also performs final delivery, return the same carrier identity here explicitly. For returns, final delivery is to the merchant. This field does not identify the tracking provider or the return drop-off network. The expected partner is snapshotted at shipment acceptance; later route changes do not alter it.","required":["code","name","logo_url","icon_url"],"properties":{"code":{"type":"string","description":"Carrier code.","examples":["postnord"],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.code","typeLabel":"string"},"name":{"type":"string","description":"Carrier display name.","examples":["PostNord"],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.name","typeLabel":"string"},"logo_url":{"oneOf":[{"type":"string","format":"uri","examples":["https://assets.example.com/carriers/postnord/logo.svg"],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.logo_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","examples":["https://assets.example.com/carriers/postnord/logo.svg"],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.logo_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.logo_url","typeLabel":"string\u003curi> | null"},"icon_url":{"oneOf":[{"type":"string","format":"uri","examples":["https://assets.example.com/carriers/postnord/icon.svg"],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.icon_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","examples":["https://assets.example.com/carriers/postnord/icon.svg"],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.icon_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0.icon_url","typeLabel":"string\u003curi> | null"}},"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.0","typeLabel":"object"},{"type":"null","description":"Expected final delivery partner from the selected shipping route. Null means unknown. If carrier also performs final delivery, return the same carrier identity here explicitly. For returns, final delivery is to the merchant. This field does not identify the tracking provider or the return drop-off network. The expected partner is snapshotted at shipment acceptance; later route changes do not alter it.","isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.last_mile_carrier","typeLabel":"object | null"},"service_code":{"type":"string","description":"Full service code (carrier.code + '_' + service suffix). It remains tied to the booking carrier, including when another carrier performs final delivery.","examples":["postnord_agent"],"isRequired":true,"uniqueKey":"data.delivery.service_code","typeLabel":"string"},"service_name":{"type":"string","description":"Localized human-readable service name","examples":["Pickup Point"],"isRequired":true,"uniqueKey":"data.delivery.service_name","typeLabel":"string"},"is_pickup":{"type":"boolean","description":"Whether this service delivers to pickup points","examples":[true],"isRequired":true,"uniqueKey":"data.delivery.is_pickup","typeLabel":"boolean"},"is_return":{"type":"boolean","description":"Whether this is a return service","examples":[false],"isRequired":true,"uniqueKey":"data.delivery.is_return","typeLabel":"boolean"},"addons":{"type":"array","items":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string","description":"Addon code (SCREAMING_SNAKE_CASE)","examples":["SIGNATURE"],"isRequired":true,"uniqueKey":"data.delivery.addons.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","description":"Localized human-readable addon name","readOnly":true,"examples":["Signature"],"isRequired":true,"uniqueKey":"data.delivery.addons.items.[INDEX].name","typeLabel":"string"}},"uniqueKey":"data.delivery.addons.items.[INDEX]","typeLabel":"object"},"description":"Effective selected addons, including their display names.","isRequired":true,"uniqueKey":"data.delivery.addons","typeLabel":"object[]"},"pickup_point":{"oneOf":[{"type":"null","description":"Selected pickup point, or null when none is selected or applicable. An empty object is not a valid pickup point.","example":{"uuid":"99999999-9999-4999-8999-999999999999","code":"12345","name":"Example Parcel Shop","address":{"address_lines":["Eksempelvej 20"],"postal_code":"8000","city":"Aarhus C","country":"DK","administrative_area":"82"}},"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.0","typeLabel":"null"},{"type":"object","description":"Selected pickup point, or null when none is selected or applicable. An empty object is not a valid pickup point.","required":["uuid","code","name","address"],"example":{"uuid":"99999999-9999-4999-8999-999999999999","code":"12345","name":"Example Parcel Shop","address":{"address_lines":["Eksempelvej 20"],"postal_code":"8000","city":"Aarhus C","country":"DK","administrative_area":"82"}},"properties":{"uuid":{"type":"string","description":"Resource UUID.","format":"uuid","examples":["99999999-9999-4999-8999-999999999999"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.uuid","typeLabel":"string\u003cuuid>"},"code":{"type":"string","description":"Carrier service-point code.","examples":["12345"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.code","typeLabel":"string"},"name":{"type":"string","description":"Display name.","examples":["Example Parcel Shop"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.name","typeLabel":"string"},"address":{"type":"object","required":["address_lines","postal_code","city","country","administrative_area"],"properties":{"address_lines":{"oneOf":[{"type":"null","items":{"type":"string"},"maxItems":3,"description":"Street address lines (e.g., street name, building, floor)","examples":[["3200 Whitehaven St. NW","Building A, Floor 2"]],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.address_lines.oneOf.0","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"data.delivery.pickup_point.oneOf.1.address.address_lines.oneOf.1.items.[INDEX]","typeLabel":"string"},"maxItems":3,"description":"Street address lines (e.g., street name, building, floor)","examples":[["3200 Whitehaven St. NW","Building A, Floor 2"]],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.address_lines.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.address_lines","typeLabel":"null | string[]"},"postal_code":{"oneOf":[{"type":"null","description":"Postal/ZIP code. Always a string, even when the value is purely numeric.","examples":["20008-4351"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.postal_code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Postal/ZIP code. Always a string, even when the value is purely numeric.","examples":["20008-4351"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.postal_code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.postal_code","typeLabel":"null | string"},"city":{"type":"string","description":"City","examples":["Washington"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.city","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country code","examples":["US"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.country","typeLabel":"string"},"administrative_area":{"oneOf":[{"type":"null","minLength":2,"maxLength":3,"description":"The sub-national subdivision code (e.g., state, province, or department) representing the suffix part of the ISO 3166-2 standard. This field should contain only the characters following the hyphen. For example, for 'US-NY', provide 'NY'; for 'JP-13', provide '13'","examples":["DC"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.administrative_area.oneOf.0","typeLabel":"null"},{"type":"string","minLength":2,"maxLength":3,"description":"The sub-national subdivision code (e.g., state, province, or department) representing the suffix part of the ISO 3166-2 standard. This field should contain only the characters following the hyphen. For example, for 'US-NY', provide 'NY'; for 'JP-13', provide '13'","examples":["DC"],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.administrative_area.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address.administrative_area","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1.address","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.delivery.pickup_point.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.delivery.pickup_point","typeLabel":"null | object"},"delivery_window":{"oneOf":[{"type":"object","description":"A bounded time window with earliest \u003c= latest. Its owning field identifies whether it is an estimate or a requested delivery choice.","required":["earliest","latest"],"properties":{"earliest":{"type":"string","format":"date-time","description":"Inclusive beginning of the window (RFC 3339).","examples":["2025-01-02T00:00:00Z"],"isRequired":true,"uniqueKey":"data.delivery.delivery_window.oneOf.0.earliest","typeLabel":"string\u003cdate-time>"},"latest":{"type":"string","format":"date-time","description":"Inclusive end of the window (RFC 3339).","examples":["2025-01-04T23:59:59Z"],"isRequired":true,"uniqueKey":"data.delivery.delivery_window.oneOf.0.latest","typeLabel":"string\u003cdate-time>"}},"isRequired":true,"uniqueKey":"data.delivery.delivery_window.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"data.delivery.delivery_window.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.delivery_window","typeLabel":"object | null"},"incoterm":{"oneOf":[{"type":"string","description":"International Commercial Terms for trade","enum":["EXW","FCA","CPT","CIP","DAP","DPU","DDP"],"example":"DAP","isRequired":true,"uniqueKey":"data.delivery.incoterm.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"DAP","isRequired":true,"uniqueKey":"data.delivery.incoterm.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.delivery.incoterm","typeLabel":"enum\u003cstring> | null"}},"required":["carrier","last_mile_carrier","service_code","service_name","is_pickup","is_return","addons","pickup_point","delivery_window","incoterm"],"description":"Resolved delivery input with the booking carrier, expected last-mile partner, service and addon names. Required booking choices and expected carrier identities are frozen at acceptance.","isRequired":true,"uniqueKey":"data.delivery","typeLabel":"object"},"parties":{"type":"object","properties":{"merchant":{"type":"object","required":["reference","identifier","uri","address","contact","identifiers"],"description":"Merchant (webshop) party details. Direction-stable: the merchant is always the merchant, also on return shipments where they receive the parcel. Optional in requests — when omitted it is resolved from team settings: the default sender address for outbound shipments, or the team's return address for return shipments (falling back to the default sender address when not configured).","properties":{"reference":{"oneOf":[{"type":"null","description":"Human-readable reference visible externally","examples":["SHOP-DK"],"isRequired":true,"uniqueKey":"data.parties.merchant.reference.oneOf.0","typeLabel":"null"},{"type":"string","description":"Human-readable reference visible externally","examples":["SHOP-DK"],"isRequired":true,"uniqueKey":"data.parties.merchant.reference.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.reference","typeLabel":"null | string"},"identifier":{"oneOf":[{"type":"null","description":"System identifier for internal integrations","examples":["shop-1"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifier.oneOf.0","typeLabel":"null"},{"type":"string","description":"System identifier for internal integrations","examples":["shop-1"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifier.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifier","typeLabel":"null | string"},"uri":{"oneOf":[{"type":"null","format":"uri","description":"URI linking to this party (URL, deep link, or any URI scheme)","examples":["https://shop.example.com"],"isRequired":true,"uniqueKey":"data.parties.merchant.uri.oneOf.0","typeLabel":"null"},{"type":"string","format":"uri","description":"URI linking to this party (URL, deep link, or any URI scheme)","examples":["https://shop.example.com"],"isRequired":true,"uniqueKey":"data.parties.merchant.uri.oneOf.1","typeLabel":"string\u003curi>"}],"isRequired":true,"uniqueKey":"data.parties.merchant.uri","typeLabel":"null | string\u003curi>"},"address":{"type":"object","required":["address_lines","postal_code","city","country","administrative_area"],"properties":{"address_lines":{"oneOf":[{"type":"null","items":{"type":"string"},"maxItems":3,"description":"Street address lines (e.g., street name, building, floor)","examples":[["3200 Whitehaven St. NW","Building A, Floor 2"]],"isRequired":true,"uniqueKey":"data.parties.merchant.address.address_lines.oneOf.0","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"data.parties.merchant.address.address_lines.oneOf.1.items.[INDEX]","typeLabel":"string"},"maxItems":3,"description":"Street address lines (e.g., street name, building, floor)","examples":[["3200 Whitehaven St. NW","Building A, Floor 2"]],"isRequired":true,"uniqueKey":"data.parties.merchant.address.address_lines.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"data.parties.merchant.address.address_lines","typeLabel":"null | string[]"},"postal_code":{"oneOf":[{"type":"null","description":"Postal/ZIP code. Always a string, even when the value is purely numeric.","examples":["20008-4351"],"isRequired":true,"uniqueKey":"data.parties.merchant.address.postal_code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Postal/ZIP code. Always a string, even when the value is purely numeric.","examples":["20008-4351"],"isRequired":true,"uniqueKey":"data.parties.merchant.address.postal_code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.address.postal_code","typeLabel":"null | string"},"city":{"type":"string","description":"City","examples":["Washington"],"isRequired":true,"uniqueKey":"data.parties.merchant.address.city","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country code","examples":["US"],"isRequired":true,"uniqueKey":"data.parties.merchant.address.country","typeLabel":"string"},"administrative_area":{"oneOf":[{"type":"null","minLength":2,"maxLength":3,"description":"The sub-national subdivision code (e.g., state, province, or department) representing the suffix part of the ISO 3166-2 standard. This field should contain only the characters following the hyphen. For example, for 'US-NY', provide 'NY'; for 'JP-13', provide '13'","examples":["DC"],"isRequired":true,"uniqueKey":"data.parties.merchant.address.administrative_area.oneOf.0","typeLabel":"null"},{"type":"string","minLength":2,"maxLength":3,"description":"The sub-national subdivision code (e.g., state, province, or department) representing the suffix part of the ISO 3166-2 standard. This field should contain only the characters following the hyphen. For example, for 'US-NY', provide 'NY'; for 'JP-13', provide '13'","examples":["DC"],"isRequired":true,"uniqueKey":"data.parties.merchant.address.administrative_area.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.address.administrative_area","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.parties.merchant.address","typeLabel":"object"},"contact":{"type":"object","required":["name_lines","company","email","phone"],"description":"Contact information for a party","properties":{"name_lines":{"type":"array","items":{"type":"string","uniqueKey":"data.parties.merchant.contact.name_lines.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":2,"description":"Name lines (e.g., person name, company name, department)","examples":[["John Doe","Att. Finance department"]],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.name_lines","typeLabel":"string[]"},"company":{"oneOf":[{"type":"null","description":"Company or organization name","examples":["Acme Corp"],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.company.oneOf.0","typeLabel":"null"},{"type":"string","description":"Company or organization name","examples":["Acme Corp"],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.company.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.company","typeLabel":"null | string"},"email":{"oneOf":[{"type":"null","format":"email","description":"Email address","examples":["john@example.com"],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.email.oneOf.0","typeLabel":"null"},{"type":"string","format":"email","description":"Email address","examples":["john@example.com"],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.email.oneOf.1","typeLabel":"string\u003cemail>"}],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.email","typeLabel":"null | string\u003cemail>"},"phone":{"oneOf":[{"type":"null","description":"Phone number with country code","examples":["+4512345678"],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.phone.oneOf.0","typeLabel":"null"},{"type":"string","description":"Phone number with country code","examples":["+4512345678"],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.phone.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.contact.phone","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.parties.merchant.contact","typeLabel":"object"},"identifiers":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.0","typeLabel":"null"},{"type":"object","description":"Tax and trade identifiers for customs clearance","required":["vat","eori","gb_eori","tax_id","voec"],"properties":{"vat":{"oneOf":[{"type":"null","description":"VAT identification number","examples":["DK12345678"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.vat.oneOf.0","typeLabel":"null"},{"type":"string","description":"VAT identification number","examples":["DK12345678"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.vat.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.vat","typeLabel":"null | string"},"eori":{"oneOf":[{"type":"null","description":"Economic Operators Registration and Identification number (EU)","examples":["DK1234567890123"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.eori.oneOf.0","typeLabel":"null"},{"type":"string","description":"Economic Operators Registration and Identification number (EU)","examples":["DK1234567890123"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.eori.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.eori","typeLabel":"null | string"},"gb_eori":{"oneOf":[{"type":"null","description":"GB EORI number for UK customs","examples":["GB123456789000"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.gb_eori.oneOf.0","typeLabel":"null"},{"type":"string","description":"GB EORI number for UK customs","examples":["GB123456789000"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.gb_eori.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.gb_eori","typeLabel":"null | string"},"tax_id":{"oneOf":[{"type":"null","description":"Tax identification number","examples":["DK1234567890"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.tax_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"Tax identification number","examples":["DK1234567890"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.tax_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.tax_id","typeLabel":"null | string"},"voec":{"oneOf":[{"type":"null","description":"VOEC (VAT on E-Commerce) number for Norway","examples":["2000123"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.voec.oneOf.0","typeLabel":"null"},{"type":"string","description":"VOEC (VAT on E-Commerce) number for Norway","examples":["2000123"],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.voec.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1.voec","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parties.merchant.identifiers","typeLabel":"null | object"}},"isRequired":true,"uniqueKey":"data.parties.merchant","typeLabel":"object"},"customer":{"type":"object","required":["reference","identifier","uri","address","contact","identifiers"],"description":"Customer (consumer) party details. Direction-stable: the customer is always the customer, also on return shipments where they dispatch the parcel.","properties":{"reference":{"oneOf":[{"type":"null","description":"Human-readable reference visible to the customer","examples":["CUSTOMER-2048"],"isRequired":true,"uniqueKey":"data.parties.customer.reference.oneOf.0","typeLabel":"null"},{"type":"string","description":"Human-readable reference visible to the customer","examples":["CUSTOMER-2048"],"isRequired":true,"uniqueKey":"data.parties.customer.reference.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.reference","typeLabel":"null | string"},"identifier":{"oneOf":[{"type":"null","description":"System identifier for internal integrations","examples":["customer-2048"],"isRequired":true,"uniqueKey":"data.parties.customer.identifier.oneOf.0","typeLabel":"null"},{"type":"string","description":"System identifier for internal integrations","examples":["customer-2048"],"isRequired":true,"uniqueKey":"data.parties.customer.identifier.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifier","typeLabel":"null | string"},"uri":{"oneOf":[{"type":"null","format":"uri","description":"URI linking to this party (URL, deep link, or any URI scheme)","examples":["https://shop.example.com/admin/customers/2048"],"isRequired":true,"uniqueKey":"data.parties.customer.uri.oneOf.0","typeLabel":"null"},{"type":"string","format":"uri","description":"URI linking to this party (URL, deep link, or any URI scheme)","examples":["https://shop.example.com/admin/customers/2048"],"isRequired":true,"uniqueKey":"data.parties.customer.uri.oneOf.1","typeLabel":"string\u003curi>"}],"isRequired":true,"uniqueKey":"data.parties.customer.uri","typeLabel":"null | string\u003curi>"},"address":{"type":"object","required":["address_lines","postal_code","city","country","administrative_area"],"properties":{"address_lines":{"oneOf":[{"type":"null","items":{"type":"string"},"maxItems":3,"description":"Street address lines (e.g., street name, building, floor)","examples":[["3200 Whitehaven St. NW","Building A, Floor 2"]],"isRequired":true,"uniqueKey":"data.parties.customer.address.address_lines.oneOf.0","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"data.parties.customer.address.address_lines.oneOf.1.items.[INDEX]","typeLabel":"string"},"maxItems":3,"description":"Street address lines (e.g., street name, building, floor)","examples":[["3200 Whitehaven St. NW","Building A, Floor 2"]],"isRequired":true,"uniqueKey":"data.parties.customer.address.address_lines.oneOf.1","typeLabel":"string[]"}],"isRequired":true,"uniqueKey":"data.parties.customer.address.address_lines","typeLabel":"null | string[]"},"postal_code":{"oneOf":[{"type":"null","description":"Postal/ZIP code. Always a string, even when the value is purely numeric.","examples":["20008-4351"],"isRequired":true,"uniqueKey":"data.parties.customer.address.postal_code.oneOf.0","typeLabel":"null"},{"type":"string","description":"Postal/ZIP code. Always a string, even when the value is purely numeric.","examples":["20008-4351"],"isRequired":true,"uniqueKey":"data.parties.customer.address.postal_code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.address.postal_code","typeLabel":"null | string"},"city":{"type":"string","description":"City","examples":["Washington"],"isRequired":true,"uniqueKey":"data.parties.customer.address.city","typeLabel":"string"},"country":{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country code","examples":["US"],"isRequired":true,"uniqueKey":"data.parties.customer.address.country","typeLabel":"string"},"administrative_area":{"oneOf":[{"type":"null","minLength":2,"maxLength":3,"description":"The sub-national subdivision code (e.g., state, province, or department) representing the suffix part of the ISO 3166-2 standard. This field should contain only the characters following the hyphen. For example, for 'US-NY', provide 'NY'; for 'JP-13', provide '13'","examples":["DC"],"isRequired":true,"uniqueKey":"data.parties.customer.address.administrative_area.oneOf.0","typeLabel":"null"},{"type":"string","minLength":2,"maxLength":3,"description":"The sub-national subdivision code (e.g., state, province, or department) representing the suffix part of the ISO 3166-2 standard. This field should contain only the characters following the hyphen. For example, for 'US-NY', provide 'NY'; for 'JP-13', provide '13'","examples":["DC"],"isRequired":true,"uniqueKey":"data.parties.customer.address.administrative_area.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.address.administrative_area","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.parties.customer.address","typeLabel":"object"},"contact":{"type":"object","required":["name_lines","company","email","phone"],"description":"Contact information for a party","properties":{"name_lines":{"type":"array","items":{"type":"string","uniqueKey":"data.parties.customer.contact.name_lines.items.[INDEX]","typeLabel":"string"},"minItems":1,"maxItems":2,"description":"Name lines (e.g., person name, company name, department)","examples":[["John Doe","Att. Finance department"]],"isRequired":true,"uniqueKey":"data.parties.customer.contact.name_lines","typeLabel":"string[]"},"company":{"oneOf":[{"type":"null","description":"Company or organization name","examples":["Acme Corp"],"isRequired":true,"uniqueKey":"data.parties.customer.contact.company.oneOf.0","typeLabel":"null"},{"type":"string","description":"Company or organization name","examples":["Acme Corp"],"isRequired":true,"uniqueKey":"data.parties.customer.contact.company.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.contact.company","typeLabel":"null | string"},"email":{"oneOf":[{"type":"null","format":"email","description":"Email address","examples":["john@example.com"],"isRequired":true,"uniqueKey":"data.parties.customer.contact.email.oneOf.0","typeLabel":"null"},{"type":"string","format":"email","description":"Email address","examples":["john@example.com"],"isRequired":true,"uniqueKey":"data.parties.customer.contact.email.oneOf.1","typeLabel":"string\u003cemail>"}],"isRequired":true,"uniqueKey":"data.parties.customer.contact.email","typeLabel":"null | string\u003cemail>"},"phone":{"oneOf":[{"type":"null","description":"Phone number with country code","examples":["+4512345678"],"isRequired":true,"uniqueKey":"data.parties.customer.contact.phone.oneOf.0","typeLabel":"null"},{"type":"string","description":"Phone number with country code","examples":["+4512345678"],"isRequired":true,"uniqueKey":"data.parties.customer.contact.phone.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.contact.phone","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.parties.customer.contact","typeLabel":"object"},"identifiers":{"oneOf":[{"type":"null","isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.0","typeLabel":"null"},{"type":"object","description":"Tax and trade identifiers for customs clearance","required":["vat","eori","gb_eori","tax_id","voec"],"properties":{"vat":{"oneOf":[{"type":"null","description":"VAT identification number","examples":["DK12345678"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.vat.oneOf.0","typeLabel":"null"},{"type":"string","description":"VAT identification number","examples":["DK12345678"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.vat.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.vat","typeLabel":"null | string"},"eori":{"oneOf":[{"type":"null","description":"Economic Operators Registration and Identification number (EU)","examples":["DK1234567890123"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.eori.oneOf.0","typeLabel":"null"},{"type":"string","description":"Economic Operators Registration and Identification number (EU)","examples":["DK1234567890123"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.eori.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.eori","typeLabel":"null | string"},"gb_eori":{"oneOf":[{"type":"null","description":"GB EORI number for UK customs","examples":["GB123456789000"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.gb_eori.oneOf.0","typeLabel":"null"},{"type":"string","description":"GB EORI number for UK customs","examples":["GB123456789000"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.gb_eori.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.gb_eori","typeLabel":"null | string"},"tax_id":{"oneOf":[{"type":"null","description":"Tax identification number","examples":["DK1234567890"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.tax_id.oneOf.0","typeLabel":"null"},{"type":"string","description":"Tax identification number","examples":["DK1234567890"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.tax_id.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.tax_id","typeLabel":"null | string"},"voec":{"oneOf":[{"type":"null","description":"VOEC (VAT on E-Commerce) number for Norway","examples":["2000123"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.voec.oneOf.0","typeLabel":"null"},{"type":"string","description":"VOEC (VAT on E-Commerce) number for Norway","examples":["2000123"],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.voec.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1.voec","typeLabel":"null | string"}},"isRequired":true,"uniqueKey":"data.parties.customer.identifiers.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parties.customer.identifiers","typeLabel":"null | object"}},"isRequired":true,"uniqueKey":"data.parties.customer","typeLabel":"object"}},"required":["merchant","customer"],"description":"Resolved, direction-stable parties snapshotted at acceptance.","isRequired":true,"uniqueKey":"data.parties","typeLabel":"object"},"parcels":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"string","description":"Stable parcel UUID.","format":"uuid","examples":["33333333-3333-4333-8333-333333333333"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].uuid","typeLabel":"string\u003cuuid>"},"reference":{"oneOf":[{"type":"null","description":"Public reference, e.g. order number or SKU, which may be forwarded to the carrier or printed. Not necessarily unique.","examples":["ORDER-1042-1"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].reference.oneOf.0","typeLabel":"null"},{"type":"string","description":"Public reference, e.g. order number or SKU, which may be forwarded to the carrier or printed. Not necessarily unique.","examples":["ORDER-1042-1"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].reference.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].reference","typeLabel":"null | string"},"identifier":{"oneOf":[{"type":"null","description":"Private integration reference, e.g. a database ID. Not used for deduplication and not forwarded to carrier labels. Not necessarily unique.","examples":["shop-parcel-1"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].identifier.oneOf.0","typeLabel":"null"},{"type":"string","description":"Private integration reference, e.g. a database ID. Not used for deduplication and not forwarded to carrier labels. Not necessarily unique.","examples":["shop-parcel-1"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].identifier.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].identifier","typeLabel":"null | string"},"freetext":{"oneOf":[{"type":"null","description":"Description or notes for the parcel","examples":["Gift wrapped as per requested"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].freetext.oneOf.0","typeLabel":"null"},{"type":"string","description":"Description or notes for the parcel","examples":["Gift wrapped as per requested"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].freetext.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].freetext","typeLabel":"null | string"},"gross_weight":{"oneOf":[{"type":"null","description":"Weight of the parcel including packaging and contents.","example":{"value":1500,"unit":"g"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].gross_weight.oneOf.0","typeLabel":"null"},{"type":"object","description":"Weight of the parcel including packaging and contents.","required":["value","unit"],"example":{"value":1500,"unit":"g"},"properties":{"value":{"type":"number","minimum":0,"description":"Weight in the specified unit.","examples":[1500],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].gross_weight.oneOf.1.value","typeLabel":"number"},"unit":{"type":"string","description":"Unit of measurement for weight","enum":["g","kg","lb","oz"],"examples":["g"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].gross_weight.oneOf.1.unit","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].gross_weight.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].gross_weight","typeLabel":"null | object"},"length":{"oneOf":[{"type":"null","description":"Parcel length.","example":{"value":30,"unit":"cm"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].length.oneOf.0","typeLabel":"null"},{"type":"object","description":"Parcel length.","required":["value","unit"],"example":{"value":30,"unit":"cm"},"properties":{"value":{"type":"number","minimum":0,"description":"Length or distance in the specified unit.","examples":[123.4],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].length.oneOf.1.value","typeLabel":"number"},"unit":{"type":"string","description":"Unit of the value. Service-point distances use metres; document dimensions and printer paper sizes use millimetres, independently of parcel dimensions.","enum":["mm","cm","m","in"],"examples":["cm"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].length.oneOf.1.unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].length.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].length","typeLabel":"null | object"},"width":{"oneOf":[{"type":"null","description":"Parcel width.","example":{"value":20,"unit":"cm"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].width.oneOf.0","typeLabel":"null"},{"type":"object","description":"Parcel width.","required":["value","unit"],"example":{"value":20,"unit":"cm"},"properties":{"value":{"type":"number","minimum":0,"description":"Length or distance in the specified unit.","examples":[123.4],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].width.oneOf.1.value","typeLabel":"number"},"unit":{"type":"string","description":"Unit of the value. Service-point distances use metres; document dimensions and printer paper sizes use millimetres, independently of parcel dimensions.","enum":["mm","cm","m","in"],"examples":["cm"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].width.oneOf.1.unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].width.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].width","typeLabel":"null | object"},"height":{"oneOf":[{"type":"null","description":"Parcel height.","example":{"value":15,"unit":"cm"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].height.oneOf.0","typeLabel":"null"},{"type":"object","description":"Parcel height.","required":["value","unit"],"example":{"value":15,"unit":"cm"},"properties":{"value":{"type":"number","minimum":0,"description":"Length or distance in the specified unit.","examples":[123.4],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].height.oneOf.1.value","typeLabel":"number"},"unit":{"type":"string","description":"Unit of the value. Service-point distances use metres; document dimensions and printer paper sizes use millimetres, independently of parcel dimensions.","enum":["mm","cm","m","in"],"examples":["cm"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].height.oneOf.1.unit","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].height.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].height","typeLabel":"null | object"},"total_net_amount":{"oneOf":[{"type":"null","description":"Total value excluding tax.","example":{"value":15920,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].total_net_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total value excluding tax.","required":["value","currency"],"example":{"value":15920,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].total_net_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].total_net_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].total_net_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].total_net_amount","typeLabel":"null | object"},"tax_amount":{"oneOf":[{"type":"null","description":"Tax amount.","example":{"value":3980,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tax_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Tax amount.","required":["value","currency"],"example":{"value":3980,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tax_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tax_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tax_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tax_amount","typeLabel":"null | object"},"duty_amount":{"oneOf":[{"type":"null","description":"Duty amount.","example":{"value":5572,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].duty_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Duty amount.","required":["value","currency"],"example":{"value":5572,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].duty_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].duty_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].duty_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].duty_amount","typeLabel":"null | object"},"items":{"type":"array","items":{"type":"object","description":"Individual item within a parcel","properties":{"reference":{"oneOf":[{"type":"null","description":"Public reference, e.g. order number or SKU, which may be forwarded to the carrier or printed. Not necessarily unique.","examples":["TSHIRT-BLUE-M"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].reference.oneOf.0","typeLabel":"null"},{"type":"string","description":"Public reference, e.g. order number or SKU, which may be forwarded to the carrier or printed. Not necessarily unique.","examples":["TSHIRT-BLUE-M"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].reference.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].reference","typeLabel":"null | string"},"identifier":{"oneOf":[{"type":"null","description":"Private integration reference, e.g. a database ID. Not used for deduplication and not forwarded to carrier labels. Not necessarily unique.","examples":["order-line-9001"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].identifier.oneOf.0","typeLabel":"null"},{"type":"string","description":"Private integration reference, e.g. a database ID. Not used for deduplication and not forwarded to carrier labels. Not necessarily unique.","examples":["order-line-9001"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].identifier.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].identifier","typeLabel":"null | string"},"uri":{"oneOf":[{"type":"null","format":"uri","description":"URI linking to this item (product page URL, deep link, or any URI scheme)","examples":["https://shop.example.com/products/blue-t-shirt"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].uri.oneOf.0","typeLabel":"null"},{"type":"string","format":"uri","description":"URI linking to this item (product page URL, deep link, or any URI scheme)","examples":["https://shop.example.com/products/blue-t-shirt"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].uri.oneOf.1","typeLabel":"string\u003curi>"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].uri","typeLabel":"null | string\u003curi>"},"image_url":{"oneOf":[{"type":"null","format":"url","description":"URL for an product thumbnail image","examples":["https://www.example.com/products/1234-image1.jpeg"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].image_url.oneOf.0","typeLabel":"null"},{"type":"string","format":"url","description":"URL for an product thumbnail image","examples":["https://www.example.com/products/1234-image1.jpeg"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].image_url.oneOf.1","typeLabel":"string\u003curl>"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].image_url","typeLabel":"null | string\u003curl>"},"sku":{"oneOf":[{"type":"null","description":"Stock keeping unit identifier","examples":["PROD-001"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].sku.oneOf.0","typeLabel":"null"},{"type":"string","description":"Stock keeping unit identifier","examples":["PROD-001"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].sku.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].sku","typeLabel":"null | string"},"location":{"oneOf":[{"type":"null","description":"Warehouse location","examples":["AA-01-B45-C"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].location.oneOf.0","typeLabel":"null"},{"type":"string","description":"Warehouse location","examples":["AA-01-B45-C"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].location.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].location","typeLabel":"null | string"},"name":{"oneOf":[{"type":"null","description":"Product name","examples":["Widget"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].name.oneOf.0","typeLabel":"null"},{"type":"string","description":"Product name","examples":["Widget"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].name.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].name","typeLabel":"null | string"},"description":{"oneOf":[{"type":"null","description":"Product description for customs","examples":["Two blue cotton T-shirts"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].description.oneOf.0","typeLabel":"null"},{"type":"string","description":"Product description for customs","examples":["Two blue cotton T-shirts"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].description.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].description","typeLabel":"null | string"},"tariff_code":{"oneOf":[{"type":"null","description":"HS/customs tariff code","examples":["8471300000"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tariff_code.oneOf.0","typeLabel":"null"},{"type":"string","description":"HS/customs tariff code","examples":["8471300000"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tariff_code.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tariff_code","typeLabel":"null | string"},"country_of_origin":{"oneOf":[{"type":"null","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country code of origin","examples":["CN"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].country_of_origin.oneOf.0","typeLabel":"null"},{"type":"string","minLength":2,"maxLength":2,"description":"ISO 3166-1 alpha-2 country code of origin","examples":["CN"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].country_of_origin.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].country_of_origin","typeLabel":"null | string"},"quantity":{"type":"number","exclusiveMinimum":0,"description":"Quantity represented by this item line.","examples":[2],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].quantity","typeLabel":"number"},"total_net_amount":{"oneOf":[{"type":"null","description":"Total value for all quantities excluding tax.","example":{"value":15920,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].total_net_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total value for all quantities excluding tax.","required":["value","currency"],"example":{"value":15920,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].total_net_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].total_net_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].total_net_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].total_net_amount","typeLabel":"null | object"},"tax_amount":{"oneOf":[{"type":"null","description":"Total tax for all quantities.","example":{"value":3980,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tax_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total tax for all quantities.","required":["value","currency"],"example":{"value":3980,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tax_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tax_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tax_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].tax_amount","typeLabel":"null | object"},"duty_amount":{"oneOf":[{"type":"null","description":"Total duty for all quantities.","example":{"value":5572,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].duty_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total duty for all quantities.","required":["value","currency"],"example":{"value":5572,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].duty_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].duty_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].duty_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].duty_amount","typeLabel":"null | object"},"net_weight":{"oneOf":[{"type":"null","description":"Weight of all items on this line excluding packaging.","example":{"value":550,"unit":"g"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].net_weight.oneOf.0","typeLabel":"null"},{"type":"object","description":"Weight of all items on this line excluding packaging.","required":["value","unit"],"example":{"value":550,"unit":"g"},"properties":{"value":{"type":"number","minimum":0,"description":"Weight in the specified unit.","examples":[1500],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].net_weight.oneOf.1.value","typeLabel":"number"},"unit":{"type":"string","description":"Unit of measurement for weight","enum":["g","kg","lb","oz"],"examples":["g"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].net_weight.oneOf.1.unit","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].net_weight.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].net_weight","typeLabel":"null | object"},"cost_amount":{"oneOf":[{"type":"null","description":"Cost of all items excluding tax and duty.","example":{"value":5300,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].cost_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Cost of all items excluding tax and duty.","required":["value","currency"],"example":{"value":5300,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].cost_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].cost_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].cost_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].cost_amount","typeLabel":"null | object"},"dangerous_goods":{"oneOf":[{"type":"null","items":{"type":"object","required":["un_number","class","un_packing_group","tunnel_restriction_code","net_weight","quantity","environmentally_hazardous"],"properties":{"un_number":{"type":"string","description":"UN number (e.g., '1202', '1950')"},"class":{"type":"string","description":"Dangerous goods class (e.g., '1', '2.1', '3', '8')"},"un_packing_group":{"oneOf":[{"type":"null","description":"UN packing group (e.g., 'I', 'II', 'III')"},{"type":"string","description":"UN packing group (e.g., 'I', 'II', 'III')"}]},"tunnel_restriction_code":{"oneOf":[{"type":"null","enum":["A","B","C","D","E",null],"description":"ADR tunnel restriction code. A=no restrictions, E=most restrictive"},{"type":"string","enum":["A","B","C","D","E",null],"description":"ADR tunnel restriction code. A=no restrictions, E=most restrictive"}]},"net_weight":{"oneOf":[{"type":"null","description":"Net weight of this dangerous good.","example":{"value":100,"unit":"g"}},{"type":"object","description":"Net weight of this dangerous good.","required":["value","unit"],"example":{"value":100,"unit":"g"},"properties":{"value":{"type":"number","minimum":0,"description":"Weight in the specified unit.","examples":[1500]},"unit":{"type":"string","description":"Unit of measurement for weight","enum":["g","kg","lb","oz"],"examples":["g"]}},"additionalProperties":false}]},"quantity":{"oneOf":[{"type":"null","minimum":0,"description":"Quantity of this dangerous good"},{"type":"number","minimum":0,"description":"Quantity of this dangerous good"}]},"environmentally_hazardous":{"oneOf":[{"type":"null","description":"Whether this is environmentally hazardous"},{"type":"boolean","description":"Whether this is environmentally hazardous"}]}}},"description":"Dangerous goods contained in this item","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.0","typeLabel":"null"},{"type":"array","items":{"type":"object","required":["un_number","class","un_packing_group","tunnel_restriction_code","net_weight","quantity","environmentally_hazardous"],"properties":{"un_number":{"type":"string","description":"UN number (e.g., '1202', '1950')","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].un_number","typeLabel":"string"},"class":{"type":"string","description":"Dangerous goods class (e.g., '1', '2.1', '3', '8')","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].class","typeLabel":"string"},"un_packing_group":{"oneOf":[{"type":"null","description":"UN packing group (e.g., 'I', 'II', 'III')","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].un_packing_group.oneOf.0","typeLabel":"null"},{"type":"string","description":"UN packing group (e.g., 'I', 'II', 'III')","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].un_packing_group.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].un_packing_group","typeLabel":"null | string"},"tunnel_restriction_code":{"oneOf":[{"type":"null","enum":["A","B","C","D","E",null],"description":"ADR tunnel restriction code. A=no restrictions, E=most restrictive","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].tunnel_restriction_code.oneOf.0","typeLabel":"null"},{"type":"string","enum":["A","B","C","D","E",null],"description":"ADR tunnel restriction code. A=no restrictions, E=most restrictive","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].tunnel_restriction_code.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].tunnel_restriction_code","typeLabel":"null | enum\u003cstring>"},"net_weight":{"oneOf":[{"type":"null","description":"Net weight of this dangerous good.","example":{"value":100,"unit":"g"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].net_weight.oneOf.0","typeLabel":"null"},{"type":"object","description":"Net weight of this dangerous good.","required":["value","unit"],"example":{"value":100,"unit":"g"},"properties":{"value":{"type":"number","minimum":0,"description":"Weight in the specified unit.","examples":[1500],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].net_weight.oneOf.1.value","typeLabel":"number"},"unit":{"type":"string","description":"Unit of measurement for weight","enum":["g","kg","lb","oz"],"examples":["g"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].net_weight.oneOf.1.unit","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].net_weight.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].net_weight","typeLabel":"null | object"},"quantity":{"oneOf":[{"type":"null","minimum":0,"description":"Quantity of this dangerous good","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].quantity.oneOf.0","typeLabel":"null"},{"type":"number","minimum":0,"description":"Quantity of this dangerous good","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].quantity.oneOf.1","typeLabel":"number"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].quantity","typeLabel":"null | number"},"environmentally_hazardous":{"oneOf":[{"type":"null","description":"Whether this is environmentally hazardous","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].environmentally_hazardous.oneOf.0","typeLabel":"null"},{"type":"boolean","description":"Whether this is environmentally hazardous","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].environmentally_hazardous.oneOf.1","typeLabel":"boolean"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX].environmentally_hazardous","typeLabel":"null | boolean"}},"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"Dangerous goods contained in this item","isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX].dangerous_goods","typeLabel":"null | object[]"}},"required":["reference","identifier","uri","image_url","sku","location","name","description","tariff_code","country_of_origin","quantity","total_net_amount","tax_amount","duty_amount","net_weight","cost_amount","dangerous_goods"],"uniqueKey":"data.parcels.items.[INDEX].\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].\\items","typeLabel":"object[]"},"tracking_number":{"oneOf":[{"type":"string","description":"Carrier tracking number; preserve leading zeroes.","examples":["00340434161094015749"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tracking_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"Carrier tracking number; preserve leading zeroes.","examples":["00340434161094015749"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tracking_number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tracking_number","typeLabel":"string | null"},"tracking_url":{"oneOf":[{"type":"string","format":"uri","description":"Public tracking URL.","examples":["https://track.smartsend.io/example"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tracking_url.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Public tracking URL.","examples":["https://track.smartsend.io/example"],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tracking_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.parcels.items.[INDEX].tracking_url","typeLabel":"string\u003curi> | null"}},"required":["uuid","reference","identifier","freetext","gross_weight","length","width","height","total_net_amount","tax_amount","duty_amount","items","tracking_number","tracking_url"],"description":"Parcel input and booking result. Parcel order remains the accepted input order. Documents and drop-off/QR code arrays are on Shipment. Tracking numbers and URLs are booking results; tracking state, estimated delivery and events are retrieved through the separate tracking endpoints and require tracking access.","uniqueKey":"data.parcels.items.[INDEX]","typeLabel":"object"},"description":"Stable accepted parcel order.","minItems":1,"isRequired":true,"uniqueKey":"data.parcels","typeLabel":"object[]"},"total_net_amount":{"oneOf":[{"type":"null","description":"Total goods value excluding tax.","example":{"value":15920,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.total_net_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total goods value excluding tax.","required":["value","currency"],"example":{"value":15920,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.total_net_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.total_net_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.total_net_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.total_net_amount","typeLabel":"null | object"},"tax_amount":{"oneOf":[{"type":"null","description":"Total goods tax.","example":{"value":3980,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.tax_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total goods tax.","required":["value","currency"],"example":{"value":3980,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.tax_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.tax_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.tax_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.tax_amount","typeLabel":"null | object"},"duty_amount":{"oneOf":[{"type":"null","description":"Total goods duty.","example":{"value":5572,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.duty_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Total goods duty.","required":["value","currency"],"example":{"value":5572,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.duty_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.duty_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.duty_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.duty_amount","typeLabel":"null | object"},"shipping_net_amount":{"oneOf":[{"type":"null","description":"Shipping cost excluding tax.","example":{"value":3920,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.shipping_net_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Shipping cost excluding tax.","required":["value","currency"],"example":{"value":3920,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.shipping_net_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.shipping_net_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.shipping_net_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.shipping_net_amount","typeLabel":"null | object"},"shipping_tax_amount":{"oneOf":[{"type":"null","description":"Shipping tax.","example":{"value":980,"currency":"DKK"},"isRequired":true,"uniqueKey":"data.shipping_tax_amount.oneOf.0","typeLabel":"null"},{"type":"object","description":"Shipping tax.","required":["value","currency"],"example":{"value":980,"currency":"DKK"},"properties":{"value":{"type":"integer","description":"Amount in the currency's minor unit. For example, 3920 means DKK 39.20.","examples":[3920],"isRequired":true,"uniqueKey":"data.shipping_tax_amount.oneOf.1.value","typeLabel":"integer"},"currency":{"type":"string","description":"ISO 4217 currency code.","pattern":"^[A-Z]{3}$","examples":["DKK"],"isRequired":true,"uniqueKey":"data.shipping_tax_amount.oneOf.1.currency","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"data.shipping_tax_amount.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"data.shipping_tax_amount","typeLabel":"null | object"},"content_type":{"oneOf":[{"type":"string","description":"Type of contents in the shipment","enum":["commercial_goods","returned_goods","gift","commercial_sample","documents","other"],"example":"commercial_goods","isRequired":true,"uniqueKey":"data.content_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","example":"commercial_goods","isRequired":true,"uniqueKey":"data.content_type.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.content_type","typeLabel":"enum\u003cstring> | null"},"documents":{"type":"array","items":{"type":"object","properties":{"uuid":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].uuid","typeLabel":"any"},"print_status":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].print_status","typeLabel":"any"},"name":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].name","typeLabel":"any"},"filename":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].filename","typeLabel":"any"},"types":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].types","typeLabel":"any"},"format":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].format","typeLabel":"any"},"mime_type":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].mime_type","typeLabel":"any"},"size_bytes":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].size_bytes","typeLabel":"any"},"width":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].width","typeLabel":"any"},"height":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].height","typeLabel":"any"},"page_count":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].page_count","typeLabel":"any"},"url":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].url","typeLabel":"any"},"url_expires_at":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].url_expires_at","typeLabel":"any"},"description":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].description","typeLabel":"any"},"created_at":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].created_at","typeLabel":"any"},"updated_at":{"type":"any","isRequired":true,"uniqueKey":"data.documents.items.[INDEX].updated_at","typeLabel":"any"}},"required":["uuid","print_status","name","filename","types","format","mime_type","size_bytes","width","height","page_count","url","url_expires_at","description","created_at","updated_at"],"description":"Document metadata embedded in its shipment. The source is identified by the enclosing shipment and is omitted here. Other fields have the same meaning as on the document endpoints.","uniqueKey":"data.documents.items.[INDEX]","typeLabel":"object"},"description":"Booking documents with metadata and download links. The enclosing shipment supplies the source, so source is omitted. Empty when no documents are required. Never base64. Required documents are ready before state becomes booked.","isRequired":true,"uniqueKey":"data.documents","typeLabel":"object[]"},"qr_codes":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"Signed URL to the ready-to-display QR image.","format":"uri","examples":["https://downloads.example.com/codes/ORDER-1042.png"],"isRequired":true,"uniqueKey":"data.qr_codes.items.[INDEX].url","typeLabel":"string\u003curi>"},"url_expires_at":{"type":"string","format":"date-time","description":"Expiry of this image URL, not the validity period of the carrier code. Retrieve Shipment again to refresh.","examples":["2026-09-16T10:15:02Z"],"isRequired":true,"uniqueKey":"data.qr_codes.items.[INDEX].url_expires_at","typeLabel":"string\u003cdate-time>"}},"required":["url","url_expires_at"],"description":"A QR image used when handing in the shipment. This is not a Document or a parcel relation.","uniqueKey":"data.qr_codes.items.[INDEX]","typeLabel":"object"},"description":"Shipment-level QR images. One entry may apply to the whole shipment. Where one QR is supplied per parcel, index n corresponds to parcels[n]; this is an ordering convention, not a relation.","isRequired":true,"uniqueKey":"data.qr_codes","typeLabel":"object[]"},"drop_off_codes":{"type":"array","items":{"type":"string","description":"Text code to present or write when handing in a parcel. Preserve leading zeroes.","minLength":1,"uniqueKey":"data.drop_off_codes.items.[INDEX]","typeLabel":"string"},"description":"Shipment-level drop-off codes. When supplied one per parcel, index n corresponds to parcels[n]. No parcel UUID links are exposed.","isRequired":true,"uniqueKey":"data.drop_off_codes","typeLabel":"string[]"},"created_at":{"type":"string","format":"date-time","description":"When immutable shipment input was accepted.","examples":["2026-09-16T10:00:00Z"],"isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"When shipment lifecycle state/result changed. Excludes tracking, print updates and URL refreshes.","examples":["2026-09-16T10:00:02Z"],"isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"booked_at":{"oneOf":[{"type":"string","format":"date-time","description":"First time the carrier booking and all required documents/codes were ready. Retained after cancellation.","examples":["2026-09-16T10:00:02Z"],"isRequired":true,"uniqueKey":"data.booked_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"First time the carrier booking and all required documents/codes were ready. Retained after cancellation.","examples":["2026-09-16T10:00:02Z"],"isRequired":true,"uniqueKey":"data.booked_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.booked_at","typeLabel":"string\u003cdate-time> | null"},"cancelled_at":{"oneOf":[{"type":"string","format":"date-time","description":"When cancellation became effective internally.","isRequired":true,"uniqueKey":"data.cancelled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When cancellation became effective internally.","isRequired":true,"uniqueKey":"data.cancelled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.cancelled_at","typeLabel":"string\u003cdate-time> | null"},"voided_at":{"oneOf":[{"type":"string","format":"date-time","description":"When carrier cancellation was confirmed.","isRequired":true,"uniqueKey":"data.voided_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"When carrier cancellation was confirmed.","isRequired":true,"uniqueKey":"data.voided_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.voided_at","typeLabel":"string\u003cdate-time> | null"}},"required":["uuid","state","invoice_number","reference","identifier","uri","delivery","parties","parcels","total_net_amount","tax_amount","duty_amount","shipping_net_amount","shipping_tax_amount","content_type","documents","qr_codes","drop_off_codes","created_at","updated_at","booked_at","cancelled_at","voided_at"],"description":"Current persisted shipment data plus evolving lifecycle and results. Responses are reconstructed from the shipment and its relations; there is no copy of the original request. Each shipment has one logical booking. Full event and print histories are retrieved through their own paginated endpoints. A failed document workflow may still have a carrier booking; never blindly rebook such a result. Amounts and measurements include their own currency or unit. Measurements may be normalized when stored, so a response can use kg/cm rather than the input units while retaining the physical quantity. All shipment, parcel and item amounts share one currency; all weights, including dangerous goods, share one unit; all parcel dimensions share one unit. Document dimensions are independent.","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Full":{"title":"Full","description":"Illustrative input and booking results, including items, amounts, documents and drop-off codes. The available services, addons, documents and codes depend on the selected route. Cancellation timestamps remain null because this shipment is booked; the cotton items contain no dangerous goods.","value":{"data":{"uuid":"22222222-2222-4222-8222-222222222222","state":"booked","invoice_number":"INV-1042","reference":"ORDER-1042","identifier":"shop-order-1042","uri":"https://shop.example.com/admin/orders/1042","delivery":{"carrier":{"code":"postnord","name":"PostNord","logo_url":"https://assets.example.com/carriers/postnord/logo.svg","icon_url":"https://assets.example.com/carriers/postnord/icon.svg"},"last_mile_carrier":{"code":"postnord","name":"PostNord","logo_url":"https://assets.example.com/carriers/postnord/logo.svg","icon_url":"https://assets.example.com/carriers/postnord/icon.svg"},"service_code":"postnord_agent","service_name":"Service point","is_pickup":true,"is_return":false,"addons":[{"code":"SIGNATURE","name":"Signature"}],"pickup_point":{"uuid":"99999999-9999-4999-8999-999999999999","code":"12345","name":"Example Parcel Shop","address":{"address_lines":["Eksempelvej 20"],"postal_code":"8000","city":"Aarhus C","country":"DK","administrative_area":"82"}},"delivery_window":{"earliest":"2026-09-17T08:00:00Z","latest":"2026-09-17T16:00:00Z"},"incoterm":"DAP"},"parties":{"merchant":{"reference":"SHOP-DK","identifier":"shop-1","uri":"https://shop.example.com","address":{"address_lines":["Eksempelgade 1"],"postal_code":"2100","city":"Copenhagen","country":"DK","administrative_area":"84"},"contact":{"name_lines":["Example Shop"],"company":"Example Shop ApS","email":"shop@example.com","phone":"+4587654321"},"identifiers":{"vat":"DK12345678","eori":"DK12345678","gb_eori":"GB123456789000","tax_id":"12345678","voec":"2000123"}},"customer":{"reference":"CUSTOMER-2048","identifier":"customer-2048","uri":"https://shop.example.com/admin/customers/2048","address":{"address_lines":["Eksempelvej 10"],"postal_code":"8000","city":"Aarhus C","country":"DK","administrative_area":"82"},"contact":{"name_lines":["Example Customer"],"company":"Example Design ApS","email":"customer@example.com","phone":"+4512345678"},"identifiers":{"vat":"DK87654321","eori":"DK87654321","gb_eori":"GB987654321000","tax_id":"87654321","voec":"2000456"}}},"parcels":[{"uuid":"33333333-3333-4333-8333-333333333333","reference":"ORDER-1042-1","identifier":"shop-parcel-1","freetext":"Gift wrapped; keep dry.","gross_weight":{"value":1500,"unit":"g"},"length":{"value":30,"unit":"cm"},"width":{"value":20,"unit":"cm"},"height":{"value":15,"unit":"cm"},"total_net_amount":{"value":20000,"currency":"DKK"},"tax_amount":{"value":5000,"currency":"DKK"},"duty_amount":{"value":0,"currency":"DKK"},"items":[{"reference":"TSHIRT-BLUE-M","identifier":"order-line-9001","uri":"https://shop.example.com/products/blue-t-shirt","image_url":"https://shop.example.com/images/blue-t-shirt.jpg","sku":"TSHIRT-BLUE-M","location":"A1-04","name":"Blue cotton T-shirt, size M","description":"Two blue cotton T-shirts","tariff_code":"610910","country_of_origin":"DK","quantity":2,"total_net_amount":{"value":20000,"currency":"DKK"},"tax_amount":{"value":5000,"currency":"DKK"},"duty_amount":{"value":0,"currency":"DKK"},"net_weight":{"value":1000,"unit":"g"},"cost_amount":{"value":10000,"currency":"DKK"},"dangerous_goods":null}],"tracking_number":"00340434161094015749","tracking_url":"https://track.smartsend.io/example"}],"total_net_amount":{"value":20000,"currency":"DKK"},"tax_amount":{"value":5000,"currency":"DKK"},"duty_amount":{"value":0,"currency":"DKK"},"shipping_net_amount":{"value":3920,"currency":"DKK"},"shipping_tax_amount":{"value":980,"currency":"DKK"},"content_type":"commercial_goods","documents":[{"uuid":"44444444-4444-4444-8444-444444444444","print_status":"queued","name":"Shipping label","filename":"ORDER-1042-label.pdf","types":["label"],"format":"pdf","mime_type":"application/pdf","size_bytes":18342,"width":{"value":210,"unit":"mm"},"height":{"value":297,"unit":"mm"},"page_count":1,"url":"https://downloads.example.com/documents/label.pdf","url_expires_at":"2026-09-16T10:15:02Z","description":"Print and attach the label.","created_at":"2026-09-16T10:00:02Z","updated_at":"2026-09-16T10:00:02Z"}],"qr_codes":[{"url":"https://downloads.example.com/codes/ORDER-1042.png","url_expires_at":"2026-09-16T10:15:02Z"}],"drop_off_codes":["PB-12345678"],"created_at":"2026-09-16T10:00:00Z","updated_at":"2026-09-16T10:00:02Z","booked_at":"2026-09-16T10:00:02Z","cancelled_at":null,"voided_at":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"00f1bafe-d0bb-4d40-82fd-5aa6924edebc":{"description":"Authentication is missing or invalid.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"description":"An unsuccessful API request, using JSON with message and no custom error code. Persisted booking outcomes use ShipmentResponse where documented.","uniqueKey":"","typeLabel":"object"},"examples":{"Unauthenticated":{"title":"Unauthenticated","description":"Supply a valid API token. Repeating the same credentials does not resolve this response.","value":{"message":"Unauthenticated."}}},"exampleType":"examples"}},"exampleType":"examples"},"7e8e92be-8579-490a-b581-924c2e7daced":{"description":"The authenticated principal lacks the required team permission or scope.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"description":"An unsuccessful API request, using JSON with message and no custom error code. Persisted booking outcomes use ShipmentResponse where documented.","uniqueKey":"","typeLabel":"object"},"examples":{"PermissionDenied":{"title":"PermissionDenied","description":"Use credentials with the required team permission or scope.","value":{"message":"This action is unauthorized."}}},"exampleType":"examples"}},"exampleType":"examples"},"ab94b8e8-f99c-48cb-99a9-22b764e8521d":{"description":"The resource is absent, belongs to another team, or has been deleted.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"description":"An unsuccessful API request, using JSON with message and no custom error code. Persisted booking outcomes use ShipmentResponse where documented.","uniqueKey":"","typeLabel":"object"},"examples":{"ResourceNotFound":{"title":"ResourceNotFound","description":"Check the resource UUID and team. A missing, deleted or other-team resource uses the same response.","value":{"message":"The requested resource was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"d65c7046-aeb3-45de-bf1b-dbcf04de68b5":{"description":"Invalid request input or reuse of an Idempotency-Key with different input. Upfront shipment validation creates no shipment; a failing batch-add request adds none of its members. Correct the fields listed in errors before retrying.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"errors.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors.additionalProperties","typeLabel":"string[]"},"description":"Field or header names mapped to validation messages. Nested input uses dot notation, e.g. data.0.parties.customer.address.country. Header validation uses the header name, e.g. Idempotency-Key.","isRequired":true,"uniqueKey":"errors","typeLabel":"object"}},"required":["message","errors"],"description":"422 validation response. Field errors use dot notation for nested input; Idempotency-Key identifies a header validation error.","uniqueKey":"","typeLabel":"object"},"examples":{"ValidationFailed":{"title":"ValidationFailed","description":"Illustrative field name; actual errors name the invalid request fields. See shipment and batch operations for concrete examples.","value":{"message":"The given data was invalid.","errors":{"field_name":["This field is required."]}}}},"exampleType":"examples"}},"exampleType":"examples"},"178b704f-483f-4a91-b515-dc04d6015977":{"description":"Rate limit exceeded. Wait for Retry-After before retrying.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}},"Retry-After":{"description":"Delay in seconds before the next polling or retry request. Booking polling normally uses 5.","schema":{"type":"integer","minimum":1,"examples":[5]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"description":"An unsuccessful API request, using JSON with message and no custom error code. Persisted booking outcomes use ShipmentResponse where documented.","uniqueKey":"","typeLabel":"object"},"examples":{"TooManyRequests":{"title":"TooManyRequests","description":"Wait for the number of seconds in Retry-After before sending another request.","value":{"message":"Too Many Attempts."}}},"exampleType":"examples"}},"exampleType":"examples"},"04c052c5-cd4c-4163-a03c-d2a937fb77b1":{"description":"Unexpected server failure. An accepted action may already exist; recover using the same idempotency key or known resource URL.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"description":"An unsuccessful API request, using JSON with message and no custom error code. Persisted booking outcomes use ShipmentResponse where documented.","uniqueKey":"","typeLabel":"object"},"examples":{"ServerError":{"title":"ServerError","description":"An action may already have been accepted. Recover through its known resource URL or retry with the original Idempotency-Key. Include Request-ID when contacting support.","value":{"message":"Server Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"6d6f81b5-9004-4195-8345-66c411099042":{"description":"The service is temporarily unavailable.","headers":{"Request-ID":{"description":"Unique identifier for this HTTP request. Always present in responses. Echoes the client-supplied `Request-ID` request header when it matches the validation pattern; otherwise the server generates a UUIDv7. Include this value when reporting issues so support can locate the request in logs.","schema":{"type":"string","minLength":1,"maxLength":64,"pattern":"^[A-Za-z0-9._-]{1,64}$"}},"Retry-After":{"description":"Delay in seconds before the next polling or retry request. Booking polling normally uses 5.","schema":{"type":"integer","minimum":1,"examples":[5]}}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable, possibly localised explanation. Do not parse this text for client control flow.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"description":"An unsuccessful API request, using JSON with message and no custom error code. Persisted booking outcomes use ShipmentResponse where documented.","uniqueKey":"","typeLabel":"object"},"examples":{"ServiceUnavailable":{"title":"ServiceUnavailable","description":"Wait for Retry-After before retrying. Preserve the original Idempotency-Key for an action that may already have been accepted.","value":{"message":"Service Unavailable"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"dd554f86-64e5-4a2e-8c08-932ff367eabc":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}},"d2c228c4-88dc-4e66-b6a9-a92cad85a408":{"oauth2":{"type":"oauth2","description":"OAuth 2.0 Authorization Code flow for API access","flows":{"authorizationCode":{"authorizationUrl":"https://app.smartsend.io/oauth/authorize","tokenUrl":"https://app.smartsend.io/oauth/token","scopes":{"members:write":"Manage team members","service-point:read":"Access service points and pickup locations","rates:read":"Read team shipping routes, delivery options and pricing","tracking:read":"Access shipment tracking information","shipment:read":"Read shipment information","shipment:write":"Create and manage shipments","inventory:read":"Read team WMS inventory levels and items","inventory:write":"Mutate team WMS inventory (move stock, update counts)","fulfillment:read":"Read team WMS fulfillment requests","fulfillment:write":"Mutate team WMS fulfillment requests (pack)","documents:read":"Read team business documents, including reports and manifests","printing:read":"Read printers and document print jobs","printing:write":"Create document print and reprint jobs"}}},"scopes":["shipment:read"],"schemeName":"oauth2"}}},"servers":{"0eef3548-4f3c-4df2-b0fa-31d5d5218725":{"url":"https://api.smartsend.io","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth 2.0 Authorization Code flow for API access","flows":{"authorizationCode":{"authorizationUrl":"https://app.smartsend.io/oauth/authorize","tokenUrl":"https://app.smartsend.io/oauth/token","scopes":{"members:write":"Manage team members","service-point:read":"Access service points and pickup locations","rates:read":"Read team shipping routes, delivery options and pricing","tracking:read":"Access shipment tracking information","shipment:read":"Read shipment information","shipment:write":"Create and manage shipments","inventory:read":"Read team WMS inventory levels and items","inventory:write":"Mutate team WMS inventory (move stock, update counts)","fulfillment:read":"Read team WMS fulfillment requests","fulfillment:write":"Mutate team WMS fulfillment requests (pack)","documents:read":"Read team business documents, including reports and manifests","printing:read":"Read printers and document print jobs","printing:write":"Create document print and reprint jobs"}}},"scopes":["shipment:read"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth 2.0 Authorization Code flow for API access","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"openapi-v2beta.json"},"subdomain":"smartsend","siteName":"Smart Send","title":"Get shipment - Smart Send","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/shipments/get-shipment","matchLevel":0},"da":{"href":"/da","matchLevel":4}}},"lastModified":"2026-10-06T17:46:17.384Z","originalFileLocation":"api-reference/shipments/get-shipment.mdx","locale":"en"},"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=\"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Smart Send\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_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/smartsend/odqVYTxBgmDdYCGC/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get shipment - Smart Send\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Smart Send\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.smartsend.io/api-reference/shipments/get-shipment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smartsend.mintlify.site/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Get+shipment\u0026amp;description=Returns+a+shipment+with+its+current+booking+status%2C+tracking+numbers+and+URLs%2C+documents+and+codes.\u0026amp;theme=621081bdc56ba7d1c8d6f601\u0026amp;signature=3ae5404c3b06b936a7e57341aa34e22d3c72e449cac220b0632f38930f69de8b\">\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=\"Get shipment - Smart Send\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smartsend.mintlify.site/_mintlify/api/og/v2?division=Shipments\u0026amp;title=Get+shipment\u0026amp;description=Returns+a+shipment+with+its+current+booking+status%2C+tracking+numbers+and+URLs%2C+documents+and+codes.\u0026amp;theme=621081bdc56ba7d1c8d6f601\u0026amp;signature=3ae5404c3b06b936a7e57341aa34e22d3c72e449cac220b0632f38930f69de8b\">\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/smartsend/odqVYTxBgmDdYCGC/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Smart Send\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.smartsend.io/api-reference/shipments/get-shipment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/shipments/get-shipment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.smartsend.io/#organization\",\"name\":\"Smart Send\",\"url\":\"https://docs.smartsend.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smartsend/gD6ngks0jD1vt7-p/logo/light.svg?fit=max\u0026auto=format\u0026n=gD6ngks0jD1vt7-p\u0026q=85\u0026s=0497a6140076e33327e53bc8816acd0a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.smartsend.io#website\",\"name\":\"Smart Send\",\"url\":\"https://docs.smartsend.io\",\"publisher\":{\"@id\":\"https://docs.smartsend.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment#webpage\",\"url\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment\",\"name\":\"Get shipment\",\"description\":\"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.\",\"dateModified\":\"2026-10-06T17:46:17.384Z\",\"isPartOf\":{\"@id\":\"https://docs.smartsend.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API v2\",\"item\":\"https://docs.smartsend.io/api-reference/me/get-authenticated-user\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Shipments\",\"item\":\"https://docs.smartsend.io/api-reference/shipments/list-shipments\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get shipment\",\"item\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment#apireference\",\"headline\":\"Get shipment\",\"name\":\"Get shipment\",\"description\":\"Returns a shipment with its current booking status, tracking numbers and URLs, documents and codes.\",\"url\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.smartsend.io/api-reference/shipments/get-shipment#webpage\"},\"dateModified\":\"2026-10-06T17:46:17.384Z\",\"publisher\":{\"@id\":\"https://docs.smartsend.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.smartsend.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Smart Send\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Smart Send\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/shipments/get-shipment.md","siteName":"Smart Send","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://smartsend.io"}]},"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":""}]},{"tab":"API","groups":[{"group":"API Reference","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Debugging","icon":"bug","href":"/api-reference/debugging"},{"title":"Idempotency","icon":"repeat","href":"/api-reference/idempotency"},{"title":"Localization","icon":"language","href":"/api-reference/localization"}]},{"group":"API v1","pages":[{"group":"Account","pages":[{"title":"Get the authenticated user.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/me","href":"/api-reference/account/get-the-authenticated-user"},{"title":"Get website info.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/info","href":"/api-reference/account/get-website-info"}]},{"group":"Agents","pages":[{"title":"List carrier agents in country.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/carrier/{carrier}/country/{country}","href":"/api-reference/agents/list-carrier-agents-in-country"},{"title":"Get specific carrier agent in country.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/carrier/{carrier}/country/{country}/agentno/{agentNo}","href":"/api-reference/agents/get-specific-carrier-agent-in-country"},{"title":"List agents within a geospatial area.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/carrier/{carrier}/country/{country}/area/latitude/min/{minLatitude}/max/{maxLatitude}/longitude/min/{minLongitude}/max/{maxLongitude}","href":"/api-reference/agents/list-agents-within-a-geospatial-area"},{"title":"List carrier agents in postal code.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/carrier/{carrier}/country/{country}/postalcode/{postalCode}","href":"/api-reference/agents/list-carrier-agents-in-postal-code"},{"title":"List carrier agents on given street.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/carrier/{carrier}/country/{country}/postalcode/{postalCode}/street/{street}","href":"/api-reference/agents/list-carrier-agents-on-given-street"}]},{"group":"Closest Agents","pages":[{"title":"List closest agents relative to a given geospatial point.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/coordinates/latitude/{latitude}/longitude/{longitude}","href":"/api-reference/closest-agents/list-closest-agents-relative-to-a-given-geospatial-point"},{"title":"List closest agents relative to a postal code.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/postalcode/{postalCode}","href":"/api-reference/closest-agents/list-closest-agents-relative-to-a-postal-code"},{"title":"List closest agents relative to a postal code and city.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/postalcode/{postalCode}/city/{city}","href":"/api-reference/closest-agents/list-closest-agents-relative-to-a-postal-code-and-city"},{"title":"List closest agents relative to a given address.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/postalcode/{postalCode}/city/{city}/street/{street}","href":"/api-reference/closest-agents/list-closest-agents-relative-to-a-given-address"},{"title":"List closest agents relative to a postal code and street.","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/agents/closest/carrier/{carrier}/country/{country}/postalcode/{postalCode}/street/{street}","href":"/api-reference/closest-agents/list-closest-agents-relative-to-a-postal-code-and-street"}]},{"group":"Shipments","pages":[{"title":"Get a list of a websites shipments","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/shipments","href":"/api-reference/shipments/get-a-list-of-a-websites-shipments"},{"title":"Store a new shipment","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /v1/website/{team}/shipments","href":"/api-reference/shipments/store-a-new-shipment"},{"title":"Get a specific shipment","deprecated":null,"version":null,"openapi":"/openapi-v1.json get /v1/website/{team}/shipments/{shipment}","href":"/api-reference/shipments/get-a-specific-shipment"}]},{"group":"Bookings","pages":[{"title":"Combine labels for multiple shipments","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /v1/website/{team}/shipments/labels/combine","href":"/api-reference/bookings/combine-labels-for-multiple-shipments"},{"title":"Store a new shipment and book a label","deprecated":null,"version":null,"openapi":"/openapi-v1.json post /v1/website/{team}/shipments/labels","href":"/api-reference/bookings/store-a-new-shipment-and-book-a-label"}]}]},{"group":"API v2","pages":[{"group":"Me","pages":[{"title":"Get authenticated user","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/me","href":"/api-reference/me/get-authenticated-user"}]},{"group":"Teams","pages":[{"title":"List all teams","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams","href":"/api-reference/teams/list-all-teams"},{"title":"Get team details","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}","href":"/api-reference/teams/get-team-details"},{"title":"List team members","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/members","href":"/api-reference/teams/list-team-members"}]},{"group":"Service Points","pages":[{"title":"List all service points","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/service-points","href":"/api-reference/service-points/list-all-service-points"},{"title":"Get service point by UUID","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/service-points/{uuid}","href":"/api-reference/service-points/get-service-point-by-uuid"},{"title":"Get service point by code","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/service-points/{carrier}/{country}/{code}","href":"/api-reference/service-points/get-service-point-by-code"},{"title":"Get closest service points","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/service-points/closest","href":"/api-reference/service-points/get-closest-service-points"}]},{"group":"Carrier Catalog","pages":[{"title":"List all carriers","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/carriers","href":"/api-reference/carrier-catalog/list-all-carriers"},{"title":"List all addons","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/addons","href":"/api-reference/carrier-catalog/list-all-addons"}]},{"group":"Routing","pages":[{"title":"List available routes","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/routes","href":"/api-reference/routing/list-available-routes"}]},{"group":"Delivery Options","pages":[{"title":"Get delivery options","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /v2/teams/{teamUuid}/delivery-options","href":"/api-reference/delivery-options/get-delivery-options"}]},{"group":"Tracking","pages":[{"title":"Get tracking information","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/tracking/{trackingNumber}","href":"/api-reference/tracking/get-tracking-information"},{"title":"Read the tracking event feed","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/tracking/events","href":"/api-reference/tracking/read-the-tracking-event-feed"}]},{"group":"Shipments","pages":[{"title":"List shipments","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/shipments","href":"/api-reference/shipments/list-shipments"},{"title":"Create and book shipment","description":"Validates and books a shipment with the selected carrier service.","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /v2/teams/{teamUuid}/shipments","href":"/api-reference/shipments/create-and-book-shipment"},{"title":"Get shipment","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /v2/teams/{teamUuid}/shipments/{shipment}","href":"/api-reference/shipments/get-shipment"},{"title":"Delete shipment","description":"Deletes a shipment only if it has never been booked, retaining its internal audit history.","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json delete /v2/teams/{teamUuid}/shipments/{shipment}","href":"/api-reference/shipments/delete-shipment"},{"title":"Void shipment","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /v2/teams/{teamUuid}/shipments/{shipment}/cancel","href":"/api-reference/shipments/void-shipment"}]},{"group":"Booking batches","pages":[{"title":"List booking batches","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/booking-batches","href":"/api-reference/booking-batches/list-booking-batches"},{"title":"Create a booking batch","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/booking-batches","href":"/api-reference/booking-batches/create-a-booking-batch"},{"title":"Get booking batch","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/booking-batches/{batch}","href":"/api-reference/booking-batches/get-booking-batch"},{"title":"List shipments in a batch","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/booking-batches/{batch}/shipments","href":"/api-reference/booking-batches/list-shipments-in-a-batch"},{"title":"Add shipments to batch","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/booking-batches/{batch}/shipments","href":"/api-reference/booking-batches/add-shipments-to-batch"},{"title":"Start a booking batch","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/booking-batches/{batch}/start","href":"/api-reference/booking-batches/start-a-booking-batch"},{"title":"Stop a booking batch","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/booking-batches/{batch}/stop","href":"/api-reference/booking-batches/stop-a-booking-batch"}]},{"group":"Shipment Templates","pages":[{"title":"List shipment templates","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/shipment-templates","href":"/api-reference/shipment-templates/list-shipment-templates"},{"title":"Create a shipment template","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/shipment-templates","href":"/api-reference/shipment-templates/create-a-shipment-template"},{"title":"Get a shipment template","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/shipment-templates/{shipmentTemplateUuid}","href":"/api-reference/shipment-templates/get-a-shipment-template"},{"title":"Update a shipment template","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json put /beta/teams/{teamUuid}/shipment-templates/{shipmentTemplateUuid}","href":"/api-reference/shipment-templates/update-a-shipment-template"},{"title":"Delete a shipment template","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json delete /beta/teams/{teamUuid}/shipment-templates/{shipmentTemplateUuid}","href":"/api-reference/shipment-templates/delete-a-shipment-template"}]},{"group":"WMS Experimental","pages":[{"title":"List open fulfillment requests","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/wms/fulfillments","href":"/api-reference/wms-experimental/list-open-fulfillment-requests"},{"title":"Show a fulfillment request with its picking lines","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/wms/fulfillments/{fulfillmentIdentifier}","href":"/api-reference/wms-experimental/show-a-fulfillment-request-with-its-picking-lines"},{"title":"Record picked lines for a fulfillment request","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/wms/fulfillments/{fulfillmentIdentifier}/pack","href":"/api-reference/wms-experimental/record-picked-lines-for-a-fulfillment-request"},{"title":"List inventory levels","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/wms/inventory","href":"/api-reference/wms-experimental/list-inventory-levels"},{"title":"Show inventory levels for a SKU","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/wms/inventory/{sku}","href":"/api-reference/wms-experimental/show-inventory-levels-for-a-sku"},{"title":"Set the inventory count for a SKU in a bin","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json patch /beta/teams/{teamUuid}/wms/inventory/{sku}","href":"/api-reference/wms-experimental/set-the-inventory-count-for-a-sku-in-a-bin"},{"title":"Move inventory between bins","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/wms/inventory/{sku}/move","href":"/api-reference/wms-experimental/move-inventory-between-bins"},{"title":"Show a catalog item by SKU","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/wms/items/{sku}","href":"/api-reference/wms-experimental/show-a-catalog-item-by-sku"}]},{"group":"Documents","pages":[{"title":"List documents","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/documents","href":"/api-reference/documents/list-documents"},{"title":"Get document","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/documents/{document}","href":"/api-reference/documents/get-document"}]},{"group":"Printing","pages":[{"title":"List team printers","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/printers","href":"/api-reference/printing/list-team-printers"},{"title":"List print jobs","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/print-jobs","href":"/api-reference/printing/list-print-jobs"},{"title":"Print or reprint a document","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json post /beta/teams/{teamUuid}/print-jobs","href":"/api-reference/printing/print-or-reprint-a-document"},{"title":"Get print job status","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/print-jobs/{printJob}","href":"/api-reference/printing/get-print-job-status"},{"title":"Get a printer","deprecated":null,"version":null,"openapi":"/openapi-v2beta.json get /beta/teams/{teamUuid}/printers/{printer}","href":"/api-reference/printing/get-a-printer"}]},{"group":"Webhooks","pages":[{"title":"Receive team resource updates","version":null,"deprecated":null,"openapi":"/openapi-v2beta.json webhook teamEvents","href":"/api-reference/webhooks/receive-team-resource-updates"}]}]}]},{"tab":"Knowledge","pages":[{"title":"Knowledge","href":"/knowledge/knowledge-base"}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai/overview"}]},{"tab":"Troubleshooting","pages":[{"title":"Troubleshooting","href":"/troubleshooting/overview"}]},{"tab":"Status","pages":[{"title":"Status","href":"/status/status"}]}]},{"language":"da","pages":[{"title":"da","href":"/da"}]}]},"basePath":"","title":"Get shipment - Smart Send","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}