MEDIIO API-Initiative
Initiative beitreten

Anwendungsfall · Abfrage Produktbilder

Produktbilder direkt beim Lieferanten abrufen

Zu einer oder mehreren Lieferantenartikelnummern oder einer PZN alle verfügbaren Bilder abrufen – für die sichere visuelle Identifikation des Produktes.

POST /api/ProductImage/query
Initiative beitreten Zurück zu den Anwendungsfällen
api.host · REST
POST /api/ProductImage/query 
[
  {
    "articleNumber": "4711",
    "images": [
      { "url": "…/4711_1000.webp", "mimeType": "webp", "isPrimary": true }
    ]
  }
]

User Story

„Ich möchte als Anwender zu einer oder mehreren Lieferantenartikelnummern oder einer PZN das Bild oder die verfügbaren Bilder abrufen, damit ich eine visuelle Unterstützung bei der Identifikation des Produktes habe."

Rahmen

Wie Produktbilder geliefert werden

Angefragt werden ein oder mehrere Artikel per Lieferantenartikelnummer oder PZN. Zurückgegeben werden 0, 1 oder mehrere Bilder je Artikel – abgeleitet aus den Akzeptanzkriterien.

Batch-Abfrage

Ein oder mehrere Artikel je Anfrage – identifiziert über Artikelnummer oder PZN.

Bild als URL

Rückgabe als Bild-URL (z. B. vom CDN) – kein Binär-Upload über diesen Endpunkt.

Format & Größe

webp als Standard, jpg als Fallback · max. 200 KB · Auflösung 800–1200 px.

Haupt- & Reihenfolge

isPrimary kennzeichnet das Hauptbild (position 0), weitere Bilder über position.

Bewusst abgegrenzt

  • Bilder werden als URL referenziert – der Bildabruf selbst erfolgt gegen das CDN des Lieferanten.
  • Weitere Medien (Dokumente/Datenblätter) werden über einen eigenen Endpunkt behandelt.

Anfrage

Request-Body

POST mit einem JSON-Array – je Eintrag eine Lieferantenartikelnummer oder eine PZN (Batch: 1..n).

Feld Typ Bedeutung
articleNumber string Lieferantenartikelnummer.
pzn string PZN – alternativ zu articleNumber.

Je Eintrag genügt eines der beiden Felder. Mehrere Einträge = mehrere Artikel gleichzeitig.

Beispiele

Typische Abfragen

Als Konsument möchte ich … – und sende dafür folgenden Request:

zu einer Lieferantenartikelnummer alle verfügbaren Bilder abrufen

POST
https://host_url/api/ProductImage/query
Body 
[
  { "articleNumber": "4711" }
]

zu einer PZN alle verfügbaren Bilder abrufen

POST
https://host_url/api/ProductImage/query
Body 
[
  { "pzn": "4711" }
]

zu mehreren Artikelnummern gleichzeitig Bilder abrufen

POST
https://host_url/api/ProductImage/query
Body 
[
  { "articleNumber": "4711" },
  { "articleNumber": "0815" },
  { "articleNumber": "42" }
]

Antwort

Response (JSON)

Ein Array je angefragtem Artikel. images enthält 0..n Bilder mit URL, Format, Maßen sowie optional Text, Hauptbild-Kennzeichnung und Position.

Response · application/json 
[
  {
    "articleNumber": "string",
    "pzn": "string",
    "images": [
      {
        "url": "string",
        "mimeType": "string",
        "width": 0,
        "height": 0,
        "desc": "string",
        "isPrimary": true,
        "position": 0
      }
    ]
  }
]
200 Erfolg mit Ergebnis – ein oder mehrere Bilder.
204 Erfolg ohne Ergebnis – kein Bild vorhanden.

Wichtige Felder

articleNumber / pzn

Identifikation des Artikels (eines der beiden gesetzt).

images[]

0..n Bilder – leer bedeutet: kein Bild (HTTP 204).

url

Bild-URL, z. B. „…/123_400.webp" (Pflicht).

mimeType

Bildformat: „webp" oder „jpeg"/„jpg" (Pflicht).

width / height

Breite und Höhe in Pixeln (Pflicht).

desc

Text zum Bild (optional).

isPrimary

Kennzeichnung als Hauptbild (optional).

position

Reihenfolge; 0 = Hauptbild, sonst numerisch (optional).

Selbsttest

Antwort prüfen

Fügen Sie die JSON-Antwort Ihres /api/ProductImage/query-Endpunkts ein – die Struktur wird sofort im Browser gegen dieses Schema geprüft.

Noch keine Prüfung – JSON einfügen und „Prüfen" klicken.

Diesen Anwendungsfall in Ihrem System nutzen?

Werden Sie Teil der API-Initiative – wir begleiten Sie beim Onboarding.

Initiative beitreten Zurück zu den Anwendungsfällen