Production: Generate your API key directly in the ParcelTracer dashboard under Settings → API Keys.Testing: Need to test our endpoints from the documentation directly? Contact us to get a sandbox API key for exploring the documentation.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Parcel Tracer","colors":{"primary":"#71459A","light":"#71459A","dark":"#1a1625"},"logo":{"light":"https://mintcdn.com/parceltracer-a1366534/TGyU19e1IXblA6lx/logo/main-logo.png?fit=max\u0026auto=format\u0026n=TGyU19e1IXblA6lx\u0026q=85\u0026s=cd734da7bdef714edd1e3dc448027cf7","dark":"https://mintcdn.com/parceltracer-a1366534/TGyU19e1IXblA6lx/logo/main-logo.png?fit=max\u0026auto=format\u0026n=TGyU19e1IXblA6lx\u0026q=85\u0026s=cd734da7bdef714edd1e3dc448027cf7"},"favicon":"https://mintcdn.com/parceltracer-a1366534/Pr_zNRHn-86CPyJP/favicon.png?fit=max\u0026auto=format\u0026n=Pr_zNRHn-86CPyJP\u0026q=85\u0026s=747496fb7ec4ff2da1fd1b50b26daded","appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:info@parceltracer.app","label":"Contact Us"}],"primary":{"type":"button","label":"Open App","href":"https://prod.parceltracer.app"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"parceltracer-a1366534","hasAudioNarration":false,"actualSubdomain":"parceltracer-a1366534","customDomains":["docs.parceltracer.app"],"gitSource":{"type":"github","owner":"parcel-tracer","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":"","_id":"6ae253bd8ad9c4c68b8f6485"},"entitlements":{},"buildId":"6ae254b84f6447c3e7dee6b3","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API Reference","count":29},{"language":"default","tag":"Endpoints","count":22},{"language":"default","tag":"Models","count":6},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"Areas","count":4},{"language":"default","tag":"Customer Locations","count":4},{"language":"default","tag":"Customers","count":4},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Invoices","count":2},{"language":"default","tag":"Introduction","count":1}]},"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":"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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":[]}
{"page":{"pagePath":"api-reference/quickstart","slug":"/api-reference/quickstart","pageMetadata":{"title":"Quickstart","description":null,"href":"/api-reference/quickstart"},"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={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Card,CardGroup,CodeBlock,CodeGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`The Parcel Tracer API helps delivery companies track orders, drivers, and businesses through our powerful REST API.`}),`\n`,_jsxs(CardGroup,{cols:2,children:[_jsx(Card,{title:`Data Models`,icon:`database`,href:`/models`,children:_jsx(_components.p,{children:`Understand the schema for Customers, Orders, and Locations.`})}),_jsx(Card,{title:`API Reference`,icon:`code`,href:`/api-reference/areas`,children:_jsx(_components.p,{children:`Explore all available endpoints and their parameters`})})]}),`\n`,_jsx(Heading,{level:`3`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(_components.p,{children:`Every API request requires an API key for authentication. Always include your API key in the request header:`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.parceltracer.com/v1/external/{endpoint}`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --header`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-Api-Key: \u003capi-key>'`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`Python`,numberOfLines:`8`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`8`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`url `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://api.parceltracer.com/v1/external/`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`{endpoint}`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003capi-key>\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`response `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` requests.get(url, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`headers`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`headers)`})]}),`\n`]})})}),_jsx(CodeBlock,{filename:`JavaScript`,numberOfLines:`6`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`6`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` response`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` fetch`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'https://api.parceltracer.com/v1/external/{endpoint}'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` method:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'GET'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` headers:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'X-Api-Key'`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '\u003capi-key>'`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`});`})}),`\n`]})})})]}),`\n`,_jsx(Heading,{level:`3`,id:`getting-your-api-key`,children:`Getting Your API Key`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Production:`}),` Generate your API key directly in the ParcelTracer dashboard under Settings → API Keys.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Testing:`}),` Need to test our endpoints from the documentation directly? `,_jsx(_components.a,{href:`mailto:info@parceltracer.app`,children:`Contact us`}),` to get a sandbox API key for exploring the documentation.`]})]})}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":"Quickstart","description":null,"href":"/api-reference/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authentication","slug":"authentication","depth":3,"children":[]},{"title":"Getting Your API Key","slug":"getting-your-api-key","depth":3,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/parceltracer-a1366534/8a81bb8703fb213a/scripts/generate-brand-privacy.js"],"subdomain":"parceltracer-a1366534","siteName":"Parcel Tracer","title":"Quickstart - Parcel Tracer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T20:02:07.147Z","originalFileLocation":"api-reference/quickstart.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}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=\"Parcel Tracer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Quickstart - Parcel Tracer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Parcel Tracer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.parceltracer.app/api-reference/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://parceltracer-a1366534.mintlify.site/_mintlify/api/og/v2?division=Introduction\u0026amp;title=Quickstart\u0026amp;theme=32b34b306740a02b947ff9f8\u0026amp;signature=d6bd1331c4eb9de3e506adeb9ae5b397cd0c7d32333dbd176feb48b22db0a0ed\">\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=\"Quickstart - Parcel Tracer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://parceltracer-a1366534.mintlify.site/_mintlify/api/og/v2?division=Introduction\u0026amp;title=Quickstart\u0026amp;theme=32b34b306740a02b947ff9f8\u0026amp;signature=d6bd1331c4eb9de3e506adeb9ae5b397cd0c7d32333dbd176feb48b22db0a0ed\">\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/parceltracer-a1366534/yWSrsxMnDb3-h2jf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Parcel Tracer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#71459A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.parceltracer.app/api-reference/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/quickstart.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.parceltracer.app/#organization\",\"name\":\"Parcel Tracer\",\"url\":\"https://docs.parceltracer.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/parceltracer-a1366534/TGyU19e1IXblA6lx/logo/main-logo.png?fit=max\u0026auto=format\u0026n=TGyU19e1IXblA6lx\u0026q=85\u0026s=cd734da7bdef714edd1e3dc448027cf7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.parceltracer.app#website\",\"name\":\"Parcel Tracer\",\"url\":\"https://docs.parceltracer.app\",\"publisher\":{\"@id\":\"https://docs.parceltracer.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.parceltracer.app/api-reference/quickstart#webpage\",\"url\":\"https://docs.parceltracer.app/api-reference/quickstart\",\"name\":\"Quickstart\",\"dateModified\":\"2026-10-28T20:02:07.147Z\",\"isPartOf\":{\"@id\":\"https://docs.parceltracer.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.parceltracer.app/api-reference/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.parceltracer.app/api-reference/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Parcel Tracer\",\"item\":\"https://docs.parceltracer.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.parceltracer.app/api-reference/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.parceltracer.app/api-reference/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"url\":\"https://docs.parceltracer.app/api-reference/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.parceltracer.app/api-reference/quickstart#webpage\"},\"dateModified\":\"2026-10-28T20:02:07.147Z\",\"publisher\":{\"@id\":\"https://docs.parceltracer.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.parceltracer.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Parcel Tracer\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Parcel Tracer\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/quickstart.md","siteName":"Parcel Tracer","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Quickstart","href":"/api-reference/quickstart"}]},{"group":"Models","pages":[{"title":"Customer","description":"Customers are at the heart of the delivery process. They receive orders from or return orders back to shops.","href":"/models/customers"},{"title":"Area","href":"/models/areas"},{"title":"Customer Locations","href":"/models/customer-locations"},{"title":"Order","href":"/models/orders"},{"title":"Invoice","href":"/models/invoices"},{"title":"Profile","href":"/models/profile"}]},{"group":"Endpoints","pages":[{"group":"Areas","pages":[{"title":"List Avaialable Areas","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /areas/","href":"/api-reference/areas/list-avaialable-areas"},{"title":"Create External Area","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /areas/create/","href":"/api-reference/areas/create-external-area"},{"title":"Resolve Free Address","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /resolve-address/","href":"/api-reference/areas/resolve-free-address"},{"title":"Resolve Coordinates to Area","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /resolve-coordinates/","href":"/api-reference/areas/resolve-coordinates-to-area"}]},{"group":"Customers","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /customers/","href":"/api-reference/customers/list-customers"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /customers/","href":"/api-reference/customers/create-customer"},{"title":"Retrieve customer","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /customers/{id}/","href":"/api-reference/customers/retrieve-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml patch /customers/{id}/","href":"/api-reference/customers/update-customer"}]},{"group":"Customer Locations","pages":[{"title":"List customer locations","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /customers/{customer_pk}/locations/","href":"/api-reference/customer-locations/list-customer-locations"},{"title":"Create customer location","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /customers/{customer_pk}/locations/","href":"/api-reference/customer-locations/create-customer-location"},{"title":"Retrieve customer location","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /customers/{customer_pk}/locations/{location_pk}/","href":"/api-reference/customer-locations/retrieve-customer-location"},{"title":"Update customer location","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml patch /customers/{customer_pk}/locations/{location_pk}/","href":"/api-reference/customer-locations/update-customer-location"}]},{"group":"Invoices","pages":[{"title":"List merchant invoices","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /invoices/","href":"/api-reference/invoices/list-merchant-invoices"},{"title":"Retrieve a merchant invoice","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /invoices/{invoice_number}/","href":"/api-reference/invoices/retrieve-a-merchant-invoice"}]},{"group":"Orders","pages":[{"title":"List orders","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /orders/","href":"/api-reference/orders/list-orders"},{"title":"Create order","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /orders/","href":"/api-reference/orders/create-order"},{"title":"Retrieve order","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /orders/{order_id}/","href":"/api-reference/orders/retrieve-order"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml patch /orders/{order_id}/","href":"/api-reference/orders/update-order"},{"title":"Cancel order","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /orders/{order_id}/cancel/","href":"/api-reference/orders/cancel-order"},{"title":"Request pickup for an order","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml post /orders/{order_id}/request-pickup/","href":"/api-reference/orders/request-pickup-for-an-order"}]},{"group":"Pickup Locations","pages":[{"title":"List Pickup Locations","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /pickups/","href":"/api-reference/pickup-locations/list-pickup-locations"}]},{"group":"Profile","pages":[{"title":"Get Organisation Profile","deprecated":null,"version":null,"openapi":"/api-reference/schema.yaml get /profile/","href":"/api-reference/profile/get-organisation-profile"}]}]}]},{"tab":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/getting-started"}]},{"tab":"Privacy Policy","pages":[{"title":"Privacy Policy","href":"/privacy-policy"}]}]},"basePath":"","title":"Quickstart - Parcel Tracer","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":[],"chunks":[]}