API REST Wiresphere

Paramètres de header

Corps de la requête (application/json)

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

Réponse

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

Header

Paramètres de requête

Réponse (200)

{
  "totalElements": 42,
  "totalPages": 5,
  "size": 10,
  "number": 0,
  "first": true,
  "last": false,
  "content": [
    {
      "base": { /* Données de base du produit */ },
      "additional": { /* Données complémentaires */ }
    }
  ]
}

Paramètres de chemin

Réponse (200) — ProductDataDTO

{
  "base": { /* Données de base du produit (nom, SKU, prix, etc.) */ },
  "additional": { /* Champs étendus */ }
}

Corps de la requête (application/json) — ProductDataDTO

{
  "base": {
    // Champs obligatoires et données produit (nom, SKU, prix, statut, etc.)
  },
  "additional": {
    // Champs complémentaires optionnels
  }
}

Réponse

Corps de la requête (application/json)

["produktId1", "produktId2"]

Réponse

Renvoie toutes les opérations bulk enregistrées avec leurs schémas de paramètres.

Réponse (200) — Tableau de ProductOperationRegistrationDTO

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

Simule une opération bulk et affiche l'état avant/après — sans enregistrer de données.

Corps de la requête

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

Exécute une opération bulk sur les produits filtrés. Modifie les données de façon permanente.

Paramètres de requête

Corps de la requête

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

Champs de filtre (paramètre f)

Champs de tri (paramètre o)

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

Exemple

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

Paramètres de chemin

Paramètres de requête

Réponse (200)

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

Paramètres de chemin

Paramètres de requête

Paramètres de chemin

Paramètres de requête

Options de filtre et de tri identiques à celles de l'endpoint admin, mais sans authentification Bearer. Filtre sur les données accessibles dans le contexte de la boutique.

Champs de filtre (paramètre f)

personId, firstName, lastName, email

Réponse (200) — PageCrmPersonDTO

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

Paramètres de chemin

Corps de la requête (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": []
}

Même corps de requête que POST. Remplacement complet de l'enregistrement.

Corps de la requête — RelationDeltaDTO

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

Réponse (200) — OkDTO

{ "ok": true }

Corps de la requête

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

Champs de filtre

name (recherche par sous-chaîne)

Réponse (200) — PageCrmOrganisationDTO

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

Corps de la requête — OrganisationDTO

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

Corps de la requête — RelationDeltaDTO

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

Réponse — PageSlug

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

Corps de la requête — Slug

{
  "id": "507f...",           // À indiquer lors d'une mise à jour
  "slug": "mein-slug",       // Segment d'URL (obligatoire)
  "collection": "products",  // Collection MongoDB (obligatoire)
  "objectType": "product",   // "product" ou "product-list" (obligatoire)
  "refId": "...",            // ID du produit (si objectType "product")
  "fields": {                  // Filtres pour "product-list"
    "category": "beton"
  },
  "defaultSort": [{ "field": "name", "direction": "asc" }],
  "context": ["main-nav"],
  "inactive": false
}

Utile pour retrouver le slug d'un produit connu.

Paramètres de chemin

Paramètres de requête

Paramètres de requête

Réponse (200)

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

Corps de la requête — Tableau de ItemOrderDTO

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

Corps de la requête — NavigationUpdateDTO

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

Paramètres de chemin

Corps de la requête — Setting

{
  "key": "einstellungs-key",
  "public": {
    // Paramètres accessibles publiquement
    "theme": "dark"
  },
  "private": {
    // Accessible uniquement aux requêtes authentifiées
    "apiKey": "secret"
  }
}

Paramètres de requête

Requête en multipart/form-data avec le champ file.

Content-Type: multipart/form-data

file: [binary data]

Réponse (200)

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

Renvoie l'état de paiement actuel de la boutique.

Header

Réponse (200) — WebhookTestStatusDTO

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

Paramètres de chemin

Corps de la requête (multipart)

Content-Type: application/json
file: [binary — fichier CSV ou JSON]

Réponse (200) — UploadResponse

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

Paramètres de chemin

Réponse

Fichier binaire (string format: binary)