API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

products

Creates a products resource.

Creates a products resource.

Authorizations:
JWT
path Parameters
id
required
string

products identifier

Request Body schema:
required

The new products resource

title
any
name
string
description
string
timestamp
required
string <date-time>
inventoryEntries
Array of strings <iri-reference> [ items <iri-reference > ]
invoiceLines
Array of strings <iri-reference> [ items <iri-reference > ]
billLines
Array of strings <iri-reference> [ items <iri-reference > ]
taxCustoms
Array of strings <iri-reference> [ items <iri-reference > ]
productComponents
Array of strings <iri-reference> [ items <iri-reference > ]
sectors
Array of strings <iri-reference> [ items <iri-reference > ]
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
type
required
string <iri-reference>
brand
string or null <iri-reference>
supplier
string or null <iri-reference>
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
object
productOptions
Array of strings <iri-reference> [ items <iri-reference > ]
productBuyCosts
Array of strings <iri-reference> [ items <iri-reference > ]
productSellPrices
Array of strings <iri-reference> [ items <iri-reference > ]
rents
Array of strings <iri-reference> [ items <iri-reference > ]
rentsCharged
Array of strings <iri-reference> [ items <iri-reference > ]
unitType
string <iri-reference>
unitNb
string
Default: 1
supplierCode
string or null
clientCode
string or null
shCode
string or null
reservationPeriodicity
string or null <iri-reference>
periodicityPrecision
required
string
bookable
required
boolean
Default: true
discountable
required
boolean
Default: true
salable
required
boolean
Default: true
invoiceLineType
string <iri-reference>
purchasable
required
boolean
Default: true
billLineType
string <iri-reference>
onDistribution
required
boolean
Default: true
onWebsite
required
boolean
Default: true
owningCorporation
string <iri-reference>
isVariableExpense
required
boolean
Default: true
isImmo
required
boolean
isConsumable
required
boolean
Default: true
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customProperties
any

Can contain anything (array, objects, nested objects...).

customData
Array of strings or null
createdAt
string <date-time>
updatedAt
string <date-time>
disabledAt
string or null <date-time>
object (Collection.jsonld)
upload_filename
string
upload_subfolder
string
upload_file
string
upload_file_link
string
apiTranslations
Array of strings
descriptionInternal
any
currentLocale
string or null

currentLocale is a non persisted field configured during postLoad event

defaultLocale
string
Default: "en"
currentTitle
string or null
currentDescription
string or null
upload_Subfolder
string
upload_File
string
upload_File_Link
string

Responses

Request samples

Content type
{
  • "title": null,
  • "name": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "inventoryEntries": [],
  • "invoiceLines": [],
  • "billLines": [],
  • "taxCustoms": [],
  • "productComponents": [],
  • "sectors": [],
  • "sku": "string",
  • "version": "string",
  • "price": "string",
  • "priceSpecial": "string",
  • "visibleStatus": true,
  • "taxable": true,
  • "country": "string",
  • "place": "string",
  • "placePrecision": "string",
  • "producible": true,
  • "newStatus": true,
  • "type": "https://example.com/",
  • "brand": "https://example.com/",
  • "supplier": "https://example.com/",
  • "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",
  • "translations": {
    },
  • "productOptions": [],
  • "productBuyCosts": [],
  • "productSellPrices": [],
  • "rents": [],
  • "rentsCharged": [],
  • "unitType": "https://example.com/",
  • "unitNb": 1,
  • "supplierCode": "string",
  • "clientCode": "string",
  • "shCode": "string",
  • "reservationPeriodicity": "https://example.com/",
  • "periodicityPrecision": "string",
  • "bookable": true,
  • "discountable": true,
  • "salable": true,
  • "invoiceLineType": "https://example.com/",
  • "purchasable": true,
  • "billLineType": "https://example.com/",
  • "onDistribution": true,
  • "onWebsite": true,
  • "owningCorporation": "https://example.com/",
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "entityFiles": { },
  • "upload_filename": "string",
  • "upload_subfolder": "string",
  • "upload_file": "string",
  • "upload_file_link": "string",
  • "apiTranslations": [
    ],
  • "descriptionInternal": null,
  • "currentLocale": "string",
  • "defaultLocale": "en",
  • "currentTitle": "string",
  • "currentDescription": "string",
  • "upload_Subfolder": "string",
  • "upload_File": "string",
  • "upload_File_Link": "string"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "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",
  • "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,
  • "owningCorporation": {
    },
  • "isVariableExpense": true,
  • "isImmo": true,
  • "isConsumable": true,
  • "shortcode": "A",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "billLinesListing": "string",
  • "customPropertiesListing": "string",
  • "invoiceLinesListing": "string",
  • "rentsListing": "string",
  • "rentsChargedListing": "string",
  • "inventoryEntriesListing": "string",
  • "applicableCost": 0,
  • "translationTitlePropertyName": "string",
  • "applicablePrice": 0,
  • "inStock": 0,
  • "productStockProgressBar": 0,
  • "productStockRatio": 0,
  • "productStockPercentage": 0,
  • "correction": 0,
  • "lastInventoryEntry": "2019-08-24T14:15:22Z",
  • "productOptionsListing": "string",
  • "subProductOptionsListing": "string",
  • "productComponentsListing": "string",
  • "componentProductsListing": "string",
  • "translationsListing": "string",
  • "buyableBasePrice": 0,
  • "discount": 0,
  • "maxProductionCapacity": 0,
  • "applicableSupplierCode": "string",
  • "applicableClientCode": "string",
  • "consumable": true,
  • "translationDescriptionPropertyName": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}