API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

products

Retrieves the collection of products resources.

Retrieves the collection of products 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[inventoryEntries]
boolean
exists[invoiceLines]
boolean
exists[billLines]
boolean
exists[taxCustoms]
boolean
exists[productComponents]
boolean
exists[componentProducts]
boolean
exists[sectors]
boolean
exists[sku]
boolean
exists[version]
boolean
exists[country]
boolean
exists[place]
boolean
exists[placePrecision]
boolean
exists[brand]
boolean
exists[supplier]
boolean
exists[notes]
boolean
exists[notesInvoice]
boolean
exists[notesBill]
boolean
exists[notesRent]
boolean
exists[notesProduction]
boolean
exists[notesInventory]
boolean
exists[notesShipping]
boolean
exists[productOptions]
boolean
exists[productBuyCosts]
boolean
exists[productSellPrices]
boolean
exists[subProductOptions]
boolean
exists[rents]
boolean
exists[rentsCharged]
boolean
exists[supplierCode]
boolean
exists[clientCode]
boolean
exists[shCode]
boolean
exists[reservationPeriodicity]
boolean
exists[deletedAt]
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
order[timestamp]
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[sku]
string
Default: "asc"
Enum: "asc" "desc"
order[version]
string
Default: "asc"
Enum: "asc" "desc"
order[country]
string
Default: "asc"
Enum: "asc" "desc"
order[place]
string
Default: "asc"
Enum: "asc" "desc"
order[placePrecision]
string
Default: "asc"
Enum: "asc" "desc"
order[supplierCode]
string
Default: "asc"
Enum: "asc" "desc"
order[clientCode]
string
Default: "asc"
Enum: "asc" "desc"
order[shCode]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[price]
string
Default: "asc"
Enum: "asc" "desc"
order[priceSpecial]
string
Default: "asc"
Enum: "asc" "desc"
order[weight]
string
Default: "asc"
Enum: "asc" "desc"
order[dimensionW]
string
Default: "asc"
Enum: "asc" "desc"
order[dimensionH]
string
Default: "asc"
Enum: "asc" "desc"
order[dimensionD]
string
Default: "asc"
Enum: "asc" "desc"
order[time]
string
Default: "asc"
Enum: "asc" "desc"
order[cost]
string
Default: "asc"
Enum: "asc" "desc"
order[additionnalProductionCost]
string
Default: "asc"
Enum: "asc" "desc"
order[costSpecial]
string
Default: "asc"
Enum: "asc" "desc"
order[invQtyMin]
string
Default: "asc"
Enum: "asc" "desc"
order[invQtyMax]
string
Default: "asc"
Enum: "asc" "desc"
order[moq]
string
Default: "asc"
Enum: "asc" "desc"
order[packageOrder]
string
Default: "asc"
Enum: "asc" "desc"
order[unitNb]
string
Default: "asc"
Enum: "asc" "desc"
order[periodicityPrecision]
string
Default: "asc"
Enum: "asc" "desc"
order[visibleStatus]
string
Default: "asc"
Enum: "asc" "desc"
order[taxable]
string
Default: "asc"
Enum: "asc" "desc"
order[producible]
string
Default: "asc"
Enum: "asc" "desc"
order[newStatus]
string
Default: "asc"
Enum: "asc" "desc"
order[inventoryTracking]
string
Default: "asc"
Enum: "asc" "desc"
order[rentTracking]
string
Default: "asc"
Enum: "asc" "desc"
order[countedInInventory]
string
Default: "asc"
Enum: "asc" "desc"
order[shippingTracking]
string
Default: "asc"
Enum: "asc" "desc"
order[bookable]
string
Default: "asc"
Enum: "asc" "desc"
order[discountable]
string
Default: "asc"
Enum: "asc" "desc"
order[salable]
string
Default: "asc"
Enum: "asc" "desc"
order[purchasable]
string
Default: "asc"
Enum: "asc" "desc"
order[onDistribution]
string
Default: "asc"
Enum: "asc" "desc"
order[onWebsite]
string
Default: "asc"
Enum: "asc" "desc"
order[isVariableExpense]
string
Default: "asc"
Enum: "asc" "desc"
order[isImmo]
string
Default: "asc"
Enum: "asc" "desc"
order[isConsumable]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[notesInvoice]
string
Default: "asc"
Enum: "asc" "desc"
order[notesBill]
string
Default: "asc"
Enum: "asc" "desc"
order[notesRent]
string
Default: "asc"
Enum: "asc" "desc"
order[notesProduction]
string
Default: "asc"
Enum: "asc" "desc"
order[notesInventory]
string
Default: "asc"
Enum: "asc" "desc"
order[notesShipping]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
tag
string

Filter using tag.

Responses

Response samples

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