/inventory

Gets inventory item for the specified item

get

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

Authorizations
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Responses
get
/inventory/advanced/{inventoryItemId}
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
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Body
quantityany · min: 1Optional

The quantity of the Item in inventory

Responses
put
/inventory/advanced/{inventoryItemId}
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
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Responses
delete
/inventory/advanced/{inventoryItemId}
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
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
patch
/inventory/advanced/{inventoryItemId}
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
AuthorizationstringRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
userIdanyOptional
searchanyOptional
Responses
get
/inventory/advanced
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
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
post
/inventory/advanced
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
AuthorizationstringRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
userIdanyOptional
profileIdanyOptional
searchanyOptional
Responses
get
/inventory/distinct
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
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
post
/inventory/distinct
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
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
put
/inventory/distinct/{distinctInventoryItemId}
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
AuthorizationstringRequired
Path parameters
distinctInventoryItemIdanyRequired
Responses
delete
/inventory/distinct/{distinctInventoryItemId}
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
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Responses
get
/inventory/distinct/{inventoryItemId}
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
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Responses
get
/inventory/simple/{inventoryItemId}
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
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Body
quantityany · min: 1Optional

The quantity of the Item in inventory

Responses
put
/inventory/simple/{inventoryItemId}
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
AuthorizationstringRequired
Path parameters
inventoryItemIdanyRequired
Responses
delete
/inventory/simple/{inventoryItemId}
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
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
patch
/inventory/simple/{inventoryItemId}
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
AuthorizationstringRequired
Body
userIdanyRequired

The User ID

itemIdanyRequired

The item to reference.

quantityany · min: 1Optional

The quantity of the Item in inventory

Responses
post
/inventory/simple
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
AuthorizationstringRequired
Query parameters
offsetanyOptionalDefault: 0
countanyOptionalDefault: 20
userIdanyOptional
searchanyOptional
Responses
get
/inventory/simple
GET /api/rest/inventory/simple HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}
Previous/indexNext/item

Last updated