BETA - The Analytics API is currently in beta. Endpoints and behavior may change as the feature evolves.
The Analytics API exposes aggregated shipping insights derived from your account’s shipping activity, so you can measure carrier performance and identify trends across origins, destinations, and time windows.
Analytics endpoints are gated by per-feature access. Depending on your account’s plan and enabled features, some
endpoints in this API may not be available to you.
What can you do with this API?
Measure carrier transit times
Retrieve median transit-time statistics for one or more carriers over a configurable date window. You can break the data down by origin and destination country to compare lanes, spot regressions, and benchmark carriers against each other.
Measure shipping option transit times
Retrieve median transit-time statistics for one or more shipping options over a configurable date window. Useful for comparing the options you offer in your checkout against each other and for setting realistic delivery promises per lane.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Sendcloud API Developer Portal","colors":{"primary":"#007deb","light":"#4aacff","dark":"#007deb"},"logo":{"light":"https://mintcdn.com/sendcloud/XCwUHYDXpvdKQUUZ/images/logo/sendcloud-light.svg?fit=max\u0026auto=format\u0026n=XCwUHYDXpvdKQUUZ\u0026q=85\u0026s=7f1beaa17361a486dea3cfbda34467ac","dark":"https://mintcdn.com/sendcloud/XCwUHYDXpvdKQUUZ/images/logo/sendcloud-dark.svg?fit=max\u0026auto=format\u0026n=XCwUHYDXpvdKQUUZ\u0026q=85\u0026s=d3f06cc6feef9092376cf6119275f26e"},"favicon":"https://mintcdn.com/sendcloud/LIehat_olPczp-rn/favicon.ico?fit=max\u0026auto=format\u0026n=LIehat_olPczp-rn\u0026q=85\u0026s=d41952b19261251914b518e534693461","footer":{"socials":{"facebook":"https://www.facebook.com/sendcloud","instagram":"https://instagram.com/sendcloud","linkedin":"https://www.linkedin.com/company/sendcloud"},"links":[{"header":"Product","items":[{"label":"About us","href":"https://sendcloud.com"},{"label":"Sendcloud platform","href":"https://app.sendcloud.com"},{"label":"Release log","href":"https://releaselog.sendcloud.com/changelog"},{"label":"Jobs 🚀","href":"https://jobs.sendcloud.com"}]},{"header":"Support","items":[{"label":"Help center","href":"https://support.sendcloud.com"},{"label":"Status page","href":"https://status.sendcloud.com"}]}]},"seo":{"metatags":{"google-site-verification":"Wl-7Uz7alSq_fG01AMbtDKMMQIDt-yQ4u7uFB3QuV8k"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sendcloud","hasAudioNarration":false,"actualSubdomain":"sendcloud","customDomains":["sendcloud.dev"],"gitSource":{"type":"gitlab","owner":"sendcloud/platform/api","repo":"sendcloud-public-api-documentation","projectId":75015551,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afecde35735af7f41cf311b","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API v3","count":150},{"language":"default","tag":"API v2","count":92},{"language":"default","tag":"Developer guides","count":66},{"language":"default","tag":"Shipping","count":40},{"language":"default","tag":"Tracking \u0026 post-purchase","count":30},{"language":"default","tag":"Shipments","count":24},{"language":"default","tag":"Events \u0026 notifications","count":22},{"language":"default","tag":"Support","count":20},{"language":"default","tag":"Getting started","count":17},{"language":"default","tag":"Event subscriptions","count":15}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".mermaid svg{margin-inline:auto}"}]}
{"page":{"pagePath":"api/v3/analytics","slug":"/api/v3/analytics","pageMetadata":{"title":"Analytics API overview","description":null,"href":"/api/v3/analytics/index"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Heading,Info,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`BETA`}),` - The Analytics API is currently in beta. Endpoints and behavior may change as the feature evolves.`]})}),`\n`,_jsx(_components.p,{children:`The Analytics API exposes aggregated shipping insights derived from your account’s shipping activity, so you can measure carrier performance and identify trends across origins, destinations, and time windows.`}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`Analytics endpoints are gated by per-feature access. Depending on your account’s plan and enabled features, some\nendpoints in this API may not be available to you.`})}),`\n`,_jsx(Heading,{level:`2`,id:`what-can-you-do-with-this-api`,children:`What can you do with this API?`}),`\n`,_jsx(Heading,{level:`3`,id:`measure-carrier-transit-times`,children:`Measure carrier transit times`}),`\n`,_jsx(_components.p,{children:`Retrieve median transit-time statistics for one or more carriers over a configurable date window. You can break the data down by origin and destination country to compare lanes, spot regressions, and benchmark carriers against each other.`}),`\n`,_jsx(Heading,{level:`3`,id:`measure-shipping-option-transit-times`,children:`Measure shipping option transit times`}),`\n`,_jsx(_components.p,{children:`Retrieve median transit-time statistics for one or more shipping options over a configurable date window. Useful for comparing the options you offer in your checkout against each other and for setting realistic delivery promises per lane.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Analytics API overview","description":null,"href":"/api/v3/analytics/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"What can you do with this API?","slug":"what-can-you-do-with-this-api","depth":2,"children":[{"title":"Measure carrier transit times","slug":"measure-carrier-transit-times","depth":3,"children":[]},{"title":"Measure shipping option transit times","slug":"measure-shipping-option-transit-times","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/sendcloud/85bcd80b47d42300/js/cookiebot.js"],"subdomain":"sendcloud","siteName":"Sendcloud API Developer Portal","title":"Analytics API overview - Sendcloud API Developer Portal","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T10:34:00.126Z","originalFileLocation":"api/v3/analytics/index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Sendcloud API Developer Portal\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_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/sendcloud/2LowbF5vJKmmScp0/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Analytics API overview - Sendcloud API Developer Portal\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sendcloud API Developer Portal\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://sendcloud.dev/api/v3/analytics\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sendcloud.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Analytics+API+overview\u0026amp;theme=98143dbb82b5eecb925033ee\u0026amp;signature=e36770a5bd47b7eb48be9c1e59cbeee659282711e6d676631fc4e7f3a9352f39\">\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=\"Analytics API overview - Sendcloud API Developer Portal\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sendcloud.mintlify.site/_mintlify/api/og/v2?division=Analytics\u0026amp;title=Analytics+API+overview\u0026amp;theme=98143dbb82b5eecb925033ee\u0026amp;signature=e36770a5bd47b7eb48be9c1e59cbeee659282711e6d676631fc4e7f3a9352f39\">\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/sendcloud/2LowbF5vJKmmScp0/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sendcloud API Developer Portal\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007deb\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"Wl-7Uz7alSq_fG01AMbtDKMMQIDt-yQ4u7uFB3QuV8k\">\u003clink data-mint-head rel=\"canonical\" href=\"https://sendcloud.dev/api/v3/analytics\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api/v3/analytics.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://sendcloud.dev/#organization\",\"name\":\"Sendcloud API Developer Portal\",\"url\":\"https://sendcloud.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sendcloud/XCwUHYDXpvdKQUUZ/images/logo/sendcloud-light.svg?fit=max\u0026auto=format\u0026n=XCwUHYDXpvdKQUUZ\u0026q=85\u0026s=7f1beaa17361a486dea3cfbda34467ac\"}},{\"@type\":\"WebSite\",\"@id\":\"https://sendcloud.dev#website\",\"name\":\"Sendcloud API Developer Portal\",\"url\":\"https://sendcloud.dev\",\"publisher\":{\"@id\":\"https://sendcloud.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://sendcloud.dev/api/v3/analytics#webpage\",\"url\":\"https://sendcloud.dev/api/v3/analytics\",\"name\":\"Analytics API overview\",\"dateModified\":\"2026-11-11T10:34:00.126Z\",\"isPartOf\":{\"@id\":\"https://sendcloud.dev#website\"},\"breadcrumb\":{\"@id\":\"https://sendcloud.dev/api/v3/analytics#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://sendcloud.dev/api/v3/analytics#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sendcloud API Developer Portal\",\"item\":\"https://sendcloud.dev\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Analytics API overview\",\"item\":\"https://sendcloud.dev/api/v3/analytics\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://sendcloud.dev/api/v3/analytics#article\",\"headline\":\"Analytics API overview\",\"name\":\"Analytics API overview\",\"url\":\"https://sendcloud.dev/api/v3/analytics\",\"mainEntityOfPage\":{\"@id\":\"https://sendcloud.dev/api/v3/analytics#webpage\"},\"dateModified\":\"2026-11-11T10:34:00.126Z\",\"publisher\":{\"@id\":\"https://sendcloud.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://sendcloud.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sendcloud API Developer Portal\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sendcloud API Developer Portal\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api/v3/analytics.md","siteName":"Sendcloud API Developer Portal","nav":{"global":null,"tabs":[{"tab":"Developer guides","pages":[{"title":"Developer guides","href":""}]},{"tab":"API v3","groups":[{"group":"General","pages":[{"title":"Introduction","icon":"map","href":"/api/v3"},{"title":"API v3 Changelog","icon":"list-timeline","href":"/api/v3/changelog"},{"title":"Pagination","icon":"arrow-right-arrow-left","href":"/api/v3/pagination"},{"title":"Scopes for OAuth apps","icon":"user-key","href":"/api/v3/scopes"}]},{"group":"Authentication \u0026 account","icon":"key","pages":[{"group":"OAuth2","icon":"key","pages":[{"title":"OAuth 2.0 token","deprecated":null,"version":null,"sidebarTitle":"Token","openapi":"/.openapi/v3/auth/openapi.yaml post /oauth2/token","href":"/api/v3/oauth2/token"}]},{"group":"User","icon":"user","pages":[{"title":"Retrieve metadata associated with the authentication method","deprecated":null,"version":null,"sidebarTitle":"Retrieve metadata associated with the authentication method","openapi":"/.openapi/v3/user/openapi.yaml get /user/auth/metadata","href":"/api/v3/user/retrieve-metadata-associated-with-the-authentication-method"}]},{"group":"Organization","icon":"sitemap","pages":[{"title":"Retrieve organization information","deprecated":null,"version":null,"sidebarTitle":"Retrieve information about the organization","openapi":"/.openapi/v3/organization/openapi.yaml get /organization","href":"/api/v3/organization/retrieve-information-about-the-organization"}]},{"group":"Sender addresses","icon":"address-card","pages":[{"title":"Retrieve a list of sender addresses","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of sender addresses","openapi":"/.openapi/v3/sender-addresses/openapi.yaml get /addresses/sender-addresses","href":"/api/v3/sender-addresses/retrieve-a-list-of-sender-addresses"},{"title":"Retrieve a sender address","deprecated":null,"version":null,"sidebarTitle":"Retrieve a sender address","openapi":"/.openapi/v3/sender-addresses/openapi.yaml get /addresses/sender-addresses/{id}","href":"/api/v3/sender-addresses/retrieve-a-sender-address"}]},{"group":"Brands","icon":"copyright","pages":[{"title":"Retrieve a list of brands","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of brands","openapi":"/.openapi/v3/brands/openapi.yaml get /brands","href":"/api/v3/brands/retrieve-a-list-of-brands"},{"title":"Retrieve a brand","deprecated":null,"version":null,"sidebarTitle":"Retrieve a brand","openapi":"/.openapi/v3/brands/openapi.yaml get /brands/{id}","href":"/api/v3/brands/retrieve-a-brand"}]}]},{"group":"Shipping","icon":"truck-fast","pages":[{"group":"Shipping options","icon":"list-check","pages":[{"title":"Create a list of shipping options","deprecated":true,"version":null,"sidebarTitle":"Create a list of shipping options","openapi":"/.openapi/v3/shipping-options/openapi.yaml post /fetch-shipping-options","href":"/api/v3/shipping-options/create-a-list-of-shipping-options"},{"title":"Return a list of available shipping options","deprecated":null,"version":null,"sidebarTitle":"Return a list of available shipping options","openapi":"/.openapi/v3/shipping-options/openapi.yaml post /shipping-options","href":"/api/v3/shipping-options/return-a-list-of-available-shipping-options"},{"title":"Retrieve a list of shipping options","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of shipping options","openapi":"/.openapi/v3/compat/openapi.yaml post /compat/shipping-options","href":"/api/v3/compat/retrieve-a-list-of-shipping-options"}]},{"group":"Address validation","icon":"address-card","pages":[{"title":"Validate an address","deprecated":null,"version":null,"sidebarTitle":"Validate","openapi":"/.openapi/v3/shipments/openapi.yaml post /addresses/validate","href":"/api/v3/address/validate"}]},{"group":"Orders","icon":"receipt","pages":[{"title":"Orders API overview","href":"/api/v3/orders/index"},{"title":"Create/Update orders in batch","deprecated":null,"version":null,"sidebarTitle":"Create update orders in batch","openapi":"/.openapi/v3/orders/openapi.yaml post /orders","href":"/api/v3/orders/create-update-orders-in-batch"},{"title":"Retrieve a list of orders","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of orders","openapi":"/.openapi/v3/orders/openapi.yaml get /orders","href":"/api/v3/orders/retrieve-a-list-of-orders"},{"title":"Retrieve an order","deprecated":null,"version":null,"sidebarTitle":"Retrieve an order","openapi":"/.openapi/v3/orders/openapi.yaml get /orders/{id}","href":"/api/v3/orders/retrieve-an-order"},{"title":"Update an order","deprecated":null,"version":null,"sidebarTitle":"Update an order","openapi":"/.openapi/v3/orders/openapi.yaml patch /orders/{id}","href":"/api/v3/orders/update-an-order"},{"title":"Delete an order","deprecated":null,"version":null,"sidebarTitle":"Delete an order","openapi":"/.openapi/v3/orders/openapi.yaml delete /orders/{id}","href":"/api/v3/orders/delete-an-order"}]},{"group":"Ship an order","icon":"box","pages":[{"title":"Ship an Order API overview","href":"/api/v3/ship-an-order/index"},{"title":"Request a label for a single order synchronously","deprecated":null,"version":null,"sidebarTitle":"Request a label for a single order synchronously","openapi":"/.openapi/v3/ship-an-order/openapi.yaml post /orders/create-label-sync","href":"/api/v3/ship-an-order/request-a-label-for-a-single-order-synchronously"},{"title":"Request a label for one or more orders asynchronously","deprecated":null,"version":null,"sidebarTitle":"Request a label for one or more orders asynchronously","openapi":"/.openapi/v3/ship-an-order/openapi.yaml post /orders/create-labels-async","href":"/api/v3/ship-an-order/request-a-label-for-one-or-more-orders-asynchronously"}]},{"group":"Shipments","icon":"truck-fast","pages":[{"title":"Shipments API overview","href":"/api/v3/shipments/index"},{"title":"Create and announce a shipment synchronously","deprecated":null,"version":null,"sidebarTitle":"Create and announce a shipment synchronously","openapi":"/.openapi/v3/shipments/openapi.yaml post /shipments/announce","href":"/api/v3/shipments/create-and-announce-a-shipment-synchronously"},{"title":"Create and announce a shipment asynchronously","deprecated":null,"version":null,"sidebarTitle":"Create and announce a shipment asynchronously","openapi":"/.openapi/v3/shipments/openapi.yaml post /shipments","href":"/api/v3/shipments/create-and-announce-a-shipment-asynchronously"},{"title":"Create a shipment with rules and/or defaults and announce it synchronously","deprecated":null,"version":null,"sidebarTitle":"Create a shipment with rules and or default and announce it synchronously","openapi":"/.openapi/v3/shipments/openapi.yaml post /shipments/announce-with-shipping-rules","href":"/api/v3/shipments/create-a-shipment-with-rules-and-or-default-and-announce-it-synchronously"},{"title":"Create a shipment with rules and/or defaults and announce it asynchronously","deprecated":null,"version":null,"sidebarTitle":"Create a shipment with rules and or default and announce it asynchronously","openapi":"/.openapi/v3/shipments/openapi.yaml post /shipments/create-with-shipping-rules","href":"/api/v3/shipments/create-a-shipment-with-rules-and-or-default-and-announce-it-asynchronously"},{"title":"Retrieve shipments","deprecated":null,"version":null,"sidebarTitle":"Retrieve shipments","openapi":"/.openapi/v3/shipments/openapi.yaml get /shipments","href":"/api/v3/shipments/retrieve-shipments"},{"title":"Retrieve a shipment","deprecated":null,"version":null,"sidebarTitle":"Retrieve a shipment","openapi":"/.openapi/v3/shipments/openapi.yaml get /shipments/{id}","href":"/api/v3/shipments/retrieve-a-shipment"},{"title":"Retrieve a return portal URL","deprecated":null,"version":null,"sidebarTitle":"Retrieve a return portal url","openapi":"/.openapi/v3/shipments/openapi.yaml get /shipments/{id}/return-portal-url","href":"/api/v3/shipments/retrieve-a-return-portal-url"},{"title":"Cancel a shipment","deprecated":null,"version":null,"sidebarTitle":"Cancel a shipment","openapi":"/.openapi/v3/shipments/openapi.yaml post /shipments/{id}/cancel","href":"/api/v3/shipments/cancel-a-shipment"},{"title":"Upload a customs document","deprecated":null,"version":null,"sidebarTitle":"Upload a customs document","tag":"Beta","openapi":"/.openapi/v3/shipments/openapi.yaml post /shipments/documents","href":"/api/v3/shipments/upload-a-customs-document"}]},{"group":"Parcel documents","icon":"file-lines","pages":[{"title":"Retrieve a parcel document","deprecated":null,"version":null,"sidebarTitle":"Retrieve a parcel document","openapi":"/.openapi/v3/parcel-documents/openapi.yaml get /parcels/{id}/documents/{type}","href":"/api/v3/parcel-documents/retrieve-a-parcel-document"},{"title":"Retrieve multiple parcel documents","deprecated":null,"version":null,"sidebarTitle":"Retrieve multiple parcel documents","openapi":"/.openapi/v3/parcel-documents/openapi.yaml get /parcel-documents/{type}","href":"/api/v3/parcel-documents/retrieve-multiple-parcel-documents"}]},{"group":"Shipping rules","icon":"sliders","pages":[{"title":"Shipping Rules API overview","href":"/api/v3/shipping-rules/index"},{"title":"Retrieve a list of shipping rules","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of shipping rules","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/rules","href":"/api/v3/shipping-rules/retrieve-a-list-of-shipping-rules"},{"title":"Create a shipping rule","deprecated":null,"version":null,"sidebarTitle":"Create a shipping rule","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml post /shipping-rules/rules","href":"/api/v3/shipping-rules/create-a-shipping-rule"},{"title":"Reorder your shipping rules","deprecated":null,"version":null,"sidebarTitle":"Reorder your shipping rules","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml post /shipping-rules/rules/reorder","href":"/api/v3/shipping-rules/reorder-your-shipping-rules"},{"title":"Retrieve a shipping rule","deprecated":null,"version":null,"sidebarTitle":"Retrieve a shipping rule","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/rules/{rule_id}","href":"/api/v3/shipping-rules/retrieve-a-shipping-rule"},{"title":"Update a shipping rule","deprecated":null,"version":null,"sidebarTitle":"Update a shipping rule","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml patch /shipping-rules/rules/{rule_id}","href":"/api/v3/shipping-rules/update-a-shipping-rule"},{"title":"Delete a shipping rule","deprecated":null,"version":null,"sidebarTitle":"Delete a shipping rule","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml delete /shipping-rules/rules/{rule_id}","href":"/api/v3/shipping-rules/delete-a-shipping-rule"},{"title":"Retrieve a list of available actions","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of available actions","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/actions","href":"/api/v3/shipping-rules/retrieve-a-list-of-available-actions"},{"title":"Retrieve an action","deprecated":null,"version":null,"sidebarTitle":"Retrieve an action","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/actions/{identifier}","href":"/api/v3/shipping-rules/retrieve-an-action"},{"title":"Retrieve a list of available operators","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of available operators","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/operators","href":"/api/v3/shipping-rules/retrieve-a-list-of-available-operators"},{"title":"Retrieve a list of available conditions","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of available conditions","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/conditions","href":"/api/v3/shipping-rules/retrieve-a-list-of-available-conditions"},{"title":"Retrieve a condition property","deprecated":null,"version":null,"sidebarTitle":"Retrieve a condition property","tag":"Beta","openapi":"/.openapi/v3/shipping-rules/openapi.yaml get /shipping-rules/conditions/{identifier}","href":"/api/v3/shipping-rules/retrieve-a-condition-property"}]},{"group":"Shipping defaults","icon":"gear","pages":[{"title":"Shipping Defaults API overview","href":"/api/v3/shipping-defaults/index"},{"title":"Retrieve your shipping defaults","deprecated":null,"version":null,"sidebarTitle":"Retrieve your shipping defaults","tag":"Beta","openapi":"/.openapi/v3/shipping-defaults/openapi.yaml get /shipping-defaults","href":"/api/v3/shipping-defaults/retrieve-your-shipping-defaults"},{"title":"Update your shipping defaults","deprecated":null,"version":null,"sidebarTitle":"Update your shipping defaults","tag":"Beta","openapi":"/.openapi/v3/shipping-defaults/openapi.yaml patch /shipping-defaults","href":"/api/v3/shipping-defaults/update-your-shipping-defaults"}]}]},{"group":"Checkout \u0026 delivery options","icon":"cart-shopping","pages":[{"group":"Dynamic checkout","icon":"cart-shopping","pages":[{"title":"Dynamic Checkout API overview","href":"/api/v3/dynamic-checkout/index"},{"title":"Retrieve a list of delivery options","deprecated":true,"version":null,"sidebarTitle":"Retrieve a list of delivery options","openapi":"/.openapi/v3/dynamic-checkout/openapi.yaml get /checkout/configurations/{configuration_id}/delivery-options","href":"/api/v3/dynamic-checkout/retrieve-a-list-of-delivery-options"},{"title":"Generate a list of delivery options","deprecated":null,"version":null,"sidebarTitle":"Generate a list of delivery options","tag":"Beta","openapi":"/.openapi/v3/dynamic-checkout/openapi.yaml post /checkout/delivery-options","href":"/api/v3/dynamic-checkout/generate-a-list-of-delivery-options"}]},{"group":"Service points","icon":"map-location-dot","pages":[{"title":"Service Points API overview","href":"/api/v3/service-points/index"},{"title":"Retrieve a list of service points","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of service points","openapi":"/.openapi/v3/service-points/openapi.yaml get /service-points","href":"/api/v3/service-points/retrieve-a-list-of-service-points"},{"title":"Retrieve a service point","deprecated":null,"version":null,"sidebarTitle":"Retrieve a service point","openapi":"/.openapi/v3/service-points/openapi.yaml get /service-points/{service_point_id}","href":"/api/v3/service-points/retrieve-a-service-point"},{"title":"Check availability of a service point","deprecated":null,"version":null,"sidebarTitle":"Check availability of a service point","openapi":"/.openapi/v3/service-points/openapi.yaml post /service-points/{service_point_id}/check-availability","href":"/api/v3/service-points/check-availability-of-a-service-point"}]},{"group":"Duties \u0026 taxes","icon":"scale-balanced","pages":[{"title":"Create a duties and taxes calculation","deprecated":null,"version":null,"sidebarTitle":"Create a duties and taxes calculation","tag":"Beta","openapi":"/.openapi/v3/duties-and-taxes/openapi.yaml post /shipping/duties-and-taxes","href":"/api/v3/duties-and-taxes/create-a-duties-and-taxes-calculation"}]}]},{"group":"Tracking \u0026 post-purchase","icon":"location-dot","pages":[{"group":"Parcel tracking","icon":"location-dot","pages":[{"title":"Create an external parcel for tracking","deprecated":null,"version":null,"sidebarTitle":"Create an external parcel for tracking","openapi":"/.openapi/v3/parcel-tracking/openapi.yaml post /parcels/tracking","href":"/api/v3/parcel-tracking/create-an-external-parcel-for-tracking"},{"title":"Retrieve tracking information for a parcel","deprecated":null,"version":null,"sidebarTitle":"Retrieve tracking information for a parcel","openapi":"/.openapi/v3/parcel-tracking/openapi.yaml get /parcels/tracking/{tracking_number}","href":"/api/v3/parcel-tracking/retrieve-tracking-information-for-a-parcel"}]},{"group":"Parcel statuses","icon":"circle-info","pages":[{"title":"Retrieve a list of parcel statuses","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of parcel statuses","openapi":"/.openapi/v3/parcel-statuses/openapi.yaml get /parcels/statuses","href":"/api/v3/parcel-statuses/retrieve-a-list-of-parcel-statuses"}]},{"group":"Returns","icon":"rotate-left","pages":[{"title":"Returns API overview","href":"/api/v3/returns/index"},{"title":"Validate a return","deprecated":null,"version":null,"sidebarTitle":"Validate a return","openapi":"/.openapi/v3/returns/openapi.yaml post /returns/validate","href":"/api/v3/returns/validate-a-return"},{"title":"Create a return","deprecated":null,"version":null,"sidebarTitle":"Create a return","openapi":"/.openapi/v3/returns/openapi.yaml post /returns","href":"/api/v3/returns/create-a-return"},{"title":"Create a return synchronously","deprecated":null,"version":null,"sidebarTitle":"Create a return synchronously","openapi":"/.openapi/v3/returns/openapi.yaml post /returns/announce-synchronously","href":"/api/v3/returns/create-a-return-synchronously"},{"title":"Retrieve a list of returns","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of returns","openapi":"/.openapi/v3/returns/openapi.yaml get /returns","href":"/api/v3/returns/retrieve-a-list-of-returns"},{"title":"Retrieve a return","deprecated":null,"version":null,"sidebarTitle":"Retrieve a return","openapi":"/.openapi/v3/returns/openapi.yaml get /returns/{id}","href":"/api/v3/returns/retrieve-a-return"},{"title":"Request cancellation of a return","deprecated":null,"version":null,"sidebarTitle":"Request cancellation of a return","openapi":"/.openapi/v3/returns/openapi.yaml patch /returns/{id}/cancel","href":"/api/v3/returns/request-cancellation-of-a-return"}]},{"group":"Support","icon":"headset","pages":[{"title":"Support API overview","href":"/api/v3/support/index"},{"group":"Tickets","icon":"ticket","pages":[{"title":"Create a ticket for a lost parcel","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for a lost parcel","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/lost","href":"/api/v3/support/create-a-ticket-for-a-lost-parcel"},{"title":"Create a ticket for a damaged parcel","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for a damaged parcel","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/damage","href":"/api/v3/support/create-a-ticket-for-a-damaged-parcel"},{"title":"Create a ticket for a delayed parcel","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for a delayed parcel","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/delay","href":"/api/v3/support/create-a-ticket-for-a-delayed-parcel"},{"title":"Create a ticket for a late delivery","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for a late delivery","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/late-delivery","href":"/api/v3/support/create-a-ticket-for-a-late-delivery"},{"title":"Create a ticket for a delivered but not received parcel","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for a delivered but not received parcel","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/delivered-but-not-received","href":"/api/v3/support/create-a-ticket-for-a-delivered-but-not-received-parcel"},{"title":"Create a ticket for an address change","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for an address change","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/address-change","href":"/api/v3/support/create-a-ticket-for-an-address-change"},{"title":"Create a ticket for an unjustly returned parcel","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for an unjustly returned parcel","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/unjust-return","href":"/api/v3/support/create-a-ticket-for-an-unjustly-returned-parcel"},{"title":"Create a ticket for another issue","deprecated":null,"version":null,"sidebarTitle":"Create a ticket for another issue","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/other","href":"/api/v3/support/create-a-ticket-for-another-issue"},{"title":"Retrieve support tickets","deprecated":null,"version":null,"sidebarTitle":"Retrieve support tickets","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml get /dsf/tickets","href":"/api/v3/support/retrieve-support-tickets"},{"title":"Retrieve a support ticket","deprecated":null,"version":null,"sidebarTitle":"Retrieve a support ticket","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml get /dsf/tickets/{ticket_id}","href":"/api/v3/support/retrieve-a-support-ticket"}]},{"group":"Ticket data \u0026 attachments","icon":"paperclip","pages":[{"title":"Retrieve requested data for open tickets","deprecated":null,"version":null,"sidebarTitle":"Retrieve requested data for open tickets","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml get /dsf/tickets/requested-data","href":"/api/v3/support/retrieve-requested-data-for-open-tickets"},{"title":"Create a requested data response","deprecated":null,"version":null,"sidebarTitle":"Provide requested data","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/tickets/requested-data","href":"/api/v3/support/provide-requested-data"},{"title":"Upload a file","deprecated":null,"version":null,"sidebarTitle":"Files","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/files","href":"/api/v3/support/files"},{"title":"Create a claim letter","deprecated":null,"version":null,"sidebarTitle":"Generate claim letter","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/documents/generate/claim-letter","href":"/api/v3/support/generate-claim-letter"},{"title":"Create a sales invoice","deprecated":null,"version":null,"sidebarTitle":"Generate sales invoice","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/documents/generate/invoice","href":"/api/v3/support/generate-sales-invoice"}]},{"group":"Carrier support contacts","icon":"address-book","pages":[{"title":"Create carrier support contact","deprecated":null,"version":null,"sidebarTitle":"Create carrier support contact","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml post /dsf/carrier-support-contacts","href":"/api/v3/support/create-carrier-support-contact"},{"title":"Retrieve carrier support contacts","deprecated":null,"version":null,"sidebarTitle":"Retrieve carrier support contacts","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml get /dsf/carrier-support-contacts","href":"/api/v3/support/retrieve-carrier-support-contacts"},{"title":"Update a carrier support contact","deprecated":null,"version":null,"sidebarTitle":"Update a carrier support contact","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml patch /dsf/carrier-support-contacts/{id}","href":"/api/v3/support/update-a-carrier-support-contact"},{"title":"Delete a carrier support contact","deprecated":null,"version":null,"sidebarTitle":"Delete a carrier support contact","tag":"Beta","openapi":"/.openapi/v3/support/openapi.yaml delete /dsf/carrier-support-contacts/{id}","href":"/api/v3/support/delete-a-carrier-support-contact"}]}]}]},{"group":"Events \u0026 notifications","icon":"bell","pages":[{"group":"Webhooks (payload reference)","icon":"webhook","pages":[{"title":"Webhooks overview","href":"/api/v3/webhooks/index"},{"title":"Parcel status changed","version":null,"deprecated":null,"openapi":"/.openapi/v3/webhooks/openapi.yaml webhook ParcelStatusChanged","href":"/api/v3/webhooks/parcel-status-changed"},{"title":"Return created","version":null,"deprecated":null,"openapi":"/.openapi/v3/webhooks/openapi.yaml webhook ReturnCreated","href":"/api/v3/webhooks/return-created"},{"title":"Integration connected","version":null,"deprecated":null,"openapi":"/.openapi/v3/webhooks/openapi.yaml webhook IntegrationConnected","href":"/api/v3/webhooks/integration-connected"},{"title":"Integration modified","version":null,"deprecated":null,"openapi":"/.openapi/v3/webhooks/openapi.yaml webhook IntegrationModified","href":"/api/v3/webhooks/integration-modified"},{"title":"Integration deleted","version":null,"deprecated":null,"openapi":"/.openapi/v3/webhooks/openapi.yaml webhook IntegrationDeleted","href":"/api/v3/webhooks/integration-deleted"}]},{"group":"Events API","icon":"clock-rotate-left","pages":[{"title":"Retrieve a list of events","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of events","tag":"Beta","openapi":"/.openapi/v3/events/openapi.yaml get /events","href":"/api/v3/events/retrieve-a-list-of-events"}]},{"group":"Event subscriptions","icon":"bell","pages":[{"title":"Event Subscriptions API overview","href":"/api/v3/event-subscriptions/index"},{"group":"Connections","icon":"link","pages":[{"title":"Create a connection","deprecated":null,"version":null,"sidebarTitle":"Create a connection","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml post /event-subscriptions/connections","href":"/api/v3/event-subscriptions/create-a-connection"},{"title":"List connections","deprecated":null,"version":null,"sidebarTitle":"List connections","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml get /event-subscriptions/connections","href":"/api/v3/event-subscriptions/list-connections"},{"title":"Get a connection","deprecated":null,"version":null,"sidebarTitle":"Get a connection","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml get /event-subscriptions/connections/{id}","href":"/api/v3/event-subscriptions/get-a-connection"},{"title":"Update a connection","deprecated":null,"version":null,"sidebarTitle":"Update a connection","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml patch /event-subscriptions/connections/{id}","href":"/api/v3/event-subscriptions/update-a-connection"},{"title":"Delete a connection","deprecated":null,"version":null,"sidebarTitle":"Delete a connection","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml delete /event-subscriptions/connections/{id}","href":"/api/v3/event-subscriptions/delete-a-connection"},{"title":"Start OAuth2 authorization","deprecated":null,"version":null,"sidebarTitle":"Start oauth2 authorization","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml post /event-subscriptions/connections/{id}/authorization","href":"/api/v3/event-subscriptions/start-oauth2-authorization"}]},{"group":"Subscriptions","icon":"rss","pages":[{"title":"Create a subscription","deprecated":null,"version":null,"sidebarTitle":"Create a subscription","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml post /event-subscriptions/subscriptions","href":"/api/v3/event-subscriptions/create-a-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"sidebarTitle":"List subscriptions","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml get /event-subscriptions/subscriptions","href":"/api/v3/event-subscriptions/list-subscriptions"},{"title":"Get a subscription","deprecated":null,"version":null,"sidebarTitle":"Get a subscription","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml get /event-subscriptions/subscriptions/{id}","href":"/api/v3/event-subscriptions/get-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"sidebarTitle":"Update a subscription","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml patch /event-subscriptions/subscriptions/{id}","href":"/api/v3/event-subscriptions/update-a-subscription"},{"title":"Delete a subscription","deprecated":null,"version":null,"sidebarTitle":"Delete a subscription","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml delete /event-subscriptions/subscriptions/{id}","href":"/api/v3/event-subscriptions/delete-a-subscription"}]},{"title":"Broadcast test event","deprecated":null,"version":null,"sidebarTitle":"Test event delivery","openapi":"/.openapi/v3/event-subscriptions/openapi.yaml post /event-subscriptions/broadcast/test/{subscription_id}","href":"/api/v3/event-subscriptions/test-event-delivery"},{"group":"Event payloads","icon":"code","pages":[{"title":"Parcel event created","version":null,"deprecated":null,"openapi":"/.openapi/v3/event-subscriptions/openapi.yaml webhook ParcelEventCreated","href":"/api/v3/event-subscriptions/parcel-event-created"},{"title":"Parcel created","version":null,"deprecated":null,"openapi":"/.openapi/v3/event-subscriptions/openapi.yaml webhook ParcelCreated","href":"/api/v3/event-subscriptions/parcel-created"}]}]}]},{"group":"Carriers \u0026 pickups","icon":"truck","pages":[{"group":"Contracts","icon":"file-contract","pages":[{"title":"Contracts API overview","href":"/api/v3/contracts/index"},{"title":"Retrieve a list of contract schemas","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of contract schemas","openapi":"/.openapi/v3/contracts/openapi.yaml get /contracts/schemas","href":"/api/v3/contracts/retrieve-a-list-of-contract-schemas"},{"title":"Create a contract for a carrier","deprecated":null,"version":null,"sidebarTitle":"Create a contract for a carrier","openapi":"/.openapi/v3/contracts/openapi.yaml post /contracts","href":"/api/v3/contracts/create-a-contract-for-a-carrier"},{"title":"Retrieve a list of contracts","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of contracts","openapi":"/.openapi/v3/contracts/openapi.yaml get /contracts","href":"/api/v3/contracts/retrieve-a-list-of-contracts"},{"title":"Retrieve a contract","deprecated":null,"version":null,"sidebarTitle":"Retrieve a contract","openapi":"/.openapi/v3/contracts/openapi.yaml get /contracts/{id}","href":"/api/v3/contracts/retrieve-a-contract"},{"title":"Update a contract","deprecated":null,"version":null,"sidebarTitle":"Update a contract","openapi":"/.openapi/v3/contracts/openapi.yaml patch /contracts/{id}","href":"/api/v3/contracts/update-a-contract"},{"title":"Delete a contract","deprecated":null,"version":null,"sidebarTitle":"Delete a contract","openapi":"/.openapi/v3/contracts/openapi.yaml delete /contracts/{id}","href":"/api/v3/contracts/delete-a-contract"}]},{"group":"Pickups","icon":"hand-holding-box","pages":[{"title":"Pickups API overview","href":"/api/v3/pickups/index"},{"title":"Create a pickup","deprecated":null,"version":null,"sidebarTitle":"Create a pickup","openapi":"/.openapi/v3/pickups/openapi.yaml post /pickups","href":"/api/v3/pickups/create-a-pickup"},{"title":"Retrieve a list of pickups","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of pickups","openapi":"/.openapi/v3/pickups/openapi.yaml get /pickups","href":"/api/v3/pickups/retrieve-a-list-of-pickups"},{"title":"Retrieve a pickup","deprecated":null,"version":null,"sidebarTitle":"Retrieve a pickup","openapi":"/.openapi/v3/pickups/openapi.yaml get /pickups/{id}","href":"/api/v3/pickups/retrieve-a-pickup"},{"title":"Cancel a pickup","deprecated":null,"version":null,"sidebarTitle":"Cancel a pickup","openapi":"/.openapi/v3/pickups/openapi.yaml post /pickups/{id}/cancel","href":"/api/v3/pickups/cancel-a-pickup"}]},{"group":"Carrier-specific: Deutsche Post","icon":"truck","pages":[{"title":"Finalize a Deutsche Post order","deprecated":null,"version":null,"sidebarTitle":"Finalize a deutsche post order","openapi":"/.openapi/v3/carriers-dp/openapi.yaml post /carriers/dp/finalize-order","href":"/api/v3/carriers-dp/finalize-a-deutsche-post-order"}]}]},{"group":"Financial","icon":"euro-sign","pages":[{"group":"Invoices","icon":"file-invoice","pages":[{"title":"Invoices API overview","href":"/api/v3/invoices/index"},{"title":"Retrieve a list of invoices","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of invoices","openapi":"/.openapi/v3/invoices/openapi.yaml get /invoices","href":"/api/v3/invoices/retrieve-a-list-of-invoices"},{"title":"Retrieve an invoice","deprecated":null,"version":null,"sidebarTitle":"Retrieve an invoice","openapi":"/.openapi/v3/invoices/openapi.yaml get /invoices/{invoice_id}","href":"/api/v3/invoices/retrieve-an-invoice"}]},{"group":"Invoice items","icon":"file-invoice-dollar","pages":[{"title":"Invoice Items API overview","href":"/api/v3/invoice-items/index"},{"title":"Retrieve a list of invoice items","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of invoice items","openapi":"/.openapi/v3/invoice-items/openapi.yaml get /invoice-items","href":"/api/v3/invoice-items/retrieve-a-list-of-invoice-items"},{"title":"Retrieve an invoice item","deprecated":null,"version":null,"sidebarTitle":"Retrieve an invoice item","openapi":"/.openapi/v3/invoice-items/openapi.yaml get /invoice-items/{invoice_item_id}","href":"/api/v3/invoice-items/retrieve-an-invoice-item"}]},{"group":"Exchange rates","icon":"money-bill-transfer","pages":[{"title":"Exchange Rates API overview","href":"/api/v3/exchange-rates/index"},{"title":"Retrieve exchange rates","description":"Retrieve a paginated list of the rates for one currency pair, one rate per day, newest first.\n\nThe rate includes the currency conversion fee. It is the rate an invoice item dated on that day converts at. A day without a stored rate is left out. When `from_currency` and `to_currency` are the same, the list is empty.\n\nThis endpoint uses cursor-based pagination via `Link` headers. See [Pagination](/api/v3/pagination) for details.","deprecated":null,"version":null,"sidebarTitle":"Retrieve exchange rates","openapi":"/.openapi/v3/exchange-rates/openapi.yaml get /exchange-rates","href":"/api/v3/exchange-rates/retrieve-exchange-rates"}]}]},{"group":"Data \u0026 insights","icon":"chart-line","pages":[{"group":"Analytics","icon":"chart-line","pages":[{"title":"Analytics API overview","href":"/api/v3/analytics/index"},{"title":"Retrieve carrier transit times","description":"Returns aggregated transit-time statistics per carrier, optionally filtered by origin and destination country and a date window.","deprecated":null,"version":null,"sidebarTitle":"Retrieve carrier transit times","tag":"Beta","openapi":"/.openapi/v3/analytics/openapi.yaml get /analytics/transit-times/carriers","href":"/api/v3/analytics/retrieve-carrier-transit-times"},{"title":"Retrieve shipping option transit times","deprecated":null,"version":null,"sidebarTitle":"Retrieve shipping option transit times","tag":"Beta","openapi":"/.openapi/v3/analytics/openapi.yaml get /analytics/transit-times/shipping-options","href":"/api/v3/analytics/retrieve-shipping-option-transit-times"}]},{"group":"Reporting","icon":"file-chart-column","pages":[{"title":"Reporting API overview","href":"/api/v3/reporting/index"},{"title":"Create a parcels report","deprecated":null,"version":null,"sidebarTitle":"Create a parcels report","openapi":"/.openapi/v3/reporting/openapi.yaml post /reporting/parcels","href":"/api/v3/reporting/create-a-parcels-report"},{"title":"Retrieve a parcels report","deprecated":null,"version":null,"sidebarTitle":"Retrieve a parcels report","openapi":"/.openapi/v3/reporting/openapi.yaml get /reporting/parcels/{report_id}","href":"/api/v3/reporting/retrieve-a-parcels-report"}]}]},{"group":"Integrations","icon":"plug","pages":[{"group":"Manage integrations","icon":"plug","pages":[{"title":"Integrations API overview","href":"/api/v3/integrations/index"},{"title":"Retrieve a list of integrations","deprecated":null,"version":null,"sidebarTitle":"Retrieve a list of integrations","openapi":"/.openapi/v3/integrations/openapi.yaml get /integrations","href":"/api/v3/integrations/retrieve-a-list-of-integrations"},{"title":"Retrieve an integration","deprecated":null,"version":null,"sidebarTitle":"Retrieve an integration","openapi":"/.openapi/v3/integrations/openapi.yaml get /integrations/{id}","href":"/api/v3/integrations/retrieve-an-integration"},{"title":"Update certain parts of an integration","deprecated":null,"version":null,"sidebarTitle":"Update certain parts of an integration","openapi":"/.openapi/v3/integrations/openapi.yaml patch /integrations/{id}","href":"/api/v3/integrations/update-certain-parts-of-an-integration"},{"title":"Delete an integration","deprecated":null,"version":null,"sidebarTitle":"Delete an integration","openapi":"/.openapi/v3/integrations/openapi.yaml delete /integrations/{id}","href":"/api/v3/integrations/delete-an-integration"}]},{"group":"Shop order statuses","icon":"clipboard-list","pages":[{"title":"Create or overwrite shop order statuses","deprecated":null,"version":null,"sidebarTitle":"Create or overwrite shop order statuses","openapi":"/.openapi/v3/integrations/openapi.yaml post /shop-order-statuses","href":"/api/v3/integrations/create-or-overwrite-shop-order-statuses"},{"title":"Retrieve shop order statuses for an integration","deprecated":null,"version":null,"sidebarTitle":"Retrieve shop order statuses for an integration","openapi":"/.openapi/v3/integrations/openapi.yaml get /shop-order-statuses","href":"/api/v3/integrations/retrieve-shop-order-statuses-for-an-integration"}]},{"group":"Custom status mapping","icon":"shuffle","pages":[{"title":"Create or update custom status mapping for an integration","deprecated":null,"version":null,"sidebarTitle":"Create or update custom status mapping for an integration","openapi":"/.openapi/v3/integrations/openapi.yaml post /shop-order-statuses/mapping","href":"/api/v3/integrations/create-or-update-custom-status-mapping-for-an-integration"},{"title":"Retrieve custom status mapping for an integration","deprecated":null,"version":null,"sidebarTitle":"Retrieve custom status mapping for an integration","openapi":"/.openapi/v3/integrations/openapi.yaml get /shop-order-statuses/mapping","href":"/api/v3/integrations/retrieve-custom-status-mapping-for-an-integration"}]},{"group":"Exception logs","icon":"exclamation-triangle","pages":[{"title":"Create integration exception logs","deprecated":null,"version":null,"sidebarTitle":"Create integration exception logs","openapi":"/.openapi/v3/integrations/openapi.yaml post /integrations/{id}/logs","href":"/api/v3/integrations/create-integration-exception-logs"},{"title":"Retrieve all integration exception logs","deprecated":null,"version":null,"sidebarTitle":"Retrieve all integration exception logs","openapi":"/.openapi/v3/integrations/openapi.yaml get /integrations/logs","href":"/api/v3/integrations/retrieve-all-integration-exception-logs"},{"title":"Retrieve exception logs for a specific integration","deprecated":null,"version":null,"sidebarTitle":"Retrieve exception logs for a specific integration","openapi":"/.openapi/v3/integrations/openapi.yaml get /integrations/{id}/logs","href":"/api/v3/integrations/retrieve-exception-logs-for-a-specific-integration"}]}]}]},{"tab":"API v2","pages":[{"title":"API v2","href":"/api/v2"}]}]},"basePath":"","title":"Analytics API overview - Sendcloud API Developer Portal","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}