/inventory

Previous/index Next/item

Last updated 1 month 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

objectoptional

application/json

delete

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

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

offsetanyoptionalDefault: 0

countanyoptionalDefault: 20

userIdanyoptional

searchanyoptional

Responses

application/json

objectoptional

application/json

get

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

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

offsetanyoptionalDefault: 0

countanyoptionalDefault: 20

userIdanyoptional

profileIdanyoptional

searchanyoptional

Responses

application/json

objectoptional

application/json

get

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

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

objectoptional

application/json

delete

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

Path parameters

inventoryItemIdanyrequired

Responses

application/json

objectoptional

application/json

get

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

Path parameters

inventoryItemIdanyrequired

Responses

application/json

objectoptional

application/json

get

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

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

objectoptional

application/json

delete

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

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

offsetanyoptionalDefault: 0

countanyoptionalDefault: 20

userIdanyoptional

searchanyoptional

Responses

application/json

objectoptional

application/json

get

GET /api/rest/inventory/simple 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

Path parameters

inventoryItemIdanyrequired

Responses

application/json

objectoptional

application/json

get

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

Path parameters

inventoryItemIdanyrequired

Body

quantityany · min: 1optional

The quantity of the Item in inventory

Responses

application/json

objectoptional

application/json

put

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

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

objectoptional

application/json

patch

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

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

objectoptional

application/json

post

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

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

objectoptional

application/json

post

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

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

objectoptional

application/json

put

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

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

objectoptional

application/json

put

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

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

objectoptional

application/json

patch

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

Body

userIdanyrequired

The User ID

itemIdanyrequired

The item to reference.

quantityany · min: 1optional

The quantity of the Item in inventory

Responses

application/json

objectoptional

application/json

post

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