/inventory

Previous/index Next/item

Last updated 18 days ago

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

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

Search inventory items

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

userIdanyoptional

searchanyoptional

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

Search inventory items

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

userIdanyoptional

profileIdanyoptional

searchanyoptional

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

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

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

get

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

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

get

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

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

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

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

Search inventory items

get

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

Authorizations

Query parameters

offsetany · default: 0optional

countany · default: 20optional

userIdanyoptional

searchanyoptional

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

Gets inventory item for the specified item

get

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

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

Updates an inventory item for the specified item

Authorizations

Path parameters

inventoryItemIdanyrequired

Body

quantityany · min: 1optional

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

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

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

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

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

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

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

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

Updates an inventory item for the specified item

Authorizations

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

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

Updates an inventory item for the specified item

put

Updates an inventory item for the specified item

Authorizations

Path parameters

inventoryItemIdanyrequired

Body

quantityany · min: 1optional

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

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

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

Create an inventory item for the specified item

post

Create an inventory item for the specified item

Authorizations

Body

userIdanyrequired

The User ID

itemIdanyrequired

The item to reference.

quantityany · min: 1optional

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