Skip to main content
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 verified gstNumber, 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

The state 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. The paymentTerms field accepts the following values:
  • due_eom
  • due_on_receipt
  • net_7
  • net_15
  • net_30
  • net_45
  • net_60
  • net_90
  • net_120
  • net_150
  • net_180
  • none

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
HTTP Status: 400 Bad Request
HTTP Status: 400 Bad Request

Duplicate Vendor Errors

HTTP Status: 400 Bad Request Duplicate Phone Number:
Duplicate Email:
Duplicate Vendor Name:

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 name is required; all other fields are optional
  • Provide complete address information if you include the address object (addressLine1, state, and zipCode are mandatory within the address)
  • Use appropriate locality values (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