Digital Goods and Inventory

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.

GEThttp://localhost:8080/api/rest/item

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/item', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

POSThttp://localhost:8080/api/rest/item

Body

name*any

Pattern: [^_]\w+

displayName*any

description*any

category*enum

FUNGIBLEDISTINCT

tagsany

metadataSpecIdany

metadataany

publicVisibleany

metadataSpecany

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/item', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({
      "category": "FUNGIBLE"
    }),
});
const data = await response.json();

Response

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

Retrieves a single Item by id or by name

Looks up an item by the passed in identifier

GEThttp://localhost:8080/api/rest/item/{identifier}

Path parameters

identifier*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/item/{identifier}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

PUThttp://localhost:8080/api/rest/item/{identifier}

Path parameters

identifier*any

Body

name*any

Pattern: [^_]\w+

displayName*any

description*any

tagsany

metadataSpecMetadataSpec (object)

Represents a spec for metadata.

metadataany

publicVisibleany

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/item/{identifier}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Gets inventory item for the specified item

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

GEThttp://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}

Path parameters

inventoryItemId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Updates an inventory item for the specified item

PUThttp://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}

Path parameters

inventoryItemId*any

Body

quantityany

The quantity of the Item in inventory

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

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

DELETEhttp://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}

Path parameters

inventoryItemId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "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

PATCHhttp://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}

Path parameters

inventoryItemId*any

Body

userId*any

The User whose inventory to modify.ß

quantityDelta*any

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

priorityany

The priority slot for the item.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/advanced/{inventoryItemId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.

GEThttp://localhost:8080/api/rest/inventory/advanced

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/advanced', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Create an inventory item for the specified item

POSThttp://localhost:8080/api/rest/inventory/advanced

Body

userId*any

The User ID

itemId*any

The item to reference.

quantityany

The quantity of the Item in inventory

priorityany

The priority slot for the item.

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/advanced', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.

GEThttp://localhost:8080/api/rest/inventory/distinct

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/distinct', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Create an inventory item for the specified item

POSThttp://localhost:8080/api/rest/inventory/distinct

Body

itemId*any

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

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/distinct', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Updates an inventory item for the specified item

PUThttp://localhost:8080/api/rest/inventory/distinct/{distinctInventoryItemId}

Path parameters

distinctInventoryItemId*any

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

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/distinct/{distinctInventoryItemId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

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

DELETEhttp://localhost:8080/api/rest/inventory/distinct/{distinctInventoryItemId}

Path parameters

distinctInventoryItemId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/distinct/{distinctInventoryItemId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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

Gets inventory item for the specified item

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

GEThttp://localhost:8080/api/rest/inventory/distinct/{inventoryItemId}

Path parameters

inventoryItemId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/distinct/{inventoryItemId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Gets inventory item for the specified item

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

GEThttp://localhost:8080/api/rest/inventory/simple/{inventoryItemId}

Path parameters

inventoryItemId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Updates an inventory item for the specified item

PUThttp://localhost:8080/api/rest/inventory/simple/{inventoryItemId}

Path parameters

inventoryItemId*any

Body

quantityany

The quantity of the Item in inventory

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

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

DELETEhttp://localhost:8080/api/rest/inventory/simple/{inventoryItemId}

Path parameters

inventoryItemId*any

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "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

PATCHhttp://localhost:8080/api/rest/inventory/simple/{inventoryItemId}

Path parameters

inventoryItemId*any

Body

userId*any

The User whose inventory to modify.ß

quantityDelta*any

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

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/simple/{inventoryItemId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.

GEThttp://localhost:8080/api/rest/inventory/simple

Query parameters

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/simple', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Create an inventory item for the specified item

POSThttp://localhost:8080/api/rest/inventory/simple

Body

userId*any

The User ID

itemId*any

The item to reference.

quantityany

The quantity of the Item in inventory

Response

Body

codestring

A machine readable code of the error.

messagestring

A description of the error. This error is not intended to be displayed to the end-user, rather it is it designed to relay information to the application developer.

Request

const response = await fetch('http://localhost:8080/api/rest/inventory/simple', {
    method: 'POST',
    headers: {
      "Content-Type": "*/*"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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