ProductInput

A product's fields. name is needed to create one.

Fields

namestring
descriptionstring
categorystring
colorstring
iconstring
thumbnailUrlstring(uri)
textureUrlstring(uri)
textureTileMetersnumber
0.01 to 20
enabledboolean
Defaulttrue
archivedboolean
taxRatenumber
0 to 100
costPricenumber
What the product costs you, for your own margin in the app. Stored, never returned.
≥ 0
pricingobject
How a product is charged, by area, by length or per spot. A new price needs its unit and currency; on an update, a price sent without them keeps the product's own.
distancePricingobject
How a product is charged, by area, by length or per spot. A new price needs its unit and currency; on an update, a price sent without them keeps the product's own.
itemPricingobject
How a product is charged, by area, by length or per spot. A new price needs its unit and currency; on an update, a price sent without them keeps the product's own.
seasonsarray of Season
at most 24 items

Example

{
  "name": "Artificial turf",
  "description": "40 mm pile, laid on a compacted base",
  "category": "Surfaces",
  "color": "#22c55e",
  "taxRate": 20,
  "pricing": {
    "unit": "m²",
    "currency": "gbp",
    "type": "range",
    "prices": [
      {
        "min": 0,
        "max": 100,
        "price": 32
      },
      {
        "min": 100,
        "price": 28
      }
    ]
  }
}

Used by