API resources

Instance Resources

Trader Sellers

Trader NPC seller definitions.

5
Endpoints
GET POST PUT DELETE
Methods
Read/write
Access

Base path

/api/v1/instances/{instance}/trader-sellers

Route parameters

Pass public sid values for these route parameters.

{instance} {traderSeller}

Example request

curl -X GET 'https://beta.dzconfig.com/api/v1/instances/{instance}/trader-sellers?per_page=10' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

Endpoints

Method Path Purpose
GET /api/v1/instances/{instance}/trader-sellers List trader sellers
POST /api/v1/instances/{instance}/trader-sellers Create a trader seller
GET /api/v1/instances/{instance}/trader-sellers/{traderSeller} Get trader seller details
PUT /api/v1/instances/{instance}/trader-sellers/{traderSeller} Update a trader seller
DELETE /api/v1/instances/{instance}/trader-sellers/{traderSeller} Delete a trader seller

Query parameters

Parameter Type Description
page integer Page number. Defaults to 1.
per_page integer Items per page. Values are clamped from 1 to 100.
search string Match trader seller name.

Request fields

Field Type Required Description
name string required Seller name (max 255 chars)

Example response

{
    "data": {
        "id": 1,
        "sid": "yZ1aBc",
        "instance_id": 1,
        "name": "Weapons",
        "items_count": 45,
        "categories_count": 3,
        "created_at": "2026-02-01T12:00:00.000000Z",
        "updated_at": "2026-04-10T09:30:00.000000Z"
    }
}

Paginated list shape

{
    "data": [
        {
            "sid": "abc123xy",
            "...": "resource fields"
        }
    ],
    "links": {
        "first": "https://beta.dzconfig.com/api/v1/instances/{instance}/trader-sellers?page=1",
        "last": "https://beta.dzconfig.com/api/v1/instances/{instance}/trader-sellers?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "per_page": 10,
        "total": 1
    }
}

Status codes

Code Label Description
200 OK Returned for successful reads, updates, and deletes.
201 Created Returned when a POST creates a resource.
401 Unauthorized Missing or invalid bearer token.
403 Forbidden Your plan or permissions do not allow this action.
404 Not found The route parameter did not match an accessible resource.
413 Storage limit exceeded Storing the file would exceed your plan's upload count, generated count, or total storage cap.
422 Validation error Request fields failed validation.
429 Rate limited Too many API requests in a short period.