Add New Supplier

Creates a new supplier in the system.

Request Body Fields:

Required fields are marked with an asterisk (*)

Supplier Object:

supplier_number (string): Unique supplier identifier/code

business_name* (string): Business name

first_name* (string): First name of contact person

last_name* (string): Last name of contact person

email* (string): Email address

password (string): Password for supplier portal access

phone1 (string): Primary phone number

phone2 (string): Secondary phone number

address1 (string): Street address line 1

address2 (string): Street address line 2

city (string): City

state (string): State/province

postal_code (string): Postal/ZIP code

country_code* (string): 2-letter country code (e.g., US, UK)

website (string): Website URL

tax_registration (string): Tax registration number

notes (string): Internal notes about the supplier

custom_fields (object): Custom field values

Response:

{
  "result": "success",
  "code": 201,
  "data": {
    "Supplier": {
      "id": 3,
      // Other supplier fields...
    }
  },
  "message": "Supplier created successfully"
}

curl --location -g --request POST '{{subdomain}}/api2/api2/suppliers.json' \ --header 'Content-Type: text/plain' \ --data-raw '{ "Supplier": { "supplier_number": "SUP003", "business_name": "Tech Hardware Solutions", "first_name": "Sarah", "last_name": "Williams", "email": "sarah.williams@techhardware.com", "password": "securepassword123", "phone1": "555-6543", "phone2": "555-3456", "address1": "123 Technology Parkway", "address2": "Building B", "city": "Austin", "state": "TX", "postal_code": "78701", "country_code": "US", "website": "https://techhardware.example.com", "tax_registration": "34-5678901", "notes": "Hardware components supplier", "custom_fields": { "payment_terms": "Net 45", "lead_time": "2 weeks" } } }'

{ "result": "success", "code": 201, "data": { "Supplier": { "id": 3, "supplier_number": "SUP001", "business_name": "Supply Co", "first_name": "Jane", "last_name": "Smith", "email": "jane.smith@example.com", "created": "2023-03-23 15:30:42", "modified": "2023-03-23 15:30:42", "active": 1 } }, "message": "Supplier created successfully" }

Request

Responses