Produkte

Verwalten Sie Produkte Ihrer Organisation inklusive zugehöriger SKUs, Shop-SKUs, Shop-Produkte und Apotheken-SKUs. Weitere Ressourcen: SKUs, Shop-SKUs, Shop-Produkte.

Produkte auflisten

GET /v1/management/products

integer

Standard:"0"

Seitennummer (0-indexiert)

integer

Standard:"50"

Anzahl der Produkte pro Seite

Erforderliche Berechtigung: product:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/products?page=0&limit=25" \
  -H "X-API-Key: your-api-key-here"

Antwort

{
  "products": [
    {
      "uid": "prod-abc123",
      "display_name": "Medication X",
      "skus": [
        {
          "uid": "sku-456",
          "display_name": "Medication X 100mg",
          "pzn": "12345678",
          "is_template": false,
          "shop_skus": [
            {
              "uid": "ssku-789",
              "shop_uid": "shop-001",
              "external_id": "shopify-variant-123"
            }
          ],
          "pharmacy_skus": [
            {
              "uid": "psku-012",
              "pharmacy_uid": "ph-xyz",
              "price": 1299,
              "stock": 50,
              "external_id": "EXT-001"
            }
          ]
        }
      ],
      "shop_products": [
        {
          "uid": "sp-345",
          "shop_uid": "shop-001",
          "external_id": "shopify-product-456"
        }
      ]
    }
  ],
  "totalRegistries": 42,
  "totalPages": 2
}

Antwortfelder

Feld	Typ	Beschreibung
`products`	array	Liste der Produktobjekte
`products[].uid`	string	Produkt-UID
`products[].display_name`	string	Anzeigename des Produkts
`products[].skus`	array	SKUs, die zu diesem Produkt gehören
`products[].skus[].pzn`	string	Pharmazentralnummer (deutsche Arzneimittelkennung)
`products[].skus[].is_template`	boolean	Ob diese SKU ein Platzhalter-Anker statt eines echten Artikels ist
`products[].skus[].pharmacy_skus`	array	Apothekenspezifische SKU-Daten (Preis, Bestand)
`totalRegistries`	integer	Gesamtanzahl der Produkte
`totalPages`	integer	Gesamtanzahl der Seiten für das angegebene Limit

Das Feld price bei Apotheken-SKUs ist in Euro-Cent angegeben (z.B. 1299 = 12,99 EUR).

Platzhalter-SKUs (is_template)Patientinnen und Patienten können ein Medikament bestellen, das nicht in Ihrem Katalog steht. Eine solche Bestellposition braucht dennoch eine SKU, auf die sie verweisen kann, und verweist deshalb auf einen Platzhalter: genau eine SKU pro Organisation, markiert mit is_template: true. Was die Position tatsächlich aussagt — Medikament, Menge, PZN — stammt aus dem vom Arzt signierten Rezept, nicht aus der Platzhalter-SKU.is_template ist kein Bestands-, Preis- oder Versandkennzeichen. Nahezu jede SKU hat is_template: false; wenn Sie verkäufliche Artikel auflisten, filtern Sie Platzhalter aus.

Produktdetails abrufen

GET /v1/management/products/{product_uid}

string

erforderlich

Die Produkt-UID

Erforderliche Berechtigung: product:read

Beispielanfrage

curl -X GET "https://api.rxscale.com/v1/management/products/prod-abc123" \
  -H "X-API-Key: your-api-key-here"

Antwort

Gibt die gleiche Produktstruktur wie der Listen-Endpoint zurück, jedoch für ein einzelnes Produkt inklusive aller verbundenen SKUs, Shop-SKUs, Shop-Produkte und Apotheken-SKUs.

{
  "uid": "prod-abc123",
  "display_name": "Medikament X",
  "skus": [...],
  "shop_products": [...]
}

Produkt anlegen

POST /v1/management/products

Erforderliche Berechtigung: product:write

Feld	Typ	Pflicht	Beschreibung
`display_name`	string	ja	Anzeigename
`short_name`	string	ja	Kurzname
`prescription_required`	boolean	ja	Ob ein Rezept erforderlich ist
`handle`	string	nein	Produkthandle
`image_url`	string	nein	Bild-URL
`skus`	array	nein	SKUs, die zusammen mit dem Produkt angelegt werden

Beispielanfrage

curl -X POST "https://api.rxscale.com/v1/management/products" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "display_name": "Medikament X",
    "short_name": "med-x",
    "prescription_required": true,
    "handle": "medication-x",
    "skus": [
      {
        "display_name": "Medikament X 100mg",
        "pzn": "12345678",
        "digital": false
      }
    ]
  }'

Die Antwort ist das angelegte Produkt in der gleichen Struktur wie der Detail-Endpoint (HTTP 201).

Produkt aktualisieren

PATCH /v1/management/products/{product_uid}

string

erforderlich

Die Produkt-UID

Erforderliche Berechtigung: product:write Aktualisierbare Felder: display_name, short_name, prescription_required, handle, image_url.

Beispielanfrage

curl -X PATCH "https://api.rxscale.com/v1/management/products/prod-abc123" \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{"display_name": "Medikament X Forte"}'

Produkt löschen

DELETE /v1/management/products/{product_uid}

string

erforderlich

Die Produkt-UID

Erforderliche Berechtigung: product:write Gibt HTTP 204 ohne Body zurück. Das Produkt wird weich gelöscht.

Erste Schritte

Externe Apotheken-API

Management-API

Scheduling API

Öffentliche API

Patienten-API

Anamnese-API

Webhooks

Anleitungen

Produkte

Produkte

Produkte auflisten

Beispielanfrage

Antwort

Antwortfelder

Produktdetails abrufen

Beispielanfrage

Antwort

Produkt anlegen

Beispielanfrage

Produkt aktualisieren

Beispielanfrage

Produkt löschen

​Produkte

​Produkte auflisten

​Beispielanfrage

​Antwort

​Antwortfelder

​Produktdetails abrufen

​Beispielanfrage

​Antwort

​Produkt anlegen

​Beispielanfrage

​Produkt aktualisieren

​Beispielanfrage

​Produkt löschen

Produkte

Produkte auflisten

Beispielanfrage

Antwort

Antwortfelder

Produktdetails abrufen

Beispielanfrage

Antwort

Produkt anlegen

Beispielanfrage

Produkt aktualisieren

Beispielanfrage

Produkt löschen