/inventory

Gets inventory item for the specified item

get

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

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/advanced/{inventoryItemId}

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

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Body

*/*

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/advanced/{inventoryItemId}

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

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/advanced/{inventoryItemId}

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

AuthorizationstringRequired

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

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/advanced/{inventoryItemId}

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

AuthorizationstringRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptional

searchanyOptional

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/advanced

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

AuthorizationstringRequired

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

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/advanced

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

AuthorizationstringRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptional

profileIdanyOptional

searchanyOptional

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/distinct

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

AuthorizationstringRequired

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

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/distinct

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

AuthorizationstringRequired

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

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/distinct/{distinctInventoryItemId}

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

AuthorizationstringRequired

Path parameters

distinctInventoryItemIdanyRequired

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/distinct/{distinctInventoryItemId}

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

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/distinct/{inventoryItemId}

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

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/simple/{inventoryItemId}

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

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Body

*/*

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/simple/{inventoryItemId}

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

AuthorizationstringRequired

Path parameters

inventoryItemIdanyRequired

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/simple/{inventoryItemId}

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

AuthorizationstringRequired

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

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/simple/{inventoryItemId}

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

auth_bearersession_secret

AuthorizationstringRequired

Body

*/*

userIdanyRequired

The User ID

itemIdanyRequired

The item to reference.

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/simple

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

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

AuthorizationstringRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

userIdanyOptional

searchanyOptional

Responses

400Error

application/json

codestringOptional

A machine readable code of the error.

messagestringOptional

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.

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

/inventory/simple

HTTPcURLJavaScriptPython

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

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