Get Products

GET https://api.e-guma.ch/v1/products?apikey={api-key}

Parameters

Parameter	Description
api-key	`required`

Response

Product

Parameter	Description
id	ID of the product.
name	Name of the product in all available languages.
description_html	Description in HTML format in all available languages.
published	If this value is false, it cannot be sold.
image_url	Image URL of the product. Here is how to display this image correctly on a web page. The image is optimized for a 6:5 ratio and has a resolution of at least 600 x 500px.
url	Link to the product in the product shop in all available languages.
type	See the different types here.
price_in_cents	The price of the product. Only applies if the type is simple.
variants	List of the different variants. Only available if the type is variable.
updated_at	Timestamp of the last update.

Type


simple	Indicates that this is a product with a single variant. price_in_cents shows the price. variants is empty.
variable	Indicates that this is a product with several variants. The variants are available in the field variants.

Variant


id	The ID of the variant.
name	The name of the variant in all available languages.
price_in_cents	The price of the variant.

Example

GET https://api.e-guma.ch/v1/products?&apikey=5bb668e394f2811f3ca4a9db

[
  {
    "id": "05e200c1-0a61-4f1b-8387-6f4150c85e4c",
    "name": {
      "de": "Kugelschreiber Zürich",
      "en": "Ballpen Zurich"
    },
    "description_html": {
      "de": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "en": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
    },
    "published": true,
    "image_url": "https://images.e-guma.ch/4214/thumbs/95eb6cb0eae045d59bb486578f1bc98d.jpg",
    "url": {
      "de": "https://shop.e-guma.ch/beethoven/de/produkte/kugelschreiber-zuerich-5017886",
      "en": "https://shop.e-guma.ch/beethoven/en/products/ballpen-zurich-5017886"
    },
    "type": "simple",
    "price_in_cents": 1000,
    "variants": null,
    "updated_at": "2024-08-01T14:37:28"
  },
  {
    "id": "25a6e7da-8efa-4565-8d32-22917fb65568",
    "name": {
      "de": "Kugelschreiber Schweiz",
      "en": "Ballpen Switzerland"
    },
    "description_html": {
      "de": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.",
      "en": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua."
    },
    "published": true,
    "image_url": "https://images.e-guma.ch/4214/thumbs/95eb6cb0eae045d59bb486578f1bc98d.jpg",
    "url": {
      "de": "https://shop.e-guma.ch/beethoven/de/produkte/kugelschreiber-schweiz-5017886",
      "en": "https://shop.e-guma.ch/beethoven/en/products/ballpen-switzerland-5017886"
    },
    "type": "variable",
    "price_in_cents": 0,
    "variants": [
      {
        "id": "66f28a67c38c31a3aa8764bf",
        "name": {
          "de": "Rot",
          "en": "Red"
        },
        "price_in_cents": 12000
      },
      {
        "id": "66f28a77c38c31a3aa8764c0",
        "name": {
          "de": "Weiss",
          "en": "White"
        },
        "price_in_cents": 12000
      }
    ],
    "updated_at": "2024-08-29T06:13:05"
  }
]