Digital Goods and Inventory

Retrieves all Items

get

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.

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

tagsanyOptional

categoryanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/item HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Creates a new digital Item

post

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.

Authorizations

auth_bearersession_secret

Body

nameanyRequiredPattern: [^_]\w+

displayNameanyRequired

descriptionanyRequired

categoryundefined · enumRequiredPossible values:

tagsanyOptional

metadataSpecIdanyOptional

metadataanyOptional

publicVisibleanyOptional

metadataSpecanyWrite-onlyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/item HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 162

{
  "name": null,
  "displayName": null,
  "description": null,
  "category": "FUNGIBLE",
  "tags": [],
  "metadataSpecId": null,
  "metadata": null,
  "publicVisible": null,
  "metadataSpec": null
}

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

Retrieves a single Item by id or by name

get

Looks up an item by the passed in identifier

Authorizations

auth_bearersession_secret

Path parameters

identifieranyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/item/{identifier} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates a single Item

put

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

Authorizations

auth_bearersession_secret

Path parameters

identifieranyRequired

Body

nameanyRequiredPattern: [^_]\w+

displayNameanyRequired

descriptionanyRequired

tagsanyOptional

metadataanyOptional

publicVisibleanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/item/{identifier} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 427

{
  "name": null,
  "displayName": null,
  "description": null,
  "tags": [],
  "metadataSpec": {
    "id": null,
    "name": null,
    "type": "STRING",
    "properties": [
      {
        "name": null,
        "displayName": null,
        "type": "STRING",
        "required": null,
        "placeholder": null,
        "defaultValue": null,
        "properties": [
          {
            "name": null,
            "displayName": null,
            "type": "STRING",
            "required": null,
            "placeholder": null,
            "defaultValue": null,
            "properties": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "metadata": null,
  "publicVisible": null
}

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

Gets inventory item for the specified item

get

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

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/inventory/advanced/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates an inventory item for the specified item

put

Updates an inventory item for the specified item

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Body

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/inventory/advanced/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 17

{
  "quantity": null
}

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

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

delete

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

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/inventory/advanced/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

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

patch

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

Authorizations

auth_bearersession_secret

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)

priorityanyOptional

The priority slot for the item.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/rest/inventory/advanced/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 52

{
  "userId": null,
  "quantityDelta": null,
  "priority": null
}

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

Search inventory items

get

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

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/inventory/advanced HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

auth_bearersession_secret

Body

userIdanyRequired

The User ID

itemIdanyRequired

The item to reference.

quantityanyOptional

The quantity of the Item in inventory

priorityanyOptional

The priority slot for the item.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/inventory/advanced HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 61

{
  "userId": null,
  "itemId": null,
  "quantity": null,
  "priority": null
}

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

Search inventory items

get

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

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptional

profileIdanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/inventory/distinct HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

auth_bearersession_secret

Body

itemIdanyRequired

The digital goods item id.

userIdanyOptional

The id of the User owning this inventory item id.

profileIdanyOptional

The the profileid of hte Profile owning this inventory item.

metadataanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/inventory/distinct HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 62

{
  "itemId": null,
  "userId": null,
  "profileId": null,
  "metadata": null
}

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

Updates an inventory item for the specified item

put

Updates an inventory item for the specified item

Authorizations

auth_bearersession_secret

Path parameters

distinctInventoryItemIdanyRequired

Body

userIdanyOptional

The id of the User owning this inventory item id.

profileIdanyOptional

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

metadataanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/inventory/distinct/{distinctInventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 48

{
  "userId": null,
  "profileId": null,
  "metadata": null
}

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

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

delete

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

Authorizations

auth_bearersession_secret

Path parameters

distinctInventoryItemIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/inventory/distinct/{distinctInventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Gets inventory item for the specified item

get

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

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/inventory/distinct/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Gets inventory item for the specified item

get

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

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/inventory/simple/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Updates an inventory item for the specified item

put

Updates an inventory item for the specified item

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Body

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/inventory/simple/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 17

{
  "quantity": null
}

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

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

delete

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

Authorizations

auth_bearersession_secret

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/inventory/simple/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

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

patch

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

Authorizations

auth_bearersession_secret

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

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/rest/inventory/simple/{inventoryItemId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 36

{
  "userId": null,
  "quantityDelta": null
}

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

Search inventory items

get

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

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/inventory/simple HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

auth_bearersession_secret

Body

userIdanyRequired

The User ID

itemIdanyRequired

The item to reference.

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/inventory/simple HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 45

{
  "userId": null,
  "itemId": null,
  "quantity": null
}

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