Stores¶

Mit dieser Api werden die Stores (Branchenbuch) ausgegeben.

Felder¶

Feld	Typ	Beschreibung	Beispiel
stid	integer	Store ID	5
name	string	Name der Firma	Filiale in Mannheim
legalform	string
contact1	string	Kontakt	Fr. Musterfaru
contact2	string
address1	string	Adresse 1	Musterweg 30b
address2	string	Adresse 2
zipcode	string	Postleitzahl	36581
city	string	Stadt	Mannheim
country	string	Land	de
fon	string	Telefon	+49 (0) 123456/ 123456,
mobile	string	Mobil
fax	string	Fax
mail	string	E-Mail	filiale@example.de
www	string	Homepage	www.filiale-example.de
description1	string	Beschreibung 1	Die Filiale in Mannheim beschäftigt 24 Mitarbeiter.,
description2	string	Beschreibung 2
products	string
conditionsRefund	string
conditionsText	string
conditionsPayment	string
conditionsOrderVia	string
tags	string
custom1	string
custom2	string
custom3	string
custom4	string
custom5	string
responsibleCountry	string
responsibleZIP	string
creation	date		2018-04-11T09:56:52
erpID	string
erpName	string
erpNumber	string
erpLastUpdate	date		1970-01-01T00:59:59
erpCreation	date		1970-01-01T00:59:59
archived	integer		0

Facetten¶

Über die Facetten können weitere Daten dazu geladen werden. Diese werden Komma getrennt übergeben
Zum Beispiel :
/api/commerce/store/[STID]?facet=property
/api/commerce/store/search?q=stid%3D11&facet=property

Facette	Beschreibung
property	Eigenschaften

Ein Store auslesen¶

Die URL /api/commerce/store/[STID] liefert ein Store (Branchenbuch) zurück

{
    "dataset": {
        "39887013-301b-4f06-a3ca-096b109c9e86": {
           "stid": 5,
            "name": "Filiale in Mannheim",
            "legalform": "",
            "contact1": "Fr. Musterfrau",
            "contact2": "",
            "address1": "Musterweg 30b",
            "address2": "",
            "zipcode": "36581",
            "city": "Mannheim ",
            "country": "de",
            "fon": "+49 (0) 1234 / 1234",
            "mobile": "",
            "fax": "",
            "mail": "[email protected]",
            "www": "www.filiale-example.de",
            "description1": "Die Filiale in Mannheim beschäftigt 24 Mitarbeiter.",
            "description2": "",
            "products": "",
            "conditionsRefund": "",
            "conditionsText": "",
            "conditionsPayment": "",
            "conditionsOrderVia": "",
            "tags": "",
            "custom1": "",
            "custom2": "",
            "custom3": "",
            "custom4": "",
            "custom5": "",
            "responsibleCountry": null,
            "responsibleZIP": null,
            "creation": "2018-04-11T09:56:52",
            "erpID": "",
            "erpName": "",
            "erpNumber": "",
            "erpLastUpdate": "1970-01-01T00:59:59",
            "erpCreation": "1970-01-01T00:59:59",
            "archived": "0"
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 20,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Stores auslesen¶

Die URL /api/commerce/store?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG] liefert alle Stores zurück. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/commerce/store?page=0&count=5

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Store suchen¶

Über die URL /api/commerce/store/search?q=[QUERY] können Stores gesucht werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/commerce/store/search?q=stid%3D1

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Eigenschaften¶

Über die URL /api/commerce/store/[STID]/property können die Eigenschaften abgerufen werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

Feldinformationen siehe Eigenschaften

Eigenschaften suchen¶

Über die URL /api/commerce/store/property/search kann nach Eigenschaften gesucht werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

Store Bilder¶

Über die URL /api/commerce/store/[STID]/files können die Bilder abgerufen werden. Mit dem Pagestepper kann durch die Daten navigiert werden.

property	title	default	type	examples
name	Bild Name		string	image1.jpg
url	URL zu dem Bild		string	/image/alvine/upload/media/public/yellowpages/1/image1.jpg
bytes	Datei Größe in Bytes	0	integer	1998
sha1	Secure Hash Algorithm 1		string	58dd38d7eb36d51c1bf0c73078ebb1b14efeb11f
lastAccessTime	letztes Zugriffsdatum		string	2018-06-28T12:10:54
lastModifiedTime	Änderungsdatum		string	2018-06-28T12:10:54

{
    "dataset": {
        "e5d67599bbb698e0cb7ec7a0713419e2": {
            "name": "image1.jpg",
            "url": "/image/alvine/upload/media/public/yellowpages/1/image1.jpg",
            "bytes": 1998,
            "sha1": "58dd38d7eb36d51c1bf0c73078ebb1b14efeb11f",
            "lastAccessTime": "2018-06-28T12:10:54",
            "lastModifiedTime": "2018-06-28T12:10:54"
        },
        "a432a4e7015b3706f3600cf4efb1ec40": {
            "name": "image2.gif",
            "url": "/image/alvine/upload/media/public/yellowpages/1/image2.gif",
            "bytes": 1568,
            "sha1": "6a980933f4167ec2323d0243f1088988c2f79e40",
            "lastAccessTime": "2018-06-28T12:10:54",
            "lastModifiedTime": "2018-06-28T12:10:54"
        },
        "1bb87d41d15fe27b500a4bfcde01bb0e": {
            "name": "logo.png",
            "url": "/image/alvine/upload/media/public/yellowpages/1/logo.png",
            "bytes": 9617,
            "sha1": "ed073c06c28b252888abac90d87302f3f960b506",
            "lastAccessTime": "2018-06-28T12:56:59",
            "lastModifiedTime": "2018-06-28T12:56:59"
        }
    },
    "sys": {
        "pagination": {
            "total": 3
        },
        "message": "200 OK",
        "code": 200
    }
}