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.

additionnalProductionCost_range[between]
string
additionnalProductionCost_range[gt]
string
additionnalProductionCost_range[gte]
string
additionnalProductionCost_range[lt]
string
additionnalProductionCost_range[lte]
string
additionnalProductionCost
string
additionnalProductionCost[]
Array of strings
billLineType
string
billLineType[]
Array of strings
bookable
boolean
brand
string
brand[]
Array of strings
clientCode_end_with
string
clientCode_partial
string
clientCode_start_with
string
clientCode
string
clientCode[]
Array of strings
cost_range[between]
string
cost_range[gt]
string
cost_range[gte]
string
cost_range[lt]
string
cost_range[lte]
string
cost
string
cost[]
Array of strings
costSpecial_range[between]
string
costSpecial_range[gt]
string
costSpecial_range[gte]
string
costSpecial_range[lt]
string
costSpecial_range[lte]
string
costSpecial
string
costSpecial[]
Array of strings
countedInInventory
boolean
country_end_with
string
country_partial
string
country_start_with
string
country
string
country[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
dimensionD_range[between]
string
dimensionD_range[gt]
string
dimensionD_range[gte]
string
dimensionD_range[lt]
string
dimensionD_range[lte]
string
dimensionD
string
dimensionD[]
Array of strings
dimensionH_range[between]
string
dimensionH_range[gt]
string
dimensionH_range[gte]
string
dimensionH_range[lt]
string
dimensionH_range[lte]
string
dimensionH
string
dimensionH[]
Array of strings
dimensionW_range[between]
string
dimensionW_range[gt]
string
dimensionW_range[gte]
string
dimensionW_range[lt]
string
dimensionW_range[lte]
string
dimensionW
string
dimensionW[]
Array of strings
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
discountable
boolean
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
invQtyMax_range[between]
string
invQtyMax_range[gt]
string
invQtyMax_range[gte]
string
invQtyMax_range[lt]
string
invQtyMax_range[lte]
string
invQtyMax
string
invQtyMax[]
Array of strings
invQtyMin_range[between]
string
invQtyMin_range[gt]
string
invQtyMin_range[gte]
string
invQtyMin_range[lt]
string
invQtyMin_range[lte]
string
invQtyMin
string
invQtyMin[]
Array of strings
inventoryTracking
boolean
invoiceLineType
string
invoiceLineType[]
Array of strings
isConsumable
boolean
isImmo
boolean
isVariableExpense
boolean
moq_range[between]
string
moq_range[gt]
string
moq_range[gte]
string
moq_range[lt]
string
moq_range[lte]
string
moq
string
moq[]
Array of strings
newStatus
boolean
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
notesBill_end_with
string
notesBill_partial
string
notesBill_start_with
string
notesBill
string
notesBill[]
Array of strings
notesInventory_end_with
string
notesInventory_partial
string
notesInventory_start_with
string
notesInventory
string
notesInventory[]
Array of strings
notesInvoice_end_with
string
notesInvoice_partial
string
notesInvoice_start_with
string
notesInvoice
string
notesInvoice[]
Array of strings
notesProduction_end_with
string
notesProduction_partial
string
notesProduction_start_with
string
notesProduction
string
notesProduction[]
Array of strings
notesRent_end_with
string
notesRent_partial
string
notesRent_start_with
string
notesRent
string
notesRent[]
Array of strings
notesShipping_end_with
string
notesShipping_partial
string
notesShipping_start_with
string
notesShipping
string
notesShipping[]
Array of strings
onDistribution
boolean
onWebsite
boolean
packageOrder_range[between]
string
packageOrder_range[gt]
string
packageOrder_range[gte]
string
packageOrder_range[lt]
string
packageOrder_range[lte]
string
packageOrder
string
packageOrder[]
Array of strings
periodicityPrecision_range[between]
string
periodicityPrecision_range[gt]
string
periodicityPrecision_range[gte]
string
periodicityPrecision_range[lt]
string
periodicityPrecision_range[lte]
string
periodicityPrecision
string
periodicityPrecision[]
Array of strings
place_end_with
string
place_partial
string
place_start_with
string
place
string
place[]
Array of strings
placePrecision_end_with
string
placePrecision_partial
string
placePrecision_start_with
string
placePrecision
string
placePrecision[]
Array of strings
price_range[between]
string
price_range[gt]
string
price_range[gte]
string
price_range[lt]
string
price_range[lte]
string
price
string
price[]
Array of strings
priceSpecial_range[between]
string
priceSpecial_range[gt]
string
priceSpecial_range[gte]
string
priceSpecial_range[lt]
string
priceSpecial_range[lte]
string
priceSpecial
string
priceSpecial[]
Array of strings
producible
boolean
purchasable
boolean
rentTracking
boolean
reservationPeriodicity
string
reservationPeriodicity[]
Array of strings
salable
boolean
shCode_end_with
string
shCode_partial
string
shCode_start_with
string
shCode
string
shCode[]
Array of strings
shippingTracking
boolean
sku_end_with
string
sku_partial
string
sku_start_with
string
sku
string
sku[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
supplier
string
supplier[]
Array of strings
supplierCode_end_with
string
supplierCode_partial
string
supplierCode_start_with
string
supplierCode
string
supplierCode[]
Array of strings
taxable
boolean
time_range[between]
string
time_range[gt]
string
time_range[gte]
string
time_range[lt]
string
time_range[lte]
string
time
string
time[]
Array of strings
timestamp[before]
string
timestamp[strictly_before]
string
timestamp[after]
string
timestamp[strictly_after]
string
type
string
type[]
Array of strings
unitNb_range[between]
string
unitNb_range[gt]
string
unitNb_range[gte]
string
unitNb_range[lt]
string
unitNb_range[lte]
string
unitNb
string
unitNb[]
Array of strings
unitType
string
unitType[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
version_end_with
string
version_partial
string
version_start_with
string
version
string
version[]
Array of strings
visibleStatus
boolean
weight_range[between]
string
weight_range[gt]
string
weight_range[gte]
string
weight_range[lt]
string
weight_range[lte]
string
weight
string
weight[]
Array of strings

Responses

Response samples

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

Creates a products resource.

Creates a products resource.

Authorizations:
JWT
Request Body schema:
required

The new products resource

name
string
description
string
Array of objects (project_sectors.jsonld-add_post)
sku
string or null
version
string or null
price
required
string
priceSpecial
required
string
visibleStatus
required
boolean
Default: true
taxable
required
boolean
Default: true
country
string or null
place
string or null <= 255 characters
placePrecision
string or null <= 255 characters
producible
required
boolean
Default: true
newStatus
required
boolean
Default: true
required
object (product_types.jsonld-add_post)

Type.

product_brands.jsonld-add_post (object) or null
person_suppliers.jsonld-add_post (object) or null
weight
required
string
dimensionW
required
string
dimensionH
required
string
dimensionD
required
string
time
string

Assert\NotNull( message = "product.time.notNull" )

cost
required
string
additionnalProductionCost
required
string
costSpecial
required
string
invQtyMin
required
string
invQtyMax
required
string
moq
required
string
packageOrder
required
string
inventoryTracking
required
boolean
rentTracking
required
boolean
countedInInventory
required
boolean
shippingTracking
required
boolean
notes
string or null
notesInvoice
string or null
notesBill
string or null
notesRent
string or null
notesProduction
string or null
notesInventory
string or null
notesShipping
string or null
Array of objects (product_product_options.jsonld-add_post)
Array of objects (product_productbuycosts.jsonld-add_post)
Array of objects (product_productsellprices.jsonld-add_post)
object (product_unit_types.jsonld-add_post)

UnitType.

unitNb
string
Default: 1
supplierCode
string or null
clientCode
string or null
shCode
string or null
parameter_periods.jsonld-add_post (object) or null
periodicityPrecision
required
string
bookable
required
boolean
Default: true
discountable
required
boolean
Default: true
salable
required
boolean
Default: true
object (invoice_line_types.jsonld-add_post)

LinesTypes.

purchasable
required
boolean
Default: true
object (bill_line_types.jsonld-add_post)

Bill Line Types.

onDistribution
required
boolean
Default: true
onWebsite
required
boolean
Default: true
isVariableExpense
required
boolean
Default: true
isImmo
required
boolean
isConsumable
required
boolean
Default: true
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>
apiTranslations
Array of strings

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "sectors": [
    ],
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": {
    },
  • "brand": {
    },
  • "supplier": {
    },
  • "weight": "string",
  • "dimensionW": "string",
  • "dimensionH": "string",
  • "dimensionD": "string",
  • "time": "string",
  • "cost": "string",
  • "additionnalProductionCost": "string",
  • "costSpecial": "string",
  • "invQtyMin": "string",
  • "invQtyMax": "string",
  • "moq": "string",
  • "packageOrder": "string",
  • "inventoryTracking": true,
  • "rentTracking": true,
  • "countedInInventory": true,
  • "shippingTracking": true,
  • "notes": "string",
  • "notesInvoice": "string",
  • "notesBill": "string",
  • "notesRent": "string",
  • "notesProduction": "string",
  • "notesInventory": "string",
  • "notesShipping": "string",
  • "productOptions": [
    ],
  • "productBuyCosts": [
    ],
  • "productSellPrices": [
    ],
  • "unitType": {
    },
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": {
    },
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": {
    },
  • "purchasable": true,
  • "billLineType": {
    },
  • "onDistribution": true,
  • "onWebsite": true,
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "apiTranslations": [
    ]
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "sku": "string",
  • "price": "string",
  • "place": "string",
  • "brand": {
    },
  • "supplier": {
    },
  • "cost": "string",
  • "supplierCode": "string",
  • "clientCode": "string",
  • "isConsumable": true,
  • "shortcode": "A",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "inStock": 0,
  • "translationDescriptionPropertyName": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}