{ "success": true, "message": "", "error_code": "", "errors": {}, "data": { "message": "No data found!" }}
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"message": "No data found!"
}
}
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"message": "No data found!"
}
}
Vendors
Add a vendor
Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.
Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Swipe","colors":{"primary":"#2045D1","light":"#538DFF","dark":"#2045D1"},"logo":{"light":"https://mintcdn.com/swipe/DQkaOg10KeYQlKIu/logo/logo_g_light.webp?fit=max\u0026auto=format\u0026n=DQkaOg10KeYQlKIu\u0026q=85\u0026s=44d5e4b626518cb3542e8ef16e85f182","dark":"https://mintcdn.com/swipe/DQkaOg10KeYQlKIu/logo/logo_g_dark.webp?fit=max\u0026auto=format\u0026n=DQkaOg10KeYQlKIu\u0026q=85\u0026s=84cf20e2bc4f85a8fea2938d2f43412e","href":"/"},"favicon":"https://mintcdn.com/swipe/ZOyvFX50eH4DT_Wr/favicon.svg?fit=max\u0026auto=format\u0026n=ZOyvFX50eH4DT_Wr\u0026q=85\u0026s=9f4476cef1667d0c527f72dd6036726b","api":{"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"]}},"navbar":{"links":[{"href":"https://app.getswipe.in/user?tab=api_integration","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.getswipe.in"}},"footer":{"socials":{"x":"https://twitter.com/swipebilling","instagram":"https://www.instagram.com/swipebilling","linkedin":"https://www.linkedin.com/company/swipebilling"}},"search":{"prompt":"Search the Swipe API docs..."},"seo":{"metatags":{"og:site_name":"Swipe API Documentation","og:type":"website"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Run in Postman","icon":{"style":"thin","name":"user-astronaut"},"href":"https://god.gw.postman.com/run-collection/43895811-b7327b9d-1e50-4fed-af6f-660a918aa817?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D43895811-b7327b9d-1e50-4fed-af6f-660a918aa817%26entityType%3Dcollection%26workspaceId%3D5d3fc3f0-668c-499e-833b-03222666ba2a"},{"anchor":"Blog","icon":"newspaper","href":"https://getswipe.in/blog"},{"anchor":"Community","icon":"slack","href":"https://community.getswipe.in/c/api-integration/14"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"swipe","hasAudioNarration":false,"actualSubdomain":"swipe","customDomains":["developers.getswipe.in"],"gitSource":{"type":"github","owner":"swipe-yc21","repo":"partner-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aa158f50379420e6579534a","collectionId":"9e7e6d91-a01b-44eb-b79d-efe99a4644f3","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aa158f50379420e6579534a"},"entitlements":{},"buildId":"6aa158f50379420e6579534a","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Documentation","count":74},{"language":"default","tag":"Guides","count":10},{"language":"default","tag":"Customers","count":7},{"language":"default","tag":"Customer","count":7},{"language":"default","tag":"Vendors","count":7},{"language":"default","tag":"Documents","count":6},{"language":"default","tag":"Products","count":6},{"language":"default","tag":"Product","count":6},{"language":"default","tag":"Get Started","count":5},{"language":"default","tag":"Resources","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/vendor-v2/add-a-vendor","slug":"/api-reference/vendor-v2/add-a-vendor","pageMetadata":{"openapi":"post /v2/vendor","title":"Add a vendor","description":"Creates a vendor keyed by your own `id`. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor `party.id`.","href":"/api-reference/vendor-v2/add-a-vendor"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Creates a vendor keyed by your own \", _jsx(_components.code, {\n children: \"id\"\n }), \". Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor \", _jsx(_components.code, {\n children: \"party.id\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /v2/vendor","title":"Add a vendor","description":"Creates a vendor keyed by your own `id`. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor `party.id`.","href":"/api-reference/vendor-v2/add-a-vendor"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Add a vendor","operationId":"post_vendor","tags":["Vendor V2"],"requestBody":"8652f5f0-7243-46e1-b414-710f8a0ad2bb","responses":{"201":"7f2c0d8b-54f9-47e0-b529-ee0fac125f0f","400":"92f91612-f006-43f8-a900-08f4b085a639","401":"e042cfa0-ea5f-4d1e-af29-caf53f656a85"},"description":"Creates a vendor keyed by your own `id`. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor `party.id`.","method":"post","type":"path","servers":["82b38fec-7303-4b6e-86bb-63d990b1e4ef"],"security":["13576f02-530d-4f08-aab7-91987ee153ab"],"path":"/v2/vendor","baseUrlOptions":["https://app.getswipe.in/api/partner"],"title":"Add a vendor","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"required":["name","vendor_id"],"properties":{"vendor_id":{"type":"string","description":"Your Vendor ID","example":"123","isRequired":true,"uniqueKey":"vendor_id","typeLabel":"string"},"name":{"type":"string","description":"Vendor name","example":"TATA RATAN","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"phone":{"type":"string","description":"Phone number","example":1234567890,"uniqueKey":"phone","typeLabel":"string"},"email":{"type":"string","description":"Email address","example":"reddi@reddi.reddi","uniqueKey":"email","typeLabel":"string"},"discount":{"type":"integer","description":"Discount","example":10,"uniqueKey":"discount","typeLabel":"integer"},"gstin":{"type":"string","description":"GSTIN","example":"27AARCS7202C1ZD","pattern":"^(|[0-9A-Z]{15})$","uniqueKey":"gstin","typeLabel":"string"},"company_name":{"type":"string","description":"Company name","example":"GSTN","uniqueKey":"company_name","typeLabel":"string"},"opening_balance":{"type":"string","description":"Opening balance","example":"1245","uniqueKey":"opening_balance","typeLabel":"string"},"credit_limit":{"type":"integer","description":"Credit limit","example":200,"uniqueKey":"credit_limit","typeLabel":"integer"},"billing_address":{"properties":{"addr_id":{"type":"integer","description":"Address ID. It will automatically update the existing address if the address ID already exists.","example":-1,"uniqueKey":"billing_address.addr_id","typeLabel":"integer"},"addr_id_v2":{"type":"string","description":"Address ID. It should be alphanumeric with length upto 16 characters.","example":"addr1","uniqueKey":"billing_address.addr_id_v2","typeLabel":"string"},"address_line1":{"type":"string","description":"Address line 1","example":"","uniqueKey":"billing_address.address_line1","typeLabel":"string"},"address_line2":{"type":"string","description":"Address line 2","example":"","uniqueKey":"billing_address.address_line2","typeLabel":"string"},"pincode":{"type":"string","description":"Pincode","example":"500075","uniqueKey":"billing_address.pincode","typeLabel":"string"},"city":{"type":"string","description":"City","example":"","uniqueKey":"billing_address.city","typeLabel":"string"},"state":{"type":"string","description":"State. You can copy the state details from https://developers.getswipe.in/api-reference/references#state-details","example":"State Name","enum":["JAMMU AND KASHMIR","HIMACHAL PRADESH","PUNJAB","CHANDIGARH","UTTARAKHAND","HARYANA","DELHI","RAJASTHAN","UTTAR PRADESH","BIHAR","SIKKIM","ARUNACHAL PRADESH","NAGALAND","MANIPUR","MIZORAM","TRIPURA","MEGHALAYA","ASSAM","WEST BENGAL","JHARKHAND","ODISHA","CHHATTISGARH","MADHYA PRADESH","GUJARAT","DADRA \u0026 NAGAR HAVELI \u0026 DAMAN \u0026 DIU","MAHARASHTRA","ANDHRAPRADESH(BEFOREADDED)","KARNATAKA","GOA","LAKSHWADEEP","KERALA","TAMIL NADU","PUDUCHERRY","ANDAMAN \u0026 NICOBAR","TELANGANA","ANDHRA PRADESH","LADAKH(NEWLYADDED)","LADAKH(NEWLY ADDED)","OTHER TERRITORY"],"uniqueKey":"billing_address.state","typeLabel":"enum\u003cstring>"},"country":{"type":"string","description":"Country. You can copy the country details from https://developers.getswipe.in/api-reference/references#country-array","example":"India","enum":["Afghanistan","Albania","Algeria","Andorra","Angola","Antigua and Barbuda","Argentina","Armenia","Australia","Austria","Azerbaijan","Bahamas","Bahrain","Bangladesh","Barbados","Belarus","Belgium","Belize","Benin","Bhutan","Bolivia","Bosnia and Herzegovina","Botswana","Brazil","Brunei","Bulgaria","Burkina Faso","Burundi","Cabo Verde","Cambodia","Cameroon","Canada","Central African Republic","Chad","Chile","China","Colombia","Comoros","Congo, Democratic Republic of the","Congo, Republic of the","Costa Rica","Croatia","Cuba","Cyprus","Czechia","Denmark","Djibouti","Dominica","Dominican Republic","Ecuador","Egypt","El Salvador","Equatorial Guinea","Eritrea","Estonia","Eswatini","Ethiopia","Fiji","Finland","France","Gabon","Gambia","Georgia","Germany","Ghana","Greece","Grenada","Guatemala","Guinea","Guinea-Bissau","Guyana","Haiti","Honduras","Hungary","Iceland","India","Indonesia","Iran","Iraq","Ireland","Israel","Italy","Jamaica","Japan","Jordan","Kazakhstan","Kenya","Kiribati","Republic of Korea (South Korea)","Kosovo","Kuwait","Kyrgyzstan","Laos","Latvia","Lebanon","Lesotho","Liberia","Libya","Liechtenstein","Lithuania","Luxembourg","Madagascar","Malawi","Malaysia","Maldives","Mali","Malta","Marshall Islands","Mauritania","Mauritius","Mexico","Micronesia","Moldova","Monaco","Mongolia","Montenegro","Morocco","Mozambique","Myanmar","Namibia","Nauru","Nepal","Netherlands","New Zealand","Nicaragua","Niger","Nigeria","North Macedonia","Norway","Oman","Pakistan","Palau","Palestine","Panama","Papua New Guinea","Paraguay","Peru","Philippines","Poland","Portugal","Qatar","Romania","Russia","Rwanda","Saint Kitts and Nevis","Saint Lucia","Saint Vincent and the Grenadines","Samoa","San Marino","Sao Tome and Principe","Saudi Arabia","Senegal","Serbia","Seychelles","Sierra Leone","Singapore","Slovakia","Slovenia","Solomon Islands","Somalia","South Africa","South Sudan","Spain","Sri Lanka","Sudan","Suriname","Sweden","Switzerland","Syria","Taiwan","Tajikistan","Tanzania","Thailand","Timor-Leste","Togo","Tonga","Trinidad and Tobago","Tunisia","Turkey","Turkmenistan","Tuvalu","Uganda","Ukraine","United Arab Emirates","United Kingdom","United States","Uruguay","Uzbekistan","Vanuatu","Vatican City","Venezuela","Vietnam","Yemen","Zambia","Zimbabwe"],"uniqueKey":"billing_address.country","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"billing_address","typeLabel":"object"},"opening_balance_type":{"type":"integer","description":"Credit[0] / Debit[1]","example":1,"uniqueKey":"opening_balance_type","typeLabel":"integer"},"dial_code":{"type":"string","description":"Dial code","example":"91","uniqueKey":"dial_code","typeLabel":"string"},"profile_image":{"type":"string","description":"Profile image URL","example":"","uniqueKey":"profile_image","typeLabel":"string"},"pan":{"type":"string","description":"PAN","example":"ABCD1234F","uniqueKey":"pan","typeLabel":"string"},"notes":{"type":"string","description":"Notes","example":"Testing api","uniqueKey":"notes","typeLabel":"string"},"cc_emails":{"type":"string","description":"CC email addresses","example":"reddi@reddi.reddi,acb.a@bcd.con","uniqueKey":"cc_emails","typeLabel":"string"},"status":{"type":"string","description":"Status","example":"Active","uniqueKey":"status","typeLabel":"string"},"tags":{"type":"array","description":"List of tags","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"uniqueKey":"tags","typeLabel":"string[]"},"custom_fields":{"type":"array","description":"Vendor Custom Fields. Custom fields should already be added in Swipe Portal.","example":[{"label":"Custom Field 1","value":"Value 1"}],"items":{"required":["label","value"],"properties":{"label":{"type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].label","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"custom_fields.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"custom_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"custom_fields","typeLabel":"object[]"},"visibility":{"type":"integer","description":"Vendor visibility status: If the value is 1, the vendor will be visible to all branches; otherwise, it will only be visible in the main branch.","example":1,"uniqueKey":"visibility","typeLabel":"integer"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"vendor_id":"123","name":"TATA RATAN","phone":1234567890,"email":"reddi@reddi.reddi","discount":10,"gstin":"27AARCS7202C1ZD","company_name":"GSTN","opening_balance":"1245","credit_limit":200,"billing_address":{"addr_id":-1,"addr_id_v2":"addr1","address_line1":"","address_line2":"","pincode":"500075","city":"","state":"State Name","country":"India"},"opening_balance_type":1,"dial_code":"91","profile_image":"","pan":"ABCD1234F","notes":"Testing api","cc_emails":"reddi@reddi.reddi,acb.a@bcd.con","status":"Active","tags":["\u003cstring>"],"custom_fields":[{"label":"Custom Field 1","value":"Value 1"}],"visibility":1}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"7f2c0d8b-54f9-47e0-b529-ee0fac125f0f":{"description":"Success","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","description":"Success flag","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Response message","example":"","uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","description":"Error Code","example":"","uniqueKey":"error_code","typeLabel":"string"},"errors":{"type":"object","description":"Errors","uniqueKey":"errors","typeLabel":"object"},"data":{"properties":{"message":{"type":"string","description":"Response message","example":"No data found!","uniqueKey":"data.message","typeLabel":"string"}},"type":"object","uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"","error_code":"","errors":{},"data":{"message":"No data found!"}}}},"exampleType":"generated"}},"exampleType":"generated"},"92f91612-f006-43f8-a900-08f4b085a639":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","description":"Success flag","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Response message","example":"","uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","description":"Error Code","example":"","uniqueKey":"error_code","typeLabel":"string"},"errors":{"type":"object","description":"Errors","uniqueKey":"errors","typeLabel":"object"},"data":{"properties":{"message":{"type":"string","description":"Response message","example":"No data found!","uniqueKey":"data.message","typeLabel":"string"}},"type":"object","uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"","error_code":"","errors":{},"data":{"message":"No data found!"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e042cfa0-ea5f-4d1e-af29-caf53f656a85":{"description":"Unauthorized","content":{"application/json":{"schema":{"properties":{"success":{"type":"boolean","description":"Success flag","example":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Response message","example":"","uniqueKey":"message","typeLabel":"string"},"error_code":{"type":"string","description":"Error Code","example":"","uniqueKey":"error_code","typeLabel":"string"},"errors":{"type":"object","description":"Errors","uniqueKey":"errors","typeLabel":"object"},"data":{"properties":{"message":{"type":"string","description":"Response message","example":"No data found!","uniqueKey":"data.message","typeLabel":"string"}},"type":"object","uniqueKey":"data","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"message":"","error_code":"","errors":{},"data":{"message":"No data found!"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"13576f02-530d-4f08-aab7-91987ee153ab":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is an API key from the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your dashboard. Keys are scoped to the company they are generated in — for testing, [add a separate test company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191) and generate the key there, so requests never touch your real books.","scopes":[]}}},"servers":{"82b38fec-7303-4b6e-86bb-63d990b1e4ef":{"url":"https://app.getswipe.in/api/partner"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is an API key from the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your dashboard. Keys are scoped to the company they are generated in — for testing, [add a separate test company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191) and generate the key there, so requests never touch your real books.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is an API key from the [API Integration](https://app.getswipe.in/user?tab=api_integration) section of your dashboard. Keys are scoped to the company they are generated in — for testing, [add a separate test company](https://community.getswipe.in/t/how-to-add-new-company-on-web/1191) and generate the key there, so requests never touch your real books.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"swipe","siteName":"Swipe","title":"Add a vendor - Swipe","navMaps":{"firstHrefInVersion":{"v2":{"href":"/api-reference/vendor-v2/add-a-vendor","matchLevel":0},"v1 (Deprecated)":{"href":"/introduction","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-08-27T07:51:51.968Z","originalFileLocation":"api-reference/vendor-v2/add-a-vendor.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=\"Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Swipe\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_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/swipe/c1cYpNBFxkNdbDrf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add a vendor - Swipe\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Swipe API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://swipe.mintlify.app/_mintlify/api/og/v2?division=Vendors\u0026amp;title=Add+a+vendor\u0026amp;description=Creates+a+vendor+keyed+by+your+own+%60id%60.+Vendors+are+the+parties+on+purchase-side+documents.+They+are+also+created+automatically+when+a+document+references+an+u\u0026amp;theme=6f6d44835af80bcfb7f23dbb\u0026amp;signature=9be44bbd6ff060e96cc844754b01731afc5bb920d4d3f21383a2deb2ab58689f\">\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=\"Add a vendor - Swipe\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://swipe.mintlify.app/_mintlify/api/og/v2?division=Vendors\u0026amp;title=Add+a+vendor\u0026amp;description=Creates+a+vendor+keyed+by+your+own+%60id%60.+Vendors+are+the+parties+on+purchase-side+documents.+They+are+also+created+automatically+when+a+document+references+an+u\u0026amp;theme=6f6d44835af80bcfb7f23dbb\u0026amp;signature=9be44bbd6ff060e96cc844754b01731afc5bb920d4d3f21383a2deb2ab58689f\">\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/swipe/c1cYpNBFxkNdbDrf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Swipe\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2045D1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/vendor-v2/add-a-vendor.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.getswipe.in/#organization\",\"name\":\"Swipe\",\"url\":\"https://developers.getswipe.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/swipe/DQkaOg10KeYQlKIu/logo/logo_g_light.webp?fit=max\u0026auto=format\u0026n=DQkaOg10KeYQlKIu\u0026q=85\u0026s=44d5e4b626518cb3542e8ef16e85f182\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.getswipe.in#website\",\"name\":\"Swipe\",\"url\":\"https://developers.getswipe.in\",\"publisher\":{\"@id\":\"https://developers.getswipe.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor#webpage\",\"url\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor\",\"name\":\"Add a vendor\",\"description\":\"Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.\",\"dateModified\":\"2026-08-27T07:51:51.968Z\",\"isPartOf\":{\"@id\":\"https://developers.getswipe.in#website\"},\"breadcrumb\":{\"@id\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Swipe\",\"item\":\"https://developers.getswipe.in\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add a vendor\",\"item\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor#apireference\",\"headline\":\"Add a vendor\",\"name\":\"Add a vendor\",\"description\":\"Creates a vendor keyed by your own id. Vendors are the parties on purchase-side documents. They are also created automatically when a document references an unknown vendor party.id.\",\"url\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor\",\"mainEntityOfPage\":{\"@id\":\"https://developers.getswipe.in/api-reference/vendor-v2/add-a-vendor#webpage\"},\"dateModified\":\"2026-08-27T07:51:51.968Z\",\"publisher\":{\"@id\":\"https://developers.getswipe.in/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.getswipe.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Swipe\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Swipe","nav":{"global":{"anchors":[{"anchor":"Run in Postman","icon":{"style":"thin","name":"user-astronaut"},"href":"https://god.gw.postman.com/run-collection/43895811-b7327b9d-1e50-4fed-af6f-660a918aa817?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D43895811-b7327b9d-1e50-4fed-af6f-660a918aa817%26entityType%3Dcollection%26workspaceId%3D5d3fc3f0-668c-499e-833b-03222666ba2a"},{"anchor":"Blog","icon":"newspaper","href":"https://getswipe.in/blog"},{"anchor":"Community","icon":"slack","href":"https://community.getswipe.in/c/api-integration/14"}]},"versions":[{"version":"v2","anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","icon":"rocket","href":"/introduction"},{"title":"Quickstart","icon":"play","href":"/quickstart"},{"title":"Authentication","icon":"key","href":"/authentication"},{"title":"API Conventions","icon":"list-check","href":"/api-conventions"},{"title":"Build with AI","icon":"robot","href":"/build-with-ai"}]},{"group":"Guides","pages":[{"title":"Documents","icon":"file-invoice","href":"/document"},{"title":"Customers","icon":"users","href":"/customer"},{"title":"Vendors","icon":"building","href":"/vendor"},{"title":"Payments","icon":"credit-card","href":"/payment"},{"title":"Products","icon":"boxes-stacked","href":"/product"},{"title":"Inventory","icon":"warehouse","href":"/inventory"},{"title":"Subscriptions","icon":"repeat","href":"/subscriptions"},{"title":"E-Way Bills","icon":"truck-fast","href":"/ewaybills"},{"title":"E-Invoices","icon":"file-circle-check","href":"/einvoices"},{"title":"Webhooks","icon":"bolt","href":"/webhooks"}]},{"group":"Resources","pages":[{"title":"Error Codes","icon":"triangle-exclamation","href":"/api-reference/error-codes"},{"title":"Tax Codes (TDS \u0026 TCS)","icon":"percent","href":"/api-reference/tax-codes"},{"title":"Currencies, States \u0026 Countries","icon":"globe","href":"/api-reference/reference-data"},{"title":"Change Log","icon":"clock-rotate-left","href":"/api-reference/change-log"}]},{"group":"Documents","pages":[{"openapi":"post /v2/doc","title":"Create a document","href":"/api-reference/document-v2/create-a-document"},{"openapi":"get /v2/doc/{doc_hash_id}","title":"Get a document","href":"/api-reference/document-v2/get-a-document"},{"openapi":"get /v2/doc/pdf/{doc_hash_id}","title":"Get document PDF","href":"/api-reference/document-v2/get-document-pdf"},{"openapi":"put /v2/doc/{doc_hash_id}","title":"Edit a document","href":"/api-reference/document-v2/edit-a-document"},{"openapi":"delete /v2/doc/{doc_hash_id}","title":"Cancel a document","href":"/api-reference/document-v2/cancel-a-document"},{"openapi":"get /v2/doc/list","title":"List of documents","href":"/api-reference/document-v2/list-of-documents"}]},{"group":"Payments","pages":[{"openapi":"post /v2/payment","title":"Record payment","href":"/api-reference/payment-v2/record-payment"},{"openapi":"get /v2/payment/list","title":"List of payments","href":"/api-reference/payment-v2/list-of-payments"}]},{"group":"E-Way Bills","pages":[{"openapi":"post /v2/ewaybill/{doc_hash_id}","title":"Create e-way bill","href":"/api-reference/ewaybill/create-eway-bill"},{"openapi":"get /v2/ewaybill/pdf/{doc_hash_id}","title":"Get e-way bill PDF","href":"/api-reference/ewaybill/get-ewaybill-pdf"}]},{"group":"Customers","pages":[{"openapi":"post /v2/customer","title":"Add a customer","href":"/api-reference/customer-v2/add-a-customer"},{"openapi":"get /v2/customer/{customer_id}","title":"Get customer details","href":"/api-reference/customer-v2/get-customer-details"},{"openapi":"put /v2/customer","title":"Update a customer","href":"/api-reference/customer-v2/update-a-customer"},{"openapi":"delete /v2/customer/{customer_id}","title":"Delete a customer","href":"/api-reference/customer-v2/delete-a-customer"},{"openapi":"get /v2/customer/ledger","title":"Get payment ledger","href":"/api-reference/customer-v2/get-payment-ledger"},{"openapi":"get /v2/customer/list","title":"Get list of customers","href":"/api-reference/customer-v2/get-list-of-customers"},{"openapi":"post /v2/customer/list","title":"Update customer mapping","description":"Re-links your customer IDs to existing Swipe records in bulk. Use this after changing IDs in your own system, so future calls don't create duplicate customers.","href":"/api-reference/customer-v2/update-customer-mapping"}]},{"group":"Vendors","pages":[{"openapi":"post /v2/vendor","title":"Add a vendor","href":"/api-reference/vendor-v2/add-a-vendor"},{"openapi":"get /v2/vendor/{vendor_id}","title":"Get vendor details","description":"Returns one vendor's details by your `vendor_id`.","href":"/api-reference/vendor-v2/get-vendor-details"},{"openapi":"put /v2/vendor","title":"Update a vendor","href":"/api-reference/vendor-v2/update-a-vendor"},{"openapi":"delete /v2/vendor/{vendor_id}","title":"Delete a vendor","href":"/api-reference/vendor-v2/delete-a-vendor"},{"openapi":"get /v2/vendor/ledger","title":"Get payment ledger","href":"/api-reference/vendor-v2/get-payment-ledger"},{"openapi":"get /v2/vendor/list","title":"Get list of vendors","href":"/api-reference/vendor-v2/get-list-of-vendors"},{"openapi":"post /v2/vendor/list","title":"Update vendor mapping","href":"/api-reference/vendor-v2/update-vendor-mapping"}]},{"group":"Products","pages":[{"openapi":"post /v2/product","title":"Add an item","href":"/api-reference/product-v2/add-an-item"},{"openapi":"get /v2/product/{item_id}","title":"Get item details","href":"/api-reference/product-v2/get-item-details"},{"openapi":"put /v2/product","title":"Update an item","href":"/api-reference/product-v2/update-an-item"},{"openapi":"delete /v2/product/{item_id}","title":"Delete an item","href":"/api-reference/product-v2/delete-an-item"},{"openapi":"get /v2/product/list","title":"Get list of items","href":"/api-reference/product-v2/get-list-of-items"},{"openapi":"post /v2/product/list","title":"Update items mapping","href":"/api-reference/product-v2/update-items-mapping"}]},{"group":"Inventory","pages":[{"openapi":"post /v2/inventory/stock","title":"Update inventory stock","href":"/api-reference/inventory-v2/inventory-stock-in-out"},{"openapi":"get /v2/inventory/warehouses/list","title":"Get all warehouses","href":"/api-reference/inventory-v2/get-all-warehouses"}]},{"group":"Subscriptions","pages":[{"openapi":"get /v2/subscriptions/list","title":"List of subscriptions","href":"/api-reference/subscriptions-v2/list-of-subscriptions"},{"openapi":"get /v2/subscriptions/{subscription_hash_id}","title":"Get subscription details","href":"/api-reference/subscriptions-v2/get-subscription-details"}]},{"group":"Utility","pages":[{"openapi":"get /v2/utils/gstin/{gstin}","title":"Get GSTIN details","href":"/api-reference/utility-v2/get-gstin-v2"}]}]}]},{"version":"v1 (Deprecated)","pages":[{"title":"v1 (Deprecated)","href":"/introduction"}]}]},"title":"Add a vendor - Swipe","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}