Item

GET/api/v1/items/{domain}/blueprints

List_blueprints

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

q?string

Full-text query applied to the entity name

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/blueprints"

{  "blueprints": [    {      "blueprint_id": "string",      "context_requirements": null,      "created_at": "2019-08-24T14:15:22Z",      "domain": "string",      "inputs": [        {          "match": "definition_id",          "quantity": 0,          "value": "string"        }      ],      "name": "string",      "outputs": [        {          "chance": 0.1,          "definition_id": "string",          "initial_durability_pct": 0.1,          "quantity": 0        }      ],      "type": "static",      "version": 0    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/items/{domain}/blueprints

Create_blueprint

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

context_requirements?unknown

Context requirements (e.g. station)

inputs*array<>

Inputs by definition id or tag

name*string

Display name

outputs*array<>

Probabilistic outputs

type?BlueprintType

Static or discoverable

Value in

"static"
"discoverable"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/blueprints" \  -H "Content-Type: application/json" \  -d '{    "inputs": [      {        "quantity": 0,        "value": "string"      }    ],    "name": "string",    "outputs": [      {        "definition_id": "string",        "quantity": 0      }    ]  }'

{  "blueprint_id": "string",  "context_requirements": null,  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "inputs": [    {      "match": "definition_id",      "quantity": 0,      "value": "string"    }  ],  "name": "string",  "outputs": [    {      "chance": 0.1,      "definition_id": "string",      "initial_durability_pct": 0.1,      "quantity": 0    }  ],  "type": "static",  "version": 0}

GET/api/v1/items/{domain}/blueprints/{id}

Get_blueprint

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/blueprints/string"

{  "blueprint_id": "string",  "context_requirements": null,  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "inputs": [    {      "match": "definition_id",      "quantity": 0,      "value": "string"    }  ],  "name": "string",  "outputs": [    {      "chance": 0.1,      "definition_id": "string",      "initial_durability_pct": 0.1,      "quantity": 0    }  ],  "type": "static",  "version": 0}

DELETE/api/v1/items/{domain}/blueprints/{id}

Delete_blueprint

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/items/string/blueprints/string"

{  "id": "string",  "message": "string"}

PUT/api/v1/items/{domain}/blueprints/{id}

Update_blueprint

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

blueprint_type?null|

inputs?array<>|

Inputs

name?|

Display name

outputs?array<>|

Outputs

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/items/string/blueprints/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "blueprint_id": "string",  "context_requirements": null,  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "inputs": [    {      "match": "definition_id",      "quantity": 0,      "value": "string"    }  ],  "name": "string",  "outputs": [    {      "chance": 0.1,      "definition_id": "string",      "initial_durability_pct": 0.1,      "quantity": 0    }  ],  "type": "static",  "version": 0}

GET/api/v1/items/{domain}/collections

List_collections

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

q?string

Full-text query applied to the entity name

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/collections"

{  "collections": [    {      "collection_id": "string",      "convert_event": "string",      "created_at": "2019-08-24T14:15:22Z",      "domain": "string",      "duplicate_policy": "ignore",      "members": [        "string"      ],      "name": "string",      "rarity_weighting": true,      "tiers": [        {          "bonus_event": "string",          "required": 0        }      ]    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/items/{domain}/collections

Create_collection

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

convert_event?|

Treasury event emitted when a duplicate is converted

duplicate_policy?DuplicatePolicy

Duplicate handling policy

Value in

"ignore"
"count"
"convert"

members*array<string>

Member definition ids

name*string

Display name

rarity_weighting?boolean

Whether rarity weighting is enabled

tiers?array<>

Completion tiers

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/collections" \  -H "Content-Type: application/json" \  -d '{    "members": [      "string"    ],    "name": "string"  }'

{  "collection_id": "string",  "convert_event": "string",  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "duplicate_policy": "ignore",  "members": [    "string"  ],  "name": "string",  "rarity_weighting": true,  "tiers": [    {      "bonus_event": "string",      "required": 0    }  ]}

GET/api/v1/items/{domain}/collections/{id}

Get_collection

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/collections/string"

{  "collection_id": "string",  "convert_event": "string",  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "duplicate_policy": "ignore",  "members": [    "string"  ],  "name": "string",  "rarity_weighting": true,  "tiers": [    {      "bonus_event": "string",      "required": 0    }  ]}

DELETE/api/v1/items/{domain}/collections/{id}

Delete_collection

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/items/string/collections/string"

{  "id": "string",  "message": "string"}

PUT/api/v1/items/{domain}/collections/{id}

Update_collection

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

duplicate_policy?null|

members?array<string>|

Member definition ids

name?|

Display name

tiers?array<>|

Completion tiers

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/items/string/collections/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "collection_id": "string",  "convert_event": "string",  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "duplicate_policy": "ignore",  "members": [    "string"  ],  "name": "string",  "rarity_weighting": true,  "tiers": [    {      "bonus_event": "string",      "required": 0    }  ]}

GET/api/v1/items/{domain}/collections/{id}/progress

Collection_progress

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Query Parameters

user_id*string

User whose progress is requested

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/collections/string/progress?user_id=string"

{  "collection_id": "string",  "completed": true,  "duplicate_counts": {    "property1": 0,    "property2": 0  },  "owned": [    "string"  ],  "owned_count": 0,  "tiers_reached": [    0  ],  "total_members": 0,  "user_id": "string"}

POST/api/v1/items/{domain}/containers

Create_container

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

accepts?

Tag-based accept policy

kind?ContainerKind

Container kind (slotted, list, equipment)

Value in

"slotted"
"list"
"equipment"

limits?

Weight/volume limits

metadata?unknown

Arbitrary metadata

owner_id?|

Owner of the container; ignored — derived from the caller's identity

parent_container_id?|

Parent container id for nesting

slots?|

Number of slots for slotted/equipment containers

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/containers" \  -H "Content-Type: application/json" \  -d '{}'

{  "children": [    {}  ],  "container_id": "string",  "contents": [    {      "attributes": null,      "collection_tags": [        "string"      ],      "container_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "definition_id": "string",      "domain": "string",      "durability": null,      "freshness": {        "expires_at": "2019-08-24T14:15:22Z"      },      "item_id": "string",      "owner_id": "string",      "quantity": 0,      "slot": 0,      "state": "normal"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "kind": "slotted",  "limits": {    "max_volume": 0,    "max_weight": 0  },  "owner_id": "string",  "parent_container_id": "string",  "slots": 0}

GET/api/v1/items/{domain}/containers/{container_id}

Get_container

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

container_id*string

Query Parameters

expand?string

Set to contents to recursively expand nested container contents

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/containers/string"

{  "children": [    {}  ],  "container_id": "string",  "contents": [    {      "attributes": null,      "collection_tags": [        "string"      ],      "container_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "definition_id": "string",      "domain": "string",      "durability": null,      "freshness": {        "expires_at": "2019-08-24T14:15:22Z"      },      "item_id": "string",      "owner_id": "string",      "quantity": 0,      "slot": 0,      "state": "normal"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "domain": "string",  "kind": "slotted",  "limits": {    "max_volume": 0,    "max_weight": 0  },  "owner_id": "string",  "parent_container_id": "string",  "slots": 0}

POST/api/v1/items/{domain}/craft

Craft

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

blueprint_id?|

Explicit blueprint id; omit to discover a matching blueprint

idempotency_key?|

Idempotency key

output_slot?|

Target slot for the produced items

Formatint32

Range0 <= value

source_container_id*string

Source container supplying the inputs

target_container_id*string

Target container for the produced items

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/craft" \  -H "Content-Type: application/json" \  -d '{    "source_container_id": "string",    "target_container_id": "string"  }'

{  "blueprint_id": "string",  "consumed": [    {      "definition_id": "string",      "quantity": 0    }  ],  "global_first": true,  "produced": [    {      "attributes": null,      "collection_tags": [        "string"      ],      "container_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "definition_id": "string",      "domain": "string",      "durability": null,      "freshness": {        "expires_at": "2019-08-24T14:15:22Z"      },      "item_id": "string",      "owner_id": "string",      "quantity": 0,      "slot": 0,      "state": "normal"    }  ],  "tier_events": [    {      "bonus_event": "string",      "collection_id": "string",      "global_first": true,      "required": 0    }  ]}

GET/api/v1/items/{domain}/definitions

List_definitions

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Query Parameters

q?string

Full-text query applied to the entity name

page?integer

1-indexed page number

Formatint64

Range0 <= value

page_size?integer

Page size

Formatint64

Range0 <= value

sort_by?string

Sort field

sort_order?string

Sort order (asc or desc)

Value in

"asc"
"desc"

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/definitions"

{  "definitions": [    {      "created_at": "2019-08-24T14:15:22Z",      "default_durability": null,      "definition_id": "string",      "domain": "string",      "equip_slot": "string",      "max_stack": 0,      "name": "string",      "rarity": "common",      "salvage_outputs": [        {          "chance": 0.1,          "definition_id": "string",          "quantity": 0        }      ],      "stackable": true,      "tags": [        "string"      ],      "volume": 0.1,      "weight": 0.1    }  ],  "pagination": {    "has_more": true,    "page": 0,    "page_size": 0,    "total": 0  }}

POST/api/v1/items/{domain}/definitions

Create_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

default_durability?null|

equip_slot?|

Equipment slot label

max_stack*integer

Maximum stack size

Formatint32

Range0 <= value

metadata?unknown

Arbitrary metadata

name*string

Display name

rarity?Rarity

Rarity tier

Value in

"common"
"uncommon"
"rare"
"epic"
"legendary"

salvage_outputs?array<>

Outputs produced when salvaged

stackable?boolean

Whether the item stacks

tags?array<string>

Tags used by blueprints and containers

volume?number

Volume per unit

Formatdouble

weight?number

Weight per unit

Formatdouble

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/definitions" \  -H "Content-Type: application/json" \  -d '{    "max_stack": 0,    "name": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "default_durability": null,  "definition_id": "string",  "domain": "string",  "equip_slot": "string",  "max_stack": 0,  "name": "string",  "rarity": "common",  "salvage_outputs": [    {      "chance": 0.1,      "definition_id": "string",      "quantity": 0    }  ],  "stackable": true,  "tags": [    "string"  ],  "volume": 0.1,  "weight": 0.1}

POST/api/v1/items/{domain}/definitions/batch

Create many item definitions under a domain in one request (catalog import)

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A batch of item definitions to create under one domain (catalog import). Created independently and fail-fast; the server enforces a per-batch cap.

definitions*array<>

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/definitions/batch" \  -H "Content-Type: application/json" \  -d '{    "definitions": [      {        "max_stack": 0,        "name": "string"      }    ]  }'

{  "count": 0,  "definitions": [    {      "created_at": "2019-08-24T14:15:22Z",      "default_durability": null,      "definition_id": "string",      "domain": "string",      "equip_slot": "string",      "max_stack": 0,      "name": "string",      "rarity": "common",      "salvage_outputs": [        {          "chance": 0.1,          "definition_id": "string",          "quantity": 0        }      ],      "stackable": true,      "tags": [        "string"      ],      "volume": 0.1,      "weight": 0.1    }  ]}

GET/api/v1/items/{domain}/definitions/{id}

Get_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/items/string/definitions/string"

{  "created_at": "2019-08-24T14:15:22Z",  "default_durability": null,  "definition_id": "string",  "domain": "string",  "equip_slot": "string",  "max_stack": 0,  "name": "string",  "rarity": "common",  "salvage_outputs": [    {      "chance": 0.1,      "definition_id": "string",      "quantity": 0    }  ],  "stackable": true,  "tags": [    "string"  ],  "volume": 0.1,  "weight": 0.1}

DELETE/api/v1/items/{domain}/definitions/{id}

Delete_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/items/string/definitions/string"

{  "id": "string",  "message": "string"}

PUT/api/v1/items/{domain}/definitions/{id}

Update_definition

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

max_stack?|

Maximum stack size

Formatint32

Range0 <= value

name?|

Display name

rarity?null|

salvage_outputs?array<>|

Salvage outputs

stackable?|

Whether the item stacks

tags?array<string>|

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/items/string/definitions/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "default_durability": null,  "definition_id": "string",  "domain": "string",  "equip_slot": "string",  "max_stack": 0,  "name": "string",  "rarity": "common",  "salvage_outputs": [    {      "chance": 0.1,      "definition_id": "string",      "quantity": 0    }  ],  "stackable": true,  "tags": [    "string"  ],  "volume": 0.1,  "weight": 0.1}

POST/api/v1/items/{domain}/grant

Grant_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

container_id*string

Destination container id

definition_id*string

Definition to instantiate

idempotency_key?|

Idempotency key

owner_id?|

Owner to grant to; only admins may grant to a different user

quantity*integer

Quantity to grant

Formatint32

Range0 <= value

slot?|

Optional target slot

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/grant" \  -H "Content-Type: application/json" \  -d '{    "container_id": "string",    "definition_id": "string",    "quantity": 0  }'

{  "items": [    {      "attributes": null,      "collection_tags": [        "string"      ],      "container_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "definition_id": "string",      "domain": "string",      "durability": null,      "freshness": {        "expires_at": "2019-08-24T14:15:22Z"      },      "item_id": "string",      "owner_id": "string",      "quantity": 0,      "slot": 0,      "state": "normal"    }  ]}

POST/api/v1/items/{domain}/merge

Merge_items

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Idempotency key

source_item_id*string

Source stack consumed by the merge

target_item_id*string

Target stack receiving the quantity

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/merge" \  -H "Content-Type: application/json" \  -d '{    "source_item_id": "string",    "target_item_id": "string"  }'

{  "target": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  }}

POST/api/v1/items/{domain}/move

Move_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Idempotency key

item_id*string

Item to move

to_container_id*string

Destination container id

to_slot?|

Destination slot

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/move" \  -H "Content-Type: application/json" \  -d '{    "item_id": "string",    "to_container_id": "string"  }'

{  "item": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  }}

POST/api/v1/items/{domain}/reservations

Create_reservation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

definition_id*string

Definition reserved

idempotency_key?|

Idempotency key

quantity*integer

Quantity to hold

Formatint32

Range0 <= value

source_container_id*string

Container the hold is taken against

ttl_seconds?|

Hold time-to-live in seconds

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/reservations" \  -H "Content-Type: application/json" \  -d '{    "definition_id": "string",    "quantity": 0,    "source_container_id": "string"  }'

{  "created_at": "2019-08-24T14:15:22Z",  "definition_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "owner_id": "string",  "quantity": 0,  "reservation_id": "string",  "source_container_id": "string",  "status": "active"}

POST/api/v1/items/{domain}/reservations/{reservation_id}/commit

Commit_reservation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

reservation_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented by the caller

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/reservations/string/commit" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "definition_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "owner_id": "string",  "quantity": 0,  "reservation_id": "string",  "source_container_id": "string",  "status": "active"}

POST/api/v1/items/{domain}/reservations/{reservation_id}/refresh

Refresh_reservation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

reservation_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented by the caller

Formatint64

Range0 <= value

ttl_seconds?|

New TTL in seconds

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/reservations/string/refresh" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "definition_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "owner_id": "string",  "quantity": 0,  "reservation_id": "string",  "source_container_id": "string",  "status": "active"}

POST/api/v1/items/{domain}/reservations/{reservation_id}/release

Release_reservation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

reservation_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented by the caller

Formatint64

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/reservations/string/release" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "definition_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "owner_id": "string",  "quantity": 0,  "reservation_id": "string",  "source_container_id": "string",  "status": "active"}

POST/api/v1/items/{domain}/reservations/{reservation_id}/shrink

Shrink_reservation

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

reservation_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

fencing_token*integer

Fencing token presented by the caller

Formatint64

Range0 <= value

quantity*integer

New, smaller quantity

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/reservations/string/shrink" \  -H "Content-Type: application/json" \  -d '{    "fencing_token": 0,    "quantity": 0  }'

{  "created_at": "2019-08-24T14:15:22Z",  "definition_id": "string",  "expires_at": "2019-08-24T14:15:22Z",  "fencing_token": 0,  "owner_id": "string",  "quantity": 0,  "reservation_id": "string",  "source_container_id": "string",  "status": "active"}

POST/api/v1/items/{domain}/split

Split_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Idempotency key

item_id*string

Item to split

quantity*integer

Quantity to split off into a new stack

Formatint32

Range0 <= value

to_slot?|

Slot for the new stack

Formatint32

Range0 <= value

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/split" \  -H "Content-Type: application/json" \  -d '{    "item_id": "string",    "quantity": 0  }'

{  "created": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  },  "source": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  }}

POST/api/v1/items/{domain}/transfer

Transfer_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

idempotency_key?|

Idempotency key

item_id*string

Item to transfer

to_container_id*string

Destination container owned by the recipient

to_user_id*string

Recipient user id

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/transfer" \  -H "Content-Type: application/json" \  -d '{    "item_id": "string",    "to_container_id": "string",    "to_user_id": "string"  }'

{  "item": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  }}

POST/api/v1/items/{domain}/{item_id}/repair

Repair_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

item_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount?|

Durability to restore; omit to restore to max

Formatdouble

materials_from?|

Container to draw repair materials from

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/string/repair" \  -H "Content-Type: application/json" \  -d '{}'

{  "item": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  }}

POST/api/v1/items/{domain}/{item_id}/salvage

Salvage_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

item_id*string

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/string/salvage"

{  "granted": [    {      "attributes": null,      "collection_tags": [        "string"      ],      "container_id": "string",      "created_at": "2019-08-24T14:15:22Z",      "definition_id": "string",      "domain": "string",      "durability": null,      "freshness": {        "expires_at": "2019-08-24T14:15:22Z"      },      "item_id": "string",      "owner_id": "string",      "quantity": 0,      "slot": 0,      "state": "normal"    }  ],  "item_id": "string"}

POST/api/v1/items/{domain}/{item_id}/use

Use_item

Authorization

bearer_token

AuthorizationBearer <token>

In: header

Path Parameters

domain*string

item_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount?number

Amount of wear to apply

Formatdouble

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/items/string/string/use" \  -H "Content-Type: application/json" \  -d '{}'

{  "item": {    "attributes": null,    "collection_tags": [      "string"    ],    "container_id": "string",    "created_at": "2019-08-24T14:15:22Z",    "definition_id": "string",    "domain": "string",    "durability": null,    "freshness": {      "expires_at": "2019-08-24T14:15:22Z"    },    "item_id": "string",    "owner_id": "string",    "quantity": 0,    "slot": 0,    "state": "normal"  }}

200application/json

201application/json

403

200application/json

404

200application/json

403

404

200application/json

403

404

200application/json

201application/json

403

200application/json

404

200application/json

403

404

200application/json

403

404

200application/json

403

404

201application/json

400

403

200application/json

404

200application/json

400

403

200application/json

201application/json

403

201application/json

400

403

200application/json

404

200application/json

403

404

200application/json

403

404

201application/json

400

403

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`