Wiresphere REST-API

Header-Parameter

Request Body (application/json)

{
  "username": "dein-benutzername",
  "password": "dein-passwort"
}

Antwort

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Header

Query-Parameter

Antwort (200)

{
  "totalElements": 42,
  "totalPages": 5,
  "size": 10,
  "number": 0,
  "first": true,
  "last": false,
  "content": [
    {
      "base": { /* Produkt-Basisdaten */ },
      "additional": { /* Zusatzdaten */ }
    }
  ]
}

Pfad-Parameter

Antwort (200) — ProductDataDTO

{
  "base": { /* Basis-Produktdaten (Name, SKU, Preis usw.) */ },
  "additional": { /* Erweiterte Felder */ }
}

Request Body (application/json) — ProductDataDTO

{
  "base": {
    // Pflichtfelder und Produktdaten (Name, SKU, Preis, Status etc.)
  },
  "additional": {
    // Optionale Zusatzfelder
  }
}

Antwort

Request Body (application/json)

["produktId1", "produktId2"]

Antwort

Gibt alle registrierten Bulk-Operationen mit ihren Parameter-Schemas zurück.

Antwort (200) — Array von ProductOperationRegistrationDTO

[{
  "operationId": "set-status",
  "description": "Setzt den Status von Produkten",
  "parameterTypes": { "status": "string" },
  "previewProperties": ["status"]
}]

Simuliert eine Bulk-Operation und zeigt Vorher/Nachher-Zustand — ohne Daten zu speichern.

Request Body

{
  "operationId": "set-status",
  "parameters": { "status": "ACTIVE" },
  "confirmAll": false
}

Führt eine Bulk-Operation auf gefilterten Produkten aus. Ändert Daten dauerhaft.

Query-Parameter

Request Body

{
  "operationId": "set-status",
  "parameters": { "status": "INACTIVE" }
}

Filter-Felder (Parameter f)

Sortierfelder (Parameter o)

createdAt, docId, payload.netTotalPrice, payload.grossTotalPrice, payload.customer.name

Beispiel

GET /api/v1/admin/transaction/?f=doctype::ORDER,min_createdAt::2024-01-01T00:00:00.000Z&o=createdAt::DESC&p=0&s=20
Authorization: Bearer <token>
tenant-id: mein-shop

Pfad-Parameter

Query-Parameter

Antwort (200)

{
  "doctype": ["ORDER", "INVOICE"],
  "payload.channel": ["online", "terminal"]
}

Pfad-Parameter

Query-Parameter

Pfad-Parameter

Query-Parameter

Identische Filter- und Sortieroptionen wie der Admin-Endpunkt, jedoch ohne Bearer-Authentifizierung. Filtert auf den im Shop-Kontext zugänglichen Daten.

Filter-Felder (Parameter f)

personId, firstName, lastName, email

Antwort (200) — PageCrmPersonDTO

{
  "totalElements": 100,
  "content": [{
    "id": "507f1f77bcf86cd799439011",
    "firstName": "Max",
    "lastName": "Mustermann",
    "email": "max@example.com",
    "personId": "extern-123",
    "addresses": [],
    "communications": [],
    "organisations": [],
    "types": []
  }]
}

Pfad-Parameter

Request Body (application/json) — PersonDTO

{
  "firstName": "Max",
  "lastName": "Mustermann",
  "email": "max@example.com",
  "salutation": "Herr",
  "title": "Dr.",
  "personId": "externe-id-123",
  "addresses": [{
    "street": "Musterstraße",
    "streetNumber": "1",
    "zipCode": "12345",
    "city": "Musterstadt",
    "country": "DE",
    "type": "MAIN"
  }],
  "communications": [{
    "type": "PHONE",
    "value": "+49 123 4567890"
  }],
  "types": []
}

Gleicher Request Body wie POST. Vollständige Ersetzung des Datensatzes.

Request Body — RelationDeltaDTO

{
  "add": ["orgId1", "orgId2"],
  "remove": ["orgIdAlt"]
}

Antwort (200) — OkDTO

{ "ok": true }

Request Body

["id1", "id2", "id3"]

Filter-Felder

name (Substring-Suche)

Antwort (200) — PageCrmOrganisationDTO

{
  "totalElements": 10,
  "content": [{
    "id": "...",
    "name": "Muster GmbH",
    "organisationId": "externe-id",
    "addresses": [],
    "communications": [],
    "people": [],
    "types": []
  }]
}

Request Body — OrganisationDTO

{
  "name": "Muster GmbH",
  "organisationId": "externe-id",
  "addresses": [],
  "communications": [],
  "types": []
}

Request Body — RelationDeltaDTO

{
  "add": ["personId1"],
  "remove": []
}

Antwort — PageSlug

{
  "content": [{
    "id": "507f...",
    "slug": "beton-c25-30",
    "label": "Beton C25/30",
    "objectType": "product",
    "collection": "products",
    "refId": "produktMongoId",
    "inactive": false
  }]
}

Request Body — Slug

{
  "id": "507f...",           // Bei Update angeben
  "slug": "mein-slug",       // URL-Segment (Pflicht)
  "collection": "products",  // MongoDB-Collection (Pflicht)
  "objectType": "product",   // "product" oder "product-list" (Pflicht)
  "refId": "...",            // Produkt-ID (bei objectType "product")
  "fields": {                  // Filter für "product-list"
    "category": "beton"
  },
  "defaultSort": [{ "field": "name", "direction": "asc" }],
  "context": ["main-nav"],
  "inactive": false
}

Nützlich, um den Slug zu einem bekannten Produkt zu finden.

Pfad-Parameter

Query-Parameter

Query-Parameter

Antwort (200)

["main-nav", "footer", "sidebar"]

Request Body — Array von ItemOrderDTO

[
  { "sku": "SKU-001", "categoryId": "catId", "order": 0 },
  { "sku": "SKU-002", "categoryId": "catId", "order": 1 }
]

Request Body — NavigationUpdateDTO

{
  "slugId": "slugMongoId",
  "navigationNames": ["main-nav", "footer"]
}

Pfad-Parameter

Request Body — Setting

{
  "key": "einstellungs-key",
  "public": {
    // Öffentlich zugängliche Einstellungen
    "theme": "dark"
  },
  "private": {
    // Nur für authentifizierte Anfragen zugänglich
    "apiKey": "secret"
  }
}

Query-Parameter

Request als multipart/form-data mit dem Feld file.

Content-Type: multipart/form-data

file: [binary data]

Antwort (200)

{ "publishableKey": "pk_live_..." }

Gibt den aktuellen Zahlungsstatus des Shops zurück.

Header

Antwort (200) — WebhookTestStatusDTO

{
  "sandbox": {
    "mode": "SANDBOX",
    "passed": true,
    "ranAt": "2024-01-15T10:30:00Z",
    "durationMs": 234,
    "pending": false
  },
  "production": { /* analog */ }
}

Pfad-Parameter

Request Body (multipart)

Content-Type: application/json
file: [binary — CSV oder JSON Datei]

Antwort (200) — UploadResponse

{
  "success": true,
  "importCount": 42
}

Pfad-Parameter

Antwort

Binär-Datei (string format: binary)