Wiresphere REST API

Parametry nagłówka

Request Body (application/json)

{
  "username": "nazwa-uzytkownika",
  "password": "haslo"
}

Odpowiedź

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

Nagłówki

Parametry zapytania

Odpowiedź (200)

{
  "totalElements": 42,
  "totalPages": 5,
  "size": 10,
  "number": 0,
  "first": true,
  "last": false,
  "content": [
    {
      "base": { /* Podstawowe dane produktu */ },
      "additional": { /* Dane dodatkowe */ }
    }
  ]
}

Parametry ścieżki

Odpowiedź (200) — ProductDataDTO

{
  "base": { /* Podstawowe dane produktu (nazwa, SKU, cena itd.) */ },
  "additional": { /* Pola rozszerzone */ }
}

Request Body (application/json) — ProductDataDTO

{
  "base": {
    // Pola obowiązkowe i dane produktu (nazwa, SKU, cena, status itd.)
  },
  "additional": {
    // Opcjonalne pola dodatkowe
  }
}

Odpowiedź

Request Body (application/json)

["produktId1", "produktId2"]

Odpowiedź

Zwraca wszystkie zarejestrowane operacje masowe wraz ze schematami ich parametrów.

Odpowiedź (200) — tablica ProductOperationRegistrationDTO

[{
  "operationId": "set-status",
  "description": "Ustawia status produktów",
  "parameterTypes": { "status": "string" },
  "previewProperties": ["status"]
}]

Symuluje operację masową i pokazuje stan przed/po — bez zapisywania danych.

Request Body

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

Wykonuje operację masową na przefiltrowanych produktach. Trwale zmienia dane.

Parametry zapytania

Request Body

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

Pola filtrów (parametr f)

Pola sortowania (parametr o)

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

Przykład

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: moj-sklep

Parametry ścieżki

Parametry zapytania

Odpowiedź (200)

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

Parametry ścieżki

Parametry zapytania

Parametry ścieżki

Parametry zapytania

Identyczne opcje filtrowania i sortowania jak w punkcie administracyjnym, jednak bez uwierzytelniania Bearer. Filtruje dane dostępne w kontekście sklepu.

Pola filtrów (parametr f)

personId, firstName, lastName, email

Odpowiedź (200) — PageCrmPersonDTO

{
  "totalElements": 100,
  "content": [{
    "id": "507f1f77bcf86cd799439011",
    "firstName": "Jan",
    "lastName": "Kowalski",
    "email": "jan@example.com",
    "personId": "zewn-123",
    "addresses": [],
    "communications": [],
    "organisations": [],
    "types": []
  }]
}

Parametry ścieżki

Request Body (application/json) — PersonDTO

{
  "firstName": "Jan",
  "lastName": "Kowalski",
  "email": "jan@example.com",
  "salutation": "Pan",
  "title": "dr",
  "personId": "zewnetrzne-id-123",
  "addresses": [{
    "street": "Przykładowa",
    "streetNumber": "1",
    "zipCode": "00-001",
    "city": "Warszawa",
    "country": "PL",
    "type": "MAIN"
  }],
  "communications": [{
    "type": "PHONE",
    "value": "+48 123 456 789"
  }],
  "types": []
}

Taki sam request body jak w POST. Pełne zastąpienie rekordu.

Request Body — RelationDeltaDTO

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

Odpowiedź (200) — OkDTO

{ "ok": true }

Request Body

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

Pola filtrów

name (wyszukiwanie podciągu)

Odpowiedź (200) — PageCrmOrganisationDTO

{
  "totalElements": 10,
  "content": [{
    "id": "...",
    "name": "Przykład Sp. z o.o.",
    "organisationId": "zewnetrzne-id",
    "addresses": [],
    "communications": [],
    "people": [],
    "types": []
  }]
}

Request Body — OrganisationDTO

{
  "name": "Przykład Sp. z o.o.",
  "organisationId": "zewnetrzne-id",
  "addresses": [],
  "communications": [],
  "types": []
}

Request Body — RelationDeltaDTO

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

Odpowiedź — 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...",           // Podać przy aktualizacji
  "slug": "moj-slug",       // Segment URL (wymagane)
  "collection": "products",  // Kolekcja MongoDB (wymagane)
  "objectType": "product",   // "product" lub "product-list" (wymagane)
  "refId": "...",            // ID produktu (przy objectType "product")
  "fields": {                  // Filtr dla "product-list"
    "category": "beton"
  },
  "defaultSort": [{ "field": "name", "direction": "asc" }],
  "context": ["main-nav"],
  "inactive": false
}

Przydatne do znalezienia sluga przypisanego do znanego produktu.

Parametry ścieżki

Parametry zapytania

Parametry zapytania

Odpowiedź (200)

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

Request Body — tablica ItemOrderDTO

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

Request Body — NavigationUpdateDTO

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

Parametry ścieżki

Request Body — Setting

{
  "key": "klucz-ustawienia",
  "public": {
    // Ustawienia dostępne publicznie
    "theme": "dark"
  },
  "private": {
    // Dostępne tylko dla uwierzytelnionych żądań
    "apiKey": "secret"
  }
}

Parametry zapytania

Żądanie jako multipart/form-data z polem file.

Content-Type: multipart/form-data

file: [binary data]

Odpowiedź (200)

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

Zwraca aktualny status płatności sklepu.

Nagłówki

Odpowiedź (200) — WebhookTestStatusDTO

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

Parametry ścieżki

Request Body (multipart)

Content-Type: application/json
file: [binary — plik CSV lub JSON]

Odpowiedź (200) — UploadResponse

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

Parametry ścieżki

Odpowiedź

Plik binarny (string format: binary)