Digital Goods and Inventory

PreviousFriends and Followers NextLeaderboards

Last updated 6 months ago

Retrieves all Items

Searches all items and returns all matching items, filtered by the passed in search parameters. If multiple tags are specified, then all items that contain at least one of the passed in tags is returned.

get

/item

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

categoryany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/item' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Creates a new digital Item

Supplying an item object, this will create a new item with a newly assigned unique id. The Item representation returned in the response body is a representation of the Item as persisted with a unique identifier signed and with its fields properly normalized. The supplied item object submitted with the request must have a name property that is unique across all items.

post

/item

Authorizations

Body

displayNameanyrequired

descriptionanyrequired

metadataSpecIdany

publicVisibleany

nameanyrequired

Pattern: [^_]\w+

metadataSpecany

categoryundefined · enumrequired

Options: FUNGIBLE, DISTINCT

tagsany

metadataany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/item' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "displayName": null,
    "description": null,
    "metadataSpecId": null,
    "publicVisible": null,
    "name": null,
    "metadataSpec": null,
    "category": "FUNGIBLE",
    "tags": [],
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Retrieves a single Item by id or by name

Looks up an item by the passed in identifier

get

/item/{identifier}

Authorizations

Path parameters

identifieranyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/item/{identifier}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates a single Item

Supplying an item, this will update the Item identified by the identifier in the path with contents from the passed in request body.

put

/item/{identifier}

Authorizations

Path parameters

identifieranyrequired

Body

displayNameanyrequired

descriptionanyrequired

publicVisibleany

nameanyrequired

Pattern: [^_]\w+

metadataSpecobject

Represents a spec for metadata.

tagsany

metadataany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/item/{identifier}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "displayName": null,
    "description": null,
    "publicVisible": null,
    "name": null,
    "metadataSpec": {
      "id": null,
      "name": null,
      "type": "STRING",
      "properties": [
        "[Circular Reference]"
      ]
    },
    "tags": [],
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets inventory item for the specified item

Gets the first (primary) inventory item for the specified item

get

/inventory/advanced/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates an inventory item for the specified item

put

/inventory/advanced/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Body

quantityany · min: 1

The quantity of the Item in inventory

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "quantity": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Delete the inventory item as identified by the given item name/id

delete

/inventory/advanced/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Adjust the quantity of the inventory item for the specified item.

Adjust the quantity of the first (primary) inventory item for the specified item. This implicitly will create the InventoryItem if it does not exist. The inventory item value

patch

/inventory/advanced/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Body

userIdanyrequired

The User whose inventory to modify.ß

quantityDeltaanyrequired

The delta to be applied to the inventory item quantity (positive or negative)

priorityany

The priority slot for the item.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "userId": null,
    "quantityDelta": null,
    "priority": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Search inventory items

Searches all inventory items in the system and returns the metadata for all matches against the given search filter.

get

/inventory/advanced

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

userIdany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/inventory/advanced' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Create an inventory item for the specified item

post

/inventory/advanced

Authorizations

Body

userIdanyrequired

The User ID

itemIdanyrequired

The item to reference.

quantityany

The quantity of the Item in inventory

priorityany

The priority slot for the item.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/inventory/advanced' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "userId": null,
    "itemId": null,
    "quantity": null,
    "priority": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Search inventory items

Searches all inventory items in the system and returns the metadata for all matches against the given search filter.

get

/inventory/distinct

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

userIdany

profileIdany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/inventory/distinct' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Create an inventory item for the specified item

post

/inventory/distinct

Authorizations

Body

itemIdanyrequired

The digital goods item id.

userIdany

The id of the User owning this inventory item id.

profileIdany

The the profileid of hte Profile owning this inventory item.

metadataany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/inventory/distinct' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "itemId": null,
    "userId": null,
    "profileId": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates an inventory item for the specified item

put

/inventory/distinct/{distinctInventoryItemId}

Authorizations

Path parameters

distinctInventoryItemIdanyrequired

Body

userIdany

The id of the User owning this inventory item id.

profileIdany

The the profile id of hte Profile owning this inventory item.

metadataany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/inventory/distinct/{distinctInventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "userId": null,
    "profileId": null,
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Delete the inventory item as identified by the given item name/id

delete

/inventory/distinct/{distinctInventoryItemId}

Authorizations

Path parameters

distinctInventoryItemIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/inventory/distinct/{distinctInventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets inventory item for the specified item

Gets the first (primary) inventory item for the specified item

get

/inventory/distinct/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/inventory/distinct/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Gets inventory item for the specified item

Gets the first (primary) inventory item for the specified item

get

/inventory/simple/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Updates an inventory item for the specified item

put

/inventory/simple/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Body

quantityany · min: 1

The quantity of the Item in inventory

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "quantity": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Delete the inventory item as identified by the given item name/id

delete

/inventory/simple/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Adjust the quantity of the inventory item for the specified item.

Adjust the quantity of the first (primary) inventory item for the specified item. This implicitly will create the InventoryItem if it does not exist. The inventory item value

patch

/inventory/simple/{inventoryItemId}

Authorizations

Path parameters

inventoryItemIdanyrequired

Body

userIdanyrequired

The User whose inventory to modify.ß

quantityDeltaanyrequired

The delta to be applied to the inventory item quantity (positive or negative)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "userId": null,
    "quantityDelta": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Search inventory items

Searches all inventory items in the system and returns the metadata for all matches against the given search filter.

get

/inventory/simple

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

userIdany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/inventory/simple' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}

Create an inventory item for the specified item

post

/inventory/simple

Authorizations

Body

userIdanyrequired

The User ID

itemIdanyrequired

The item to reference.

quantityany · min: 1

The quantity of the Item in inventory

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/inventory/simple' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "userId": null,
    "itemId": null,
    "quantity": null
  }'

400

401

403

404

409

500

501

503

default

{
  "code": "text",
  "message": "text"
}