List vendor

This API is used to retrieve a list of vendors. This list is typically used when creating a purchase request for goods to be delivered to the pickup address. It helps the user select a vendor for the procurement of goods.

{ "status_code": 200, "data": [ { "id": 123, "country": "VN", "name": "FC APD", "email": "buithihoaithuong301@gmail.com", "phone": "0978657896", "website": "", "vendor_type": "personal", "logo": null, "is_delete": false, "is_active": true, "created_time": 1724985892, "updated_time": 1724985892, "user": 190, "business": 276, "store": null, "vendor_type_display": "Personal", "vendor_info": { "address": "số 9 trà khúc, Phường 2, Tân Bình, TP.HCM", "tax_code": "", "zipcode": "", "vendor": 123 } } ], "error": false, "error_code": null, "log_id": null, "messages": "", "total": 1 }

Responses

🟢200OK

application/json

Body

status_code

integer

optional

HTTP response status code, e.g., 200 for a successful request.

data

array [object {17}]

optional

List of vendor objects. Each object includes:

integer

optional

Unique ID of the vendor.

country

string

optional

Country code (e.g., "VN" for Vietnam).

name

string

optional

Name of the vendor (e.g., "FC APD").

string

optional

Vendor’s contact email address.

phone

string

optional

Vendor’s contact phone number.

website

string

optional

Vendor's website URL (can be empty).

vendor_type

string

optional

Type of vendor, e.g., "personal" or "company".

logo

string | null

optional

Vendor logo (can be null).

is_delete

boolean

optional

Indicates whether the vendor has been deleted (true/false).

is_active

boolean

optional

Whether the vendor is currently active (true/false).

created_time

integer

optional

Timestamp of creation (in Unix time).

updated_time

integer

optional

Timestamp of the last update (in Unix time).

user

integer

optional

ID of the user associated with the vendor.

business

integer

optional

ID of the associated business.

store

null

optional

Associated store ID (can be null).

vendor_type_display

string

optional

Human-readable label for vendor type (e.g., "Personal").

vendor_info

object

optional

Nested object containing:

error

boolean

optional

Indicates if there was an error during the request.

error_code

string | null

optional

Error code, if applicable.

log_id

string | null

optional

Internal log ID for tracking/debugging.

messages

string

optional

Server message (usually empty on success).

total

integer

optional

Total number of vendor records returned.

Request

Responses