Create vendor API keys and understand permission scopes
Overview
Vendor API keys let you authenticate with the PuppetVendors API programmatically. Each key is scoped to a single vendor account and can be restricted to specific permissions.
Key Prefixes
Prefix
Mode
Description
vk_live
Live
Full access to real data
vk_test
Test
For development and testing
Available Scopes
Every API key must have at least one scope. Each scope grants access to a specific set of endpoints.
Scope
Access
Endpoints
orders:read
Read orders, counts, timeline
GET /orders, GET /orders/:id, GET /orders/counts, GET /orders/:id/timeline
orders:write
Add order timeline comments
POST /orders/:id/timeline
products:read
Read products, counts
GET /products, GET /products/:id, GET /products/counts
products:write
Create, update, delete products, manage inventory and media
POST /products, PUT /products/:id, DELETE /products/:id, PATCH /products/:id/status, PATCH /products/:id/inventory, POST /products/media
fulfillments:read
Read fulfillments, counts, stats, events
GET /fulfillments, GET /fulfillments/counts, GET /fulfillments/stats, GET /fulfillments/events/:lineItemId
fulfillments:write
Create and update fulfillments, manage events
POST /fulfillments, PUT /fulfillments/:id, POST /fulfillments/events/:lineItemId, POST /fulfillments/events/bulk
Account, profile settings, shipping rates, warehouses, team members
Integrations
Shippo, ShipStation, PayPal, Stripe configuration
Documents
Invoice, packing slip, shipping label generation
Shop
Feature flags and product configuration
How Scopes Work
When you create an API key, you choose which scopes to include. The API rejects requests that require a scope your key doesn’t have with 403 Forbidden.
Read vs Write
:read scopes grant access to GET endpoints — listing, viewing, and exporting data
:write scopes grant access to POST, PUT, PATCH, and DELETE endpoints — creating, updating, and deleting data
Write scopes do not automatically include read access. If you need both, add both scopes (e.g., products:read and products:write).
Managing API Keys
Action
Endpoint
Description
List keys
GET /settings/public-api/keys
See all your API keys (tokens are masked)
Create key
POST /settings/public-api/keys
Create a new key — token shown once
Rotate key
POST /settings/public-api/keys/:keyId/rotate
Generate a new token, old one is invalidated
Delete key
DELETE /settings/public-api/keys/:keyId
Permanently revoke a key
When you create or rotate a key, the plaintext token is returned exactly once. Store it securely — you cannot retrieve it later.
Quick Start Example
# 1. Authenticate with your vendor API keycurl -X POST https://production-api.puppetvendors.com/authenticate \ -H "Content-Type: application/json" \ -d '{"apiKey": "vk_live_abc123..."}'# Response: {"success": true, "data": {"token": "eyJ...", "expiresIn": 86400}}# 2. Use the JWT token for subsequent requestscurl -X GET "https://production-api.puppetvendors.com/orders?first=10" \ -H "x-access-token: eyJ..."
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"PuppetVendors API","colors":{"primary":"#6366F1","light":"#818CF8","dark":"#4F46E5"},"logo":{"light":"https://mintcdn.com/puppetvendors-26/j4NQfmVPdX-HgZdK/logo/light.svg?fit=max\u0026auto=format\u0026n=j4NQfmVPdX-HgZdK\u0026q=85\u0026s=334773803bc34a3293e61a5efa488140","dark":"https://mintcdn.com/puppetvendors-26/j4NQfmVPdX-HgZdK/logo/dark.svg?fit=max\u0026auto=format\u0026n=j4NQfmVPdX-HgZdK\u0026q=85\u0026s=203f04ba19ba014e8b2e5d16adb535dd"},"favicon":"https://mintcdn.com/puppetvendors-26/sD9D69AzyUrevT_4/favicon.svg?fit=max\u0026auto=format\u0026n=sD9D69AzyUrevT_4\u0026q=85\u0026s=da8f4187f7e57f1a74e0b540a4b31f87","api":{"mdx":{"auth":{"method":"key","name":"x-access-token"},"server":"https://production-api.puppetvendors.com"}},"navbar":{"links":[{"href":"mailto:support@puppetvendors.com","label":"Support"}]},"footer":{},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"PuppetVendors","icon":"globe","href":"https://puppetvendors.com"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"puppetvendors-26","hasAudioNarration":false,"actualSubdomain":"puppetvendors-26","customDomains":["dev.puppetvendors.com"],"gitSource":{"type":"github","owner":"puppetvendors","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adcc9066fc254ddb8b5a521","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Vendors - V2","count":100},{"language":"default","tag":"Merchants - V2","count":48},{"language":"default","tag":"API V1","count":27},{"language":"default","tag":"Products","count":27},{"language":"default","tag":"Vendors","count":19},{"language":"default","tag":"Payouts","count":16},{"language":"default","tag":"Users","count":15},{"language":"default","tag":"Integrations","count":13},{"language":"default","tag":"Getting Started","count":10},{"language":"default","tag":"Fulfillments","count":7}]},"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":"site-roles","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":[]}
{"page":{"pagePath":"api-reference/v2/vendor/api-keys-scopes","slug":"/api-reference/v2/vendor/api-keys-scopes","pageMetadata":{"title":"API Keys \u0026 Scopes","description":"Create vendor API keys and understand permission scopes","href":"/api-reference/v2/vendor/api-keys-scopes"},"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: \"Create vendor API keys and understand permission scopes\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`overview`,children:`Overview`}),`\n`,_jsx(_components.p,{children:`Vendor API keys let you authenticate with the PuppetVendors API programmatically. Each key is scoped to a single vendor account and can be restricted to specific permissions.`}),`\n`,_jsx(Heading,{level:`2`,id:`key-prefixes`,children:`Key Prefixes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Prefix`}),_jsx(_components.th,{children:`Mode`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vk_live`})}),_jsx(_components.td,{children:`Live`}),_jsx(_components.td,{children:`Full access to real data`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`vk_test`})}),_jsx(_components.td,{children:`Test`}),_jsx(_components.td,{children:`For development and testing`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`available-scopes`,children:`Available Scopes`}),`\n`,_jsx(_components.p,{children:`Every API key must have at least one scope. Each scope grants access to a specific set of endpoints.`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Scope`}),_jsx(_components.th,{children:`Access`}),_jsx(_components.th,{children:`Endpoints`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orders:read`})}),_jsx(_components.td,{children:`Read orders, counts, timeline`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /orders`}),`, `,_jsx(_components.code,{children:`GET /orders/:id`}),`, `,_jsx(_components.code,{children:`GET /orders/counts`}),`, `,_jsx(_components.code,{children:`GET /orders/:id/timeline`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`orders:write`})}),_jsx(_components.td,{children:`Add order timeline comments`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /orders/:id/timeline`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`products:read`})}),_jsx(_components.td,{children:`Read products, counts`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /products`}),`, `,_jsx(_components.code,{children:`GET /products/:id`}),`, `,_jsx(_components.code,{children:`GET /products/counts`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`products:write`})}),_jsx(_components.td,{children:`Create, update, delete products, manage inventory and media`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /products`}),`, `,_jsx(_components.code,{children:`PUT /products/:id`}),`, `,_jsx(_components.code,{children:`DELETE /products/:id`}),`, `,_jsx(_components.code,{children:`PATCH /products/:id/status`}),`, `,_jsx(_components.code,{children:`PATCH /products/:id/inventory`}),`, `,_jsx(_components.code,{children:`POST /products/media`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`fulfillments:read`})}),_jsx(_components.td,{children:`Read fulfillments, counts, stats, events`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /fulfillments`}),`, `,_jsx(_components.code,{children:`GET /fulfillments/counts`}),`, `,_jsx(_components.code,{children:`GET /fulfillments/stats`}),`, `,_jsx(_components.code,{children:`GET /fulfillments/events/:lineItemId`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`fulfillments:write`})}),_jsx(_components.td,{children:`Create and update fulfillments, manage events`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /fulfillments`}),`, `,_jsx(_components.code,{children:`PUT /fulfillments/:id`}),`, `,_jsx(_components.code,{children:`POST /fulfillments/events/:lineItemId`}),`, `,_jsx(_components.code,{children:`POST /fulfillments/events/bulk`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`payouts:read`})}),_jsx(_components.td,{children:`Read payouts, transactions, pending items, summaries`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /payouts`}),`, `,_jsx(_components.code,{children:`GET /payouts/:id`}),`, `,_jsx(_components.code,{children:`GET /payouts/summary`}),`, `,_jsx(_components.code,{children:`GET /payouts/transactions`}),`, `,_jsx(_components.code,{children:`GET /payouts/pending`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`customers:read`})}),_jsx(_components.td,{children:`Read customer list`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /customers`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`unscoped-endpoints`,children:`Unscoped Endpoints`}),`\n`,_jsxs(_components.p,{children:[`These endpoints work with `,_jsx(_components.strong,{children:`any valid vendor token`}),` — no specific scope required on your API key:`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Group`}),_jsx(_components.th,{children:`Endpoints`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Discounts`})}),_jsx(_components.td,{children:`List, create, update, delete discounts`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Profile`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET/PUT /vendors/me/profile`}),`, `,_jsx(_components.code,{children:`GET/PUT /vendors/me/address`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Settings`})}),_jsx(_components.td,{children:`Account, profile settings, shipping rates, warehouses, team members`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Integrations`})}),_jsx(_components.td,{children:`Shippo, ShipStation, PayPal, Stripe configuration`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Documents`})}),_jsx(_components.td,{children:`Invoice, packing slip, shipping label generation`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:`Shop`})}),_jsx(_components.td,{children:`Feature flags and product configuration`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`how-scopes-work`,children:`How Scopes Work`}),`\n`,_jsxs(_components.p,{children:[`When you create an API key, you choose which scopes to include. The API rejects requests that require a scope your key doesn’t have with `,_jsx(_components.code,{children:`403 Forbidden`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`read-vs-write`,children:`Read vs Write`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`:read`}),` scopes`]}),` grant access to `,_jsx(_components.code,{children:`GET`}),` endpoints — listing, viewing, and exporting data`]}),`\n`,_jsxs(_components.li,{children:[_jsxs(_components.strong,{children:[_jsx(_components.code,{children:`:write`}),` scopes`]}),` grant access to `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PUT`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, and `,_jsx(_components.code,{children:`DELETE`}),` endpoints — creating, updating, and deleting data`]}),`\n`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`Write scopes do `,_jsx(_components.strong,{children:`not`}),` automatically include read access. If you need both, add both scopes (e.g., `,_jsx(_components.code,{children:`products:read`}),` and `,_jsx(_components.code,{children:`products:write`}),`).`]})}),`\n`,_jsx(Heading,{level:`2`,id:`managing-api-keys`,children:`Managing API Keys`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Action`}),_jsx(_components.th,{children:`Endpoint`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`List keys`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`GET /settings/public-api/keys`})}),_jsx(_components.td,{children:`See all your API keys (tokens are masked)`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Create key`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /settings/public-api/keys`})}),_jsxs(_components.td,{children:[`Create a new key — `,_jsx(_components.strong,{children:`token shown once`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Rotate key`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /settings/public-api/keys/:keyId/rotate`})}),_jsx(_components.td,{children:`Generate a new token, old one is invalidated`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Delete key`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`DELETE /settings/public-api/keys/:keyId`})}),_jsx(_components.td,{children:`Permanently revoke a key`})]})]})]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`When you create or rotate a key, the plaintext token is returned `,_jsx(_components.strong,{children:`exactly once`}),`. Store it securely — you cannot retrieve it later.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`quick-start-example`,children:`Quick Start Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`10`,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:`10`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# 1. Authenticate with your vendor API key`})}),`\n`,_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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://production-api.puppetvendors.com/authenticate`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_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:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{\"apiKey\": \"vk_live_abc123...\"}'`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# Response: {\"success\": true, \"data\": {\"token\": \"eyJ...\", \"expiresIn\": 86400}}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`# 2. Use the JWT token for subsequent requests`})}),`\n`,_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:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://production-api.puppetvendors.com/orders?first=10\"`}),_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:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"x-access-token: eyJ...\"`})]}),`\n`]})})})]})}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":"API Keys \u0026 Scopes","description":"Create vendor API keys and understand permission scopes","href":"/api-reference/v2/vendor/api-keys-scopes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Overview","slug":"overview","depth":2,"children":[]},{"title":"Key Prefixes","slug":"key-prefixes","depth":2,"children":[]},{"title":"Available Scopes","slug":"available-scopes","depth":2,"children":[]},{"title":"Unscoped Endpoints","slug":"unscoped-endpoints","depth":2,"children":[]},{"title":"How Scopes Work","slug":"how-scopes-work","depth":2,"children":[{"title":"Read vs Write","slug":"read-vs-write","depth":3,"children":[]}]},{"title":"Managing API Keys","slug":"managing-api-keys","depth":2,"children":[]},{"title":"Quick Start Example","slug":"quick-start-example","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"puppetvendors-26","siteName":"PuppetVendors API","title":"API Keys \u0026 Scopes - PuppetVendors API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-09T16:11:42.275Z","originalFileLocation":"api-reference/v2/vendor/api-keys-scopes.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Create vendor API keys and understand permission scopes\">\u003cmeta data-mint-head name=\"application-name\" content=\"PuppetVendors API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_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/puppetvendors-26/-XB4Lj4GMnwBz779/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Keys \u0026amp; Scopes - PuppetVendors API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create vendor API keys and understand permission scopes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PuppetVendors API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://puppetvendors-26.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=API+Keys+%26+Scopes\u0026amp;description=Create+vendor+API+keys+and+understand+permission+scopes\u0026amp;theme=7557d12c2334c4535c16045f\u0026amp;signature=850765714a58d05c7318e31cc1294eabedb230a32aa18ef58fefada6a95a049c\">\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=\"API Keys \u0026amp; Scopes - PuppetVendors API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create vendor API keys and understand permission scopes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://puppetvendors-26.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=API+Keys+%26+Scopes\u0026amp;description=Create+vendor+API+keys+and+understand+permission+scopes\u0026amp;theme=7557d12c2334c4535c16045f\u0026amp;signature=850765714a58d05c7318e31cc1294eabedb230a32aa18ef58fefada6a95a049c\">\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/puppetvendors-26/-XB4Lj4GMnwBz779/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PuppetVendors API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v2/vendor/api-keys-scopes.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://dev.puppetvendors.com/#organization\",\"name\":\"PuppetVendors API\",\"url\":\"https://dev.puppetvendors.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/puppetvendors-26/j4NQfmVPdX-HgZdK/logo/light.svg?fit=max\u0026auto=format\u0026n=j4NQfmVPdX-HgZdK\u0026q=85\u0026s=334773803bc34a3293e61a5efa488140\"}},{\"@type\":\"WebSite\",\"@id\":\"https://dev.puppetvendors.com#website\",\"name\":\"PuppetVendors API\",\"url\":\"https://dev.puppetvendors.com\",\"publisher\":{\"@id\":\"https://dev.puppetvendors.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes#webpage\",\"url\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes\",\"name\":\"API Keys \u0026 Scopes\",\"description\":\"Create vendor API keys and understand permission scopes\",\"dateModified\":\"2026-07-09T16:11:42.275Z\",\"isPartOf\":{\"@id\":\"https://dev.puppetvendors.com#website\"},\"breadcrumb\":{\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Keys \u0026 Scopes\",\"item\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes#article\",\"headline\":\"API Keys \u0026 Scopes\",\"name\":\"API Keys \u0026 Scopes\",\"description\":\"Create vendor API keys and understand permission scopes\",\"url\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes\",\"mainEntityOfPage\":{\"@id\":\"https://dev.puppetvendors.com/api-reference/v2/vendor/api-keys-scopes#webpage\"},\"dateModified\":\"2026-07-09T16:11:42.275Z\",\"publisher\":{\"@id\":\"https://dev.puppetvendors.com/#organization\"},\"isPartOf\":{\"@id\":\"https://dev.puppetvendors.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PuppetVendors API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PuppetVendors API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/v2/vendor/api-keys-scopes.md","siteName":"PuppetVendors API","nav":{"global":{"anchors":[{"anchor":"PuppetVendors","icon":"globe","href":"https://puppetvendors.com"}]},"tabs":[{"tab":"API V1","pages":[{"title":"API V1","href":""}]},{"tab":"Vendors - V2","groups":[{"group":"Getting Started","pages":[{"title":"V2 Vendor API Introduction","href":"/api-reference/v2/vendor/introduction"},{"title":"Quick Start","href":"/api-reference/v2/vendor/quickstart"},{"title":"Vendor Authentication","description":"Authenticate with the PuppetVendors V2 API using a vendor API key","href":"/api-reference/v2/vendor/authentication"},{"title":"API Keys \u0026 Scopes","href":"/api-reference/v2/vendor/api-keys-scopes"},{"title":"Pagination","description":"Cursor-based pagination in the V2 Vendor API","href":"/api-reference/v2/vendor/pagination"},{"title":"Error Handling","href":"/api-reference/v2/vendor/errors"}]},{"group":"Authentication","pages":[{"title":"Authenticate","api":"POST /authenticate","href":"/api-reference/v2/endpoint/vendor-authenticate"},{"title":"Refresh Token","api":"POST /refresh-token","href":"/api-reference/v2/endpoint/vendor-refresh-token"}]},{"group":"Vendor Portal Auth","pages":[{"title":"Vendor Portal Login","api":"POST /portal/auth/login","href":"/api-reference/v2/vendor/endpoint/portal-login"},{"title":"Vendor Portal Signup","api":"POST /portal/auth/signup","href":"/api-reference/v2/vendor/endpoint/portal-signup"},{"title":"Forgot Password","api":"POST /portal/auth/forgot-password","href":"/api-reference/v2/vendor/endpoint/portal-forgot-password"},{"title":"Vendor Portal Logout","api":"POST /portal/auth/logout","href":"/api-reference/v2/vendor/endpoint/portal-logout"},{"title":"Refresh Vendor Token","api":"POST /portal/auth/refresh-token","href":"/api-reference/v2/vendor/endpoint/portal-refresh-token"},{"title":"List Vendors for User","api":"GET /portal/auth/vendors","href":"/api-reference/v2/vendor/endpoint/portal-list-vendors"}]},{"group":"Orders","pages":[{"title":"List Orders","api":"GET /orders","href":"/api-reference/v2/endpoint/vendor-list-orders"},{"title":"Get Order","api":"GET /orders/{orderId}","href":"/api-reference/v2/endpoint/vendor-get-order"},{"title":"Get Order Counts","api":"GET /orders/counts","href":"/api-reference/v2/vendor/endpoint/order-counts"},{"title":"Get Order Timeline","api":"GET /orders/{orderId}/timeline","href":"/api-reference/v2/vendor/endpoint/get-order-timeline"},{"title":"Add Order Timeline Note","api":"POST /orders/{orderId}/timeline","href":"/api-reference/v2/vendor/endpoint/add-order-timeline"}]},{"group":"Products","pages":[{"title":"List Products","api":"GET /products","href":"/api-reference/v2/endpoint/vendor-list-products"},{"title":"Get Product","api":"GET /products/{productId}","href":"/api-reference/v2/vendor/endpoint/get-product"},{"title":"Create Product","api":"POST /products","href":"/api-reference/v2/endpoint/vendor-create-product"},{"title":"Update Product","api":"PUT /products/{productId}","href":"/api-reference/v2/vendor/endpoint/update-product"},{"title":"Delete Product","api":"DELETE /products/{productId}","href":"/api-reference/v2/vendor/endpoint/delete-product"},{"title":"Get Product Counts","api":"GET /products/counts","href":"/api-reference/v2/vendor/endpoint/product-counts"},{"title":"Update Product Status","api":"PATCH /products/{productId}/status","href":"/api-reference/v2/vendor/endpoint/update-product-status"},{"title":"Duplicate Product","api":"POST /products/{productId}/duplicate","href":"/api-reference/v2/vendor/endpoint/duplicate-product"},{"title":"Update Product Inventory","api":"PATCH /products/{productId}/inventory","href":"/api-reference/v2/vendor/endpoint/update-product-inventory"},{"title":"Upload Product Media","api":"POST /products/media","href":"/api-reference/v2/vendor/endpoint/upload-product-media"},{"title":"AI Product Description","api":"POST /products/ai/description","href":"/api-reference/v2/vendor/endpoint/ai-description"},{"title":"Generate Barcode","api":"POST /products/barcode","href":"/api-reference/v2/vendor/endpoint/generate-barcode"}]},{"group":"Fulfillments","pages":[{"title":"List Fulfillments","api":"GET /fulfillments","href":"/api-reference/v2/endpoint/vendor-list-fulfillments"},{"title":"Create Fulfillment","api":"POST /fulfillments","href":"/api-reference/v2/endpoint/vendor-create-fulfillment"},{"title":"Update Fulfillment","api":"PUT /fulfillments/{fulfillmentId}","href":"/api-reference/v2/endpoint/vendor-update-fulfillment"},{"title":"Get Fulfillment Counts","api":"GET /fulfillments/counts","href":"/api-reference/v2/vendor/endpoint/fulfillment-counts"},{"title":"Get Fulfillment Stats","api":"GET /fulfillments/stats","href":"/api-reference/v2/vendor/endpoint/fulfillment-stats"}]},{"group":"Fulfillment Events","pages":[{"title":"List Fulfillment Events","api":"GET /fulfillments/events/{lineItemId}","href":"/api-reference/v2/vendor/endpoint/list-fulfillment-events"},{"title":"Create Fulfillment Event","api":"POST /fulfillments/events/{lineItemId}","href":"/api-reference/v2/vendor/endpoint/create-fulfillment-event"},{"title":"Update Fulfillment Event","api":"PUT /fulfillments/events/{eventId}","href":"/api-reference/v2/vendor/endpoint/update-fulfillment-event"},{"title":"Bulk Create Fulfillment Events","api":"POST /fulfillments/events/bulk","href":"/api-reference/v2/vendor/endpoint/bulk-create-fulfillment-events"}]},{"group":"Documents","pages":[{"title":"Generate Vendor Invoice PDF","api":"POST /documents/invoice","href":"/api-reference/v2/vendor/endpoint/generate-invoice"},{"title":"Generate Packing Slip PDF","api":"POST /documents/packing-slip","href":"/api-reference/v2/vendor/endpoint/generate-packing-slip"},{"title":"Generate Shipping Label PDF","api":"POST /documents/shipping-label","href":"/api-reference/v2/vendor/endpoint/generate-shipping-label"},{"title":"Generate Customer Invoice PDF","api":"POST /documents/customer-invoice","href":"/api-reference/v2/vendor/endpoint/generate-customer-invoice-doc"},{"title":"Generate Grouped Invoice by Vendor","api":"POST /orders/invoice/grouped","href":"/api-reference/v2/vendor/endpoint/generate-grouped-invoice"}]},{"group":"Payouts","pages":[{"title":"List Payouts","api":"GET /payouts","href":"/api-reference/v2/endpoint/vendor-list-payouts"},{"title":"Get Payout","api":"GET /payouts/{payoutId}","href":"/api-reference/v2/endpoint/vendor-get-payout"},{"title":"Payout Summary","api":"GET /payouts/summary","href":"/api-reference/v2/vendor/endpoint/payout-summary"},{"title":"List Payout Transactions","api":"GET /payouts/transactions","href":"/api-reference/v2/vendor/endpoint/payout-transactions"},{"title":"Get Payout Batch Detail","api":"GET /payouts/batches/{batchId}","href":"/api-reference/v2/vendor/endpoint/payout-batch-detail"},{"title":"List Pending Payouts","api":"GET /payouts/pending","href":"/api-reference/v2/vendor/endpoint/pending-payouts"}]},{"group":"Customers","pages":[{"title":"List Customers","api":"GET /customers","href":"/api-reference/v2/endpoint/vendor-list-customers"}]},{"group":"Discounts","pages":[{"title":"List Discounts","api":"GET /discounts","href":"/api-reference/v2/endpoint/vendor-list-discounts"},{"title":"Create Discount","api":"POST /discounts","href":"/api-reference/v2/endpoint/vendor-create-discount"},{"title":"Update Discount","api":"PUT /discounts/{discountId}","href":"/api-reference/v2/endpoint/vendor-update-discount"},{"title":"Delete Discount","api":"DELETE /discounts/{discountId}","href":"/api-reference/v2/endpoint/vendor-delete-discount"}]},{"group":"Shipping Operations","pages":[{"title":"Get Shipping Rates for Order","api":"POST /shipping/get-rates","href":"/api-reference/v2/vendor/endpoint/get-shipping-rates-op"},{"title":"Purchase Shipping Label","api":"POST /shipping/purchase-label","href":"/api-reference/v2/vendor/endpoint/purchase-shipping-label"},{"title":"Generate Generic Label","api":"POST /shipping/generate-label","href":"/api-reference/v2/vendor/endpoint/generate-generic-label"},{"title":"List Shipping Dimensions","api":"GET /shipping/dimensions","href":"/api-reference/v2/vendor/endpoint/list-shipping-dimensions"},{"title":"Create Shipping Dimension","api":"POST /shipping/dimensions","href":"/api-reference/v2/vendor/endpoint/create-shipping-dimension"},{"title":"Update Shipping Dimension","api":"PUT /shipping/dimensions/{shippingDimensionsId}","href":"/api-reference/v2/vendor/endpoint/update-shipping-dimension"},{"title":"Delete Shipping Dimension","api":"DELETE /shipping/dimensions/{shippingDimensionsId}","href":"/api-reference/v2/vendor/endpoint/delete-shipping-dimension"}]},{"group":"Vendor Profile","pages":[{"title":"Get My Vendor Profile","api":"GET /vendors/me/profile","href":"/api-reference/v2/vendor/endpoint/get-my-profile"},{"title":"Update My Vendor Profile","api":"PUT /vendors/me/profile","href":"/api-reference/v2/vendor/endpoint/update-my-profile"},{"title":"Get My Vendor Address","api":"GET /vendors/me/address","href":"/api-reference/v2/vendor/endpoint/get-my-address"},{"title":"Update My Vendor Address","api":"PUT /vendors/me/address","href":"/api-reference/v2/vendor/endpoint/update-my-address"}]},{"group":"Account Settings","pages":[{"title":"Get Account Settings","api":"GET /settings/accounts","href":"/api-reference/v2/vendor/endpoint/get-account-settings"},{"title":"Update Account Settings","api":"PUT /settings/accounts","href":"/api-reference/v2/vendor/endpoint/update-account-settings"},{"title":"Get Profile Settings","api":"GET /settings/profiles","href":"/api-reference/v2/vendor/endpoint/get-profile-settings"},{"title":"Update Profile Settings","api":"PUT /settings/profiles","href":"/api-reference/v2/vendor/endpoint/update-profile-settings"}]},{"group":"Shipping Settings","pages":[{"title":"Get Shipping Rates","api":"GET /settings/shipping/rates","href":"/api-reference/v2/vendor/endpoint/get-shipping-rates"},{"title":"Update Shipping Rates","api":"PUT /settings/shipping/rates","href":"/api-reference/v2/vendor/endpoint/update-shipping-rates"},{"title":"List Warehouses","api":"GET /settings/shipping/warehouses","href":"/api-reference/v2/vendor/endpoint/list-warehouses"},{"title":"Get Warehouse","api":"GET /settings/shipping/warehouses/{locationId}","href":"/api-reference/v2/vendor/endpoint/get-warehouse"},{"title":"Add Warehouse","api":"POST /settings/shipping/warehouses","href":"/api-reference/v2/vendor/endpoint/create-warehouse"},{"title":"Update Warehouse","api":"PUT /settings/shipping/warehouses/{index}","href":"/api-reference/v2/vendor/endpoint/update-warehouse"},{"title":"Delete Warehouse","api":"DELETE /settings/shipping/warehouses/{index}","href":"/api-reference/v2/vendor/endpoint/delete-warehouse"}]},{"group":"Team Members","pages":[{"title":"List Team Members","api":"GET /settings/team","href":"/api-reference/v2/vendor/endpoint/list-team-members"},{"title":"Create Team Member","api":"POST /settings/team","href":"/api-reference/v2/vendor/endpoint/create-team-member"},{"title":"Update Team Member","api":"PUT /settings/team/{userId}","href":"/api-reference/v2/vendor/endpoint/update-team-member"},{"title":"Delete Team Member","api":"DELETE /settings/team/{userId}","href":"/api-reference/v2/vendor/endpoint/delete-team-member"}]},{"group":"Users","pages":[{"title":"List Users","api":"GET /users","href":"/api-reference/v2/endpoint/vendor-list-users"},{"title":"Get User","api":"GET /users/{userId}","href":"/api-reference/v2/vendor/endpoint/get-user"},{"title":"Create User","api":"POST /users","href":"/api-reference/v2/endpoint/vendor-create-user"},{"title":"Update User","api":"PUT /users/{userId}","href":"/api-reference/v2/endpoint/vendor-update-user"},{"title":"Delete User","api":"DELETE /users/{userId}","href":"/api-reference/v2/endpoint/vendor-delete-user"}]},{"group":"Integrations","pages":[{"title":"List Available Integrations","api":"GET /integrations","href":"/api-reference/v2/vendor/endpoint/list-integrations"},{"title":"PayPal","api":"GET /integrations/paypal","href":"/api-reference/v2/endpoint/vendor-get-paypal"},{"title":"PayPal","api":"PUT /integrations/paypal","href":"/api-reference/v2/endpoint/vendor-update-paypal"},{"title":"Delete PayPal Configuration","api":"DELETE /integrations/paypal","href":"/api-reference/v2/vendor/endpoint/delete-paypal"},{"title":"Stripe","api":"GET /integrations/stripe","href":"/api-reference/v2/endpoint/vendor-get-stripe"},{"title":"Initiate Stripe Connect","api":"POST /integrations/stripe/connect","href":"/api-reference/v2/vendor/endpoint/stripe-connect"},{"title":"Disconnect Stripe Account","api":"DELETE /integrations/stripe","href":"/api-reference/v2/vendor/endpoint/delete-stripe"},{"title":"Shippo","api":"GET /integrations/shippo","href":"/api-reference/v2/endpoint/vendor-get-shippo"},{"title":"Shippo","api":"PUT /integrations/shippo","href":"/api-reference/v2/endpoint/vendor-update-shippo"},{"title":"Delete Shippo Configuration","api":"DELETE /integrations/shippo","href":"/api-reference/v2/vendor/endpoint/delete-shippo"},{"title":"ShipStation","api":"GET /integrations/shipstation","href":"/api-reference/v2/endpoint/vendor-get-shipstation"},{"title":"ShipStation","api":"PUT /integrations/shipstation","href":"/api-reference/v2/endpoint/vendor-update-shipstation"},{"title":"Delete ShipStation Configuration","api":"DELETE /integrations/shipstation","href":"/api-reference/v2/vendor/endpoint/delete-shipstation"}]}]},{"tab":"Merchants - V2","pages":[{"title":"Merchants - V2","href":"/api-reference/v2/merchant/introduction"}]}]},"basePath":"","title":"API Keys \u0026 Scopes - PuppetVendors API","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":[],"chunks":[]}