API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

product_types

Retrieves the collection of product_types resources.

Retrieves the collection of product_types 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[parent]
boolean
exists[children]
boolean
exists[products]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
exists[number]
boolean
exists[notes]
boolean
exists[color]
boolean
exists[icon]
boolean
exists[root]
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[visibleStatus]
string
Default: "asc"
Enum: "asc" "desc"
order[discount]
string
Default: "asc"
Enum: "asc" "desc"
order[targetProfitability]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
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[id]
string
Default: "asc"
Enum: "asc" "desc"
order[priority]
string
Default: "asc"
Enum: "asc" "desc"
order[root]
string
Default: "asc"
Enum: "asc" "desc"
order[lvl]
string
Default: "asc"
Enum: "asc" "desc"
order[lft]
string
Default: "asc"
Enum: "asc" "desc"
order[rgt]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[number]
string
Default: "asc"
Enum: "asc" "desc"
order[color]
string
Default: "asc"
Enum: "asc" "desc"
order[icon]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
slug_partial
string
id
integer
slug_start_with
string
id
integer
slug_end_with
string
id
integer
slug
string
id_partial
integer
slug
string
id_start_with
integer
slug
string
id_end_with
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer
slug
string
id
integer

Responses

Response samples

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