Equip a stack

Developing

POST

https://api.lootlocker.com/game/player/equipment/v1/equip

Attach an inventory stack to an equipment slot on an entity. The slot must carry a tag the item template also carries. When the stack holds more than the slot accepts, the equipped amount splits off and the remainder stays in inventory. An occupied slot is auto-unequipped first unless replace is false. Counts toward the slot's max_items: the equipped amount is min(count or stack count, max_items) and never exceeds the stack.

Request

Authorization

API Key

Add parameter in header

x-session-token

Example:

x-session-token: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.lootlocker.com/game/player/equipment/v1/equip' \
--header 'x-session-token: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "entity_type": "player",
    "source_id": "01HZ6Q8V0R4S8T2W9X3Y5Z7A1B",
    "slot_id": "01HZ6Q8V0R4S8T2W9X3Y5Z7A1B",
    "inventory_id": "01HZ6Q8V0R4S8T2W9X3Y5Z7A1B",
    "count": 3,
    "replace": true
}'

Response Example

201 - Example 1

{
    "entry_id": "string",
    "slot_id": "string",
    "inventory_id": "string",
    "equipped": 0,
    "remainder": 0,
    "replaced_entry_id": "string"
}

Modified at 2026-10-13 16:53:46

Acknowledge Playtest Document

Unequip a stack