List products

GET/products

The catalogue that applies to your account, by name. Archived products are left out unless you ask for them.

Request

curl 'https://api.measuremaponline.com/api/v1/products' \
  -H "Authorization: $MMO_API_KEY"

Response

[
  {
    "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
        }
      ]
    }
  }
]

Query parameters

includeArchivedboolean
true to include archived products.
Defaultfalse

Responses

A list ofProduct:
- 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

Errors

A failed request answers with one of these, in an Error body.

403insufficient_scopeThe key does not have the access this endpoint needs. Create a key with that access.

403invalid_api_keyNo key was sent in the Authorization header, or the key is unknown, revoked, or past the time it kept working after being replaced.

403subscription_expiredYour subscription is not active. Update your payment method in the app.

Try it

API key

This key is

The key stays in this tab and goes only to the API. Use a sandbox key while you try things: requests are real, and what they change is changed.

includeArchived

GET https://api.measuremaponline.com/api/v1/products

Fill in your API key to send.

As a cURL command

Shell

curl 'https://api.measuremaponline.com/api/v1/products' \
  -H "Authorization: $MMO_API_KEY"