POST
/
partner
/
merchants
/
{merchantId}
/
clients
Create a client (end customer) under this merchant
curl --request POST \
  --url https://api.vuz.co.il/api/v1/partner/merchants/{merchantId}/clients \
  --header 'Content-Type: application/json' \
  --data '
{
  "partnerExternalRef": "TG-CUST-99821",
  "name": "ישראל ישראלי",
  "type": "private",
  "taxId": "012345678",
  "vatNumber": "514329876",
  "email": "israel@gmail.com",
  "phone": "+972501234567",
  "address": "דיזנגוף 100, תל אביב"
}
'

Path Parameters

​
merchantId
string
required

Body

application/json
​
partnerExternalRef
string
required

Partner's internal customer ID. Unique within the merchant. Used for idempotency.

Example:

"TG-CUST-99821"

​
name
string
required

Customer name as they want it on the invoice

Example:

"ישראל ישראלי"

​
type
enum<string>
default:private

Israeli tax classification — same canonical enum the VUZ dashboard uses. Defaults to 'private' (private individual). If you provide vatNumber, set to 'osek_morshe' / 'company_ltd' / etc. as appropriate.

Available options:
private,
osek_morshe,
osek_patur,
company_ltd,
company_public,
non_profit,
government,
foreign
​
taxId
string

ת.ז. (9-digit) for individuals

Example:

"012345678"

​
vatNumber
string

ע.מ./ח.פ. for businesses (required if type=business and the end-customer wants to reclaim VAT)

Example:

"514329876"

​
email
string
Example:

"israel@gmail.com"

​
phone
string
Example:

"+972501234567"

​
address
string
Example:

"דיזנגוף 100, תל אביב"

Response

201 - undefined