Vendor Creation API
Vendor APIs
Vendor Creation API
Create new vendors in your organization with comprehensive details
Vendor Creation API
Authentication
All requests require an API key in the request headers. Headers:Request
Content-Type:application/json
Body Parameters
Address Object
If you provide a valid and verifiedgstNumber, the address will be automatically extracted from GST data.
However, if you also provide an address object, the user-provided address will always take precedence over the GST-derived one.
When providing an address, the following fields are available:
*Required only if
address object is provided
State Values
Thestate field should use uppercase underscore-separated codes (e.g., UTTAR_PRADESH, MAHARASHTRA, etc.).
Below is the complete list of supported State and Union Territory values:
Payment Terms Values
Payment terms defaults to organization’s default if not provided. ThepaymentTerms field accepts the following values:
due_eomdue_on_receiptnet_7net_15net_30net_45net_60net_90net_120net_150net_180none
Code Examples
Success Response
HTTP Status:200 OK
Response Fields:
VendorStatus Values
- ACTIVE: The vendor is created and is in active state
- APPROVAL_PENDING: The vendor is yet to be approved by the organization’s vendor admins
Response Example
Error Responses
Missing Required Fields
HTTP Status:400 Bad Request
Invalid Email Format
HTTP Status:400 Bad Request
Invalid Locality
HTTP Status:400 Bad Request
Invalid Payment Terms
HTTP Status:400 Bad Request
Address Validation Errors
HTTP Status:400 Bad Request
400 Bad Request
400 Bad Request
Duplicate Vendor Errors
HTTP Status:400 Bad Request
Duplicate Phone Number:
Authentication Errors
HTTP Status:401 Unauthorized
Permission Errors
HTTP Status:403 Forbidden
Vendor Creation Errors
HTTP Status:400 Bad Request or 500 Internal Server Error
Best Practices
Vendor Creation
- Only
nameis required; all other fields are optional - Provide complete address information if you include the
addressobject (addressLine1, state, and zipCode are mandatory within the address) - Use appropriate
localityvalues (DOMESTIC for vendors within your country, INTERNATIONAL for foreign vendors) - Include GST and PAN numbers for Indian domestic vendors for tax compliance
- Ensure vendor contact information (email, phone) is unique to avoid duplicate errors
- Validate payment terms against your organization’s configured options