API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

inventory_entries

Retrieves the collection of inventory_entries resources.

Retrieves the collection of inventory_entries resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[description]
boolean
exists[bill]
boolean
exists[invoice]
boolean
exists[task]
boolean
exists[notes]
boolean
exists[batch]
boolean
exists[transferEntryId]
boolean
exists[scan]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[timestamp]
string
Default: "asc"
Enum: "asc" "desc"
order[datetime]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[number]
string
Default: "asc"
Enum: "asc" "desc"
order[description]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[transferEntryId]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[scan]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
batch
string
batch[]
Array of strings
bill
string
bill[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
datetime[before]
string
datetime[strictly_before]
string
datetime[after]
string
datetime[strictly_after]
string
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
invoice
string
invoice[]
Array of strings
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
number_range[between]
string
number_range[gt]
string
number_range[gte]
string
number_range[lt]
string
number_range[lte]
string
number
string
number[]
Array of strings
person
string
person[]
Array of strings
product
string
product[]
Array of strings
scan_end_with
string
scan_partial
string
scan_start_with
string
scan
string
scan[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
task
string
task[]
Array of strings
timestamp[before]
string
timestamp[strictly_before]
string
timestamp[after]
string
timestamp[strictly_after]
string
transferEntryId_range[between]
string
transferEntryId_range[gt]
string
transferEntryId_range[gte]
string
transferEntryId_range[lt]
string
transferEntryId_range[lte]
string
transferEntryId
integer
transferEntryId[]
Array of integers
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}