Skip to main content
GET
/
inventory-items
Retrieve Inventory Items
curl --request GET \
  --url https://api.nuwebgroup.com/v1/inventory-items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "items",
      "id": 1,
      "attributes": {
        "name": "Standard Laughing Ticket",
        "companyId": 1,
        "externalId": "",
        "description": "Molestiae recusandae neque velit voluptas quos odio id.",
        "website": "",
        "type": "ticket",
        "inventoryId": 1,
        "showDescription": false,
        "totalStock": null,
        "currentStock": null,
        "hasUnlimitedStock": true,
        "requiresApproval": false,
        "createdAt": "2021-11-22T11:59:00.000000Z",
        "updatedAt": "2021-11-22T11:59:00.000000Z",
        "deletedAt": null
      }
    }
  ],
  "links": {
    "first": "https://api.newtickets.nu/v1/inventory-items?limit=1&offset=0",
    "last": "https://api.newtickets.nu/v1/inventory-items?limit=1&offset=32",
    "prev": null,
    "next": "https://api.newtickets.nu/v1/inventory-items?limit=1&offset=1",
    "self": "https://api.newtickets.nu/v1/inventory-items?limit=1&offset=0"
  },
  "meta": {
    "total": 33
  }
}

Authorizations

ā€‹
Authorization
string
header
required

The 'Bearer' token can be obtained from the token management interface or via the login endpoint using your admin user credentials.

Query Parameters

ā€‹
page
integer

The page you wish to retrieve inventory items items. If not specified, by default pagination is handled by offset.

ā€‹
offset
integer

The offset - e.g 2 for listing inventory items starting with the 2nd inventory item. Offset will always take precedence over page.

ā€‹
limit
integer

The number of inventory items to retrieve per page. The maximum (and default) is 25 per page.

ā€‹
withTrashed
enum<string>

Controls records returned depending on their deletedAt status. This is a global flag, so will apply to all resources, including relationships such as resources returned under the included attribute.

  • true to include deleted records
  • false to exclude deleted records (or leave blank)

Available options:
true,
false
ā€‹
only
string

A list of attributes that you wish to be returned in the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. items.name. Can be used in conjunction with except providing both parameters don't reference the same resource.

ā€‹
except
string

A list of attributes that you wish to exclude from the payload. When empty or omitted, all fields will be included by default. Use dot-notation for both top-level resources and child resources, i.e. items.name. Can be used in conjunction with only providing both parameters don't reference the same resource.

Response

Successful request to fetch inventory items.

ā€‹
data
object[]
ā€‹
links
object
ā€‹
meta
object