Listing & Retrieving Sub-Dealer Details

Endpoints

• List all sub-dealers: GET /vendor/subdealer
• Single sub-dealer detail (code): GET /vendor/subdealer/{code}
• Single sub-dealer detail (erpCode): GET /vendor/subdealer/{erpCode}

HTTP Method: GET Response Content-Type: application/json Authorization: Valid AccessToken is required. (See: 2. Authentication – Obtaining AccessToken)

Description

This service allows listing sub-dealer records or viewing details of a specific sub-dealer.

• If code or erpCode is provided, a single record is returned.
• If no parameter is provided, all records are returned in a paginated format.
• For main dealer-based filtering, the parentTenantId query parameter can be used.

Header Information

Header	Required	Description
Authorization	Yes	Valid token in Bearer {AccessToken} format
Content-Type	Yes	application/json

Route Parameters - Single Record

Parameter	Type	Required	Description
code	string	One of the two	Sub-dealer user code
erpCode	string	One of the two	Sub-dealer ERP code

Only one of code or erpCode should be used. If neither is provided, a listing is returned.

Query Parameters – Pagination / Filtering

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
pageSize	integer	No	Records per page (default: 10, max: 100)
parentCode	string	No	Filter by main dealer code

Response Body – Vendor (Sub-Dealer) Fields

Field	Type	Required	Description
code	string	Yes	Sub-dealer user code (unique)
companyName	string	Yes (isCompany=true)	Corporate sub-dealer name
firstName	string	Yes (isCompany=false)	Individual sub-dealer first name
lastName	string	Yes (isCompany=false)	Individual sub-dealer last name
email	string	Yes	Sub-dealer email address
mobile	string	Yes	Mobile phone
phone	string	No	Landline phone
countryCodeISO	string	Yes	Country code (e.g., "TR")
cityCode	string	No	City code
currencyTypeId	integer	Yes	Currency ID
erpCode	string	Yes	ERP code (unique)
isActive	boolean	No	Active/inactive status
isCompany	boolean	Yes	true for corporate, false for individual
address	string	No	Address
tckn	string	Yes (isCompany=false)	Individual TCKN
taxNumber	string	Yes (isCompany=true)	Tax number
taxOffice	string	Yes (isCompany=true)	Tax office
sendMail	boolean	No	Should a registration email be sent
addDefaultCurrentAccount	boolean	No	Should default current account be created
paymentSetId	string	No	Payment set ERP code
users	array	No	List of users associated with sub-dealer

Response Body – User (Sub-Dealer User) Fields

Field	Type	Required	Description
code	string	Yes	User code
firstName	string	Yes	User first name
lastName	string	Yes	User last name
email	string	Yes	User email address
mobile	string	Yes	Mobile phone
isActive	boolean	No	Active/inactive status
sendMail	boolean	No	Should an email be sent
tckn	string	No	Individual user TCKN
isAdmin	boolean	No	Admin privileges
isMobileActive	boolean	No	Mobile access active?
ruleName	string[]	No	Permission set names

Example Response (Single Record)

{  
            "code": "NT10096053",  
            "name": "John",  
            "address": null,  
            "cityCode": null,  
            "districtCode": null,  
            "countryCode": null,  
            "erpCode": null,  
            "taxNumber": "00000000000",  
            "taxOffice": null,  
            "isCompany": false,  
            "paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a",  
            "usablePaymentSetDefinitionIds": [],  
            "parentTenantId": "7c394922-d312-4f91-8a9a-31e349d94380",  
            "customerRepresentativeIds": [  
                "b7ec27b3-2594-4f75-8b8e-9c8b8dd6dfec"  
            ],  
            "currenyCode": null,  
            "isActive": true,  
            "users": [  
                {  
                    "userCode": null,  
                    "name": "John",  
                    "surname": "Doe",  
                    "email": "[email protected]",  
                    "gsm": "5000000000",  
                    "title": null,  
                    "description": "",  
                    "erpCode": "",  
                    "isActive": true,  
                    "isCompany": false,  
                    "phone": null,  
                    "countryCode": null,  
                    "cityCode": null,  
                    "currenyCode": null,  
                    "address": null,  
                    "isForeignNational": false,  
                    "tckn": "00000000000",  
                    "paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a",  
                    "roles": [  
                        "BACD5D2B-2021-4FAD-AD93-D38BEE2877C6"  
                    ],  
                    "canUseMobile": true,  
                    "id": "b9b7ec52-a5eb-4d13-885b-3157b8174d92"  
                }  
            ]  
}

Example Response – Listing (Paginated)

{  
    "data": [  
        {  
            "code": "NT10096053",  
            "name": "John",  
            "address": null,  
            "cityCode": null,  
            "districtCode": null,  
            "countryCode": null,  
            "erpCode": null,  
            "taxNumber": "00000000000",  
            "taxOffice": null,  
            "isCompany": false,  
            "paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a",  
            "usablePaymentSetDefinitionIds": [],  
            "parentTenantId": "7c394922-d312-4f91-8a9a-31e349d94380",  
            "customerRepresentativeIds": [  
                "b7ec27b3-2594-4f75-8b8e-9c8b8dd6dfec"  
            ],  
            "currenyCode": null,  
            "isActive": true,  
            "users": [  
                {  
                    "userCode": null,  
                    "name": "John",  
                    "surname": "Doe",  
                    "email": "[email protected]",  
                    "gsm": "5000000000",  
                    "title": null,  
                    "description": "",  
                    "erpCode": "",  
                    "isActive": true,  
                    "isCompany": false,  
                    "phone": null,  
                    "countryCode": null,  
                    "cityCode": null,  
                    "currenyCode": null,  
                    "address": null,  
                    "isForeignNational": false,  
                    "tckn": "00000000000",  
                    "paymentSetId": "00cfced3-c429-444e-8125-fff3a7fb553a",  
                    "roles": [  
                        "BACD5D2B-2021-4FAD-AD93-D38BEE2877C6"  
                    ],  
                    "canUseMobile": true,  
                    "id": "b9b7ec52-a5eb-4d13-885b-3157b8174d92"  
                }  
            ]  
        }  
]  
}

Note: The field set in the listing response is simplified for example purposes; more fields may be returned depending on your setup.

Notes & Best Practices

• The mainDealerCode field is required. A sub-dealer must always be linked to a main dealer.
• isCompany = true (corporate) requires taxNumber and taxOffice.
• usablePaymentSetDefinitionIds supports multiple payment set definitions as a list.
• sendMail = true sends a system email to the created user(s).
• Token Expiration: If the token expires, the request returns 401 Unauthorized; obtain a new token and retry.
• It is recommended that code, erpCode, and mainDealerCode fields are unique.