Versions Compared

Old Version 1

changes.mady.by.user Dirk Stuwe

Saved on

compared with

New Version 2

changes.mady.by.user Dirk Stuwe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Beschreibung

Dieser Request ruft die Produktbewertungen eines bestimmten Produktes auf Basis der übergebenen URL-Parameter zurück.

Method:
Status
colourGreen
titleGET

Request-URL: /product-reviews/v2/reviews

Request-Headers:

Name

Value (Beschreibung)

token

Bearer <JSON-Web-Token (AUTH)>

user-agent

App.<identifier>.<shopid>

Info

In der aktuellen Version nimmt die API ausschließlich HTTP/1.1 Requests an. Andere Requests werden nicht ausgeführt.

Zusätzliche URL-Parameter:

Zusätzliche Request-Parameter

gtin (empfohlen)

Die GTIN des Produktes. Optional, wenn productUrl oder SKU gegeben.

Beispiel:?gtin=07350053850026

productUrl

Die URL-kodierte Produkt-URL des Produktes. Optional, wenn SKU oder GTIN gegeben.
Beispiel:?productUrl=http%3A%2F%2Fwww.shop.de%2Fproduct_page.html

sku

Die SKU des Produktes. Optional, wenn productUrl oder GTIN gegeben.

Beispiel: ?sku=SKU-00001

sd
(true | false)

Gibt an, ob strukturierte Daten zurückgegeben werden sollen. Wird der Parameter nicht angegeben, werden standardmäßig strukturierte Daten ausgegeben. Mit dem Wert “false” kann die Rückgabe strukturierter Daten unterdrückt werden Optional; (Default: true).

Beispiel: ?sd=false

lang

Filtert die Bewertungen nach Sprache. Wird der Parameter nicht angegeben, werden alle Bewertungen in allen Sprachen ausgegeben. Optional

Beispiel: ?lang=de

days
(max. 365)

Gibt alle Produktbewertungen (unabhängig vom Produkt) des Händlers innerhalb der angegebenen Anzahl von Tagen zurück. Die Response enthält zusätzlich die Felder gtin und sku zur Identifikation des Produktes im Shop. Optional

Beispiel: ?days=14

Info

Hinweis: Obwohl gtin, productUrl und sku als optionale Parameter aufgeführt sind, muss mindestens einer von ihnen angegeben werden.

Zusätzliche Informationen

Macrosuite hidden content macro
data{"usersAndGroups":[{"value":"5ffe9d923b5e4701383744de","label":{"key":null,"ref":null,"props":{"user":{"type":"known","accountId":"5ffe9d923b5e4701383744de","accountType":"atlassian","email":"","publicName":"Dirk Stuwe","profilePicture":{"path":"/wiki/aa-avatar/5ffe9d923b5e4701383744de","width":48,"height":48,"isDefault":false},"displayName":"Dirk Stuwe","isExternalCollaborator":false,"_expandable":{"operations":"","personalSpace":""},"_links":{"self":"https://shopvote.atlassian.net/wiki/rest/api/user?accountId=5ffe9d923b5e4701383744de","base":"https://shopvote.atlassian.net/wiki","context":"/wiki"}}},"_owner":null},"type":"user"}]}
showSelectedtrue
editorValue{"editorValue":{"version":1,"type":"doc","content":[{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"Interner Funktionsaufruf"}]},{"type":"codeBlock","attrs":{},"content":[{"type":"text","text":"// App.php\npublic function getProductReviewsV2()"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"Caching aktiviert?"}]},{"type":"paragraph","content":[{"type":"text","text":"JA"}]},{"type":"paragraph","content":[]}]}}

Beispiel

Status
colourGreen
titleGET
https://api.shopvote.de/product-reviews/v2/reviews

Response (JSON mit strukturierten Daten als JSON+LD Code Snippet)

Info

Die strukturierten Daten werden in der Property “ratingstars” übergeben. Wird der URL-Parameter ?sd=false gesetzt, wird enthält die Response diese Property nicht.

Code Block
languagejson
{
   "productname":"Obstsaft",
   "shopid":"6831",
   "reviewpage": "https://www.shopvote.de/show-products.php?shopid=6831",
   "ratingstars":"<script type="application/ld+json">{
			"@context": "http://schema.org",
			"@type": "Product",
			"aggregateRating": {
				"@type": "AggregateRating",
				"ratingValue": "4.5",
				"reviewCount": "2"
			  },
			  "name": "Obstsaft",
			  "image": "http://www.bueroshop24obstshop24.de/ugsshoppictures/img/7/0/Zoom_m1439581.jpg/l/",
			  "review": [{
				  "@type": "Review",
				  "author": "TestUsername",
				  "datePublished": "2018-10-04",
				  "reviewBody": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr",
				  "reviewRating": {	
                      "@type": "Rating",
                      "bestRating": "5",
                      "ratingValue": "4", 
                      "worstRating": "1" 
                    }}, {
					"@type": "Review",
					"author": "TestUsername",
					"datePublished": "2018-10-01",
					"reviewBody": "II - Lorem ipsum dolor sit amet, consetetur sadipscing",
	  				"reviewRating": { 
						"@type": "Rating",
						"bestRating": "5",
						"ratingValue": "5",
						"worstRating": "1" 
					}
				}]
   }</script>",
  "rating_count": "2",
  "rating_value": "4.5",
  "reviews": [{
          "reviewUID":"7C88E04C8CW78BEE9F224F8311B6FFG3"
			"created": "2018-10-04",
          "author": "TestUser",
          "rating_value": "4",
          "text": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr"
      },
      {
        	"reviewUID":"F76C99DADAEDFE0ZBCP3E95YE6R0Q2DC",
			"created": "2018-10-01",
        	"author": "TestUser",
        	"rating_value": "5",
        	"text": "II - Lorem ipsum dolor sit amet, consetetur sadipscing"
    }]
}