Product

Fields

typestringrequired
Always"product"
idstringrequired
namestringrequired
descriptionstring
ownerUidstringrequired
Whose catalogue it belongs to, the organisation owner's or yours.
createdOninteger(int64)
enabledbooleanrequired
Offered in the pickers.
archivedbooleanrequired
categorystring
colorstring
iconstring
thumbnailUrlstring(uri)
textureUrlstring(uri)
A picture that fills shapes priced with it on the map.
textureTileMetersnumber
Ground covered by one tile of the texture, in metres.
taxRatenumber
A percentage. Absent means the project's rate applies; 0 means untaxed.
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

Example

{
  "type": "product",
  "id": "prd_Lw7Qm2Xc",
  "name": "Artificial turf",
  "description": "40 mm pile, laid on a compacted base",
  "ownerUid": "m3K8qZxLpV4NrT2w",
  "createdOn": 1790000000000,
  "enabled": true,
  "archived": false,
  "category": "Surfaces",
  "color": "#22c55e",
  "icon": "",
  "taxRate": 20,
  "pricing": {
    "unit": "m²",
    "currency": "gbp",
    "type": "range",
    "price": 32,
    "prices": [
      {
        "min": 0,
        "max": 100,
        "price": 32
      },
      {
        "min": 100,
        "max": -1,
        "price": 28
      }
    ]
  }
}

Used by