Manage trader sellers (NPCs/vendors) for your server. Sellers are the top-level entities that contain categories, which in turn contain tradeable items.
Authentication required: All endpoints require a valid Bearer token. See Authentication for details.
Retrieve a paginated list of trader sellers for a specific instance.
GET /api/instance/{instance_sid}/trader-seller
instance_sid
The SID of the instance (URL parameter)
like
string
Filter sellers by name using partial match.
amount
integer
Number of results per page. Defaults to 30.
{
"current_page": 1,
"data": [
{
"id": 1,
"sid": "abc123def456",
"name": "General Merchant",
"instance_id": 1,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
}
],
"per_page": 30,
"total": 5
}Retrieve details of a specific trader seller, including their categories.
GET /api/instance/{instance_sid}/trader-seller/{seller_sid}
instance_sid
required
The SID of the instance
seller_sid
required
The SID of the trader seller
Create a new trader seller for an instance.
POST /api/instance/{instance_sid}/trader-seller
name
Name of the trader seller (max 255 characters)
{
"name": "Weapons Dealer"
}PATCH /api/instance/{instance_sid}/trader-seller/{seller_sid}
Update an existing trader seller. Include only fields to change.
DELETE /api/instance/{instance_sid}/trader-seller/{seller_sid}
Permanently delete a trader seller and all associated categories.
Organize your sellers by location or specialization (e.g., "Military Trader", "Medical Supplies", "Vehicle Parts"). Each seller can have multiple categories, and categories contain the actual items. Use descriptive names to help players identify what each trader offers.