Wiresphere REST API

Header Parameters

Request Body (application/json)

{
  "username": "your-username",
  "password": "your-password"
}

Response

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

Header

Query Parameters

Response (200)

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

Path Parameters

Response (200) — ProductDataDTO

{
  "base": { /* base product data (name, SKU, price, etc.) */ },
  "additional": { /* extended fields */ }
}

Request Body (application/json) — ProductDataDTO

{
  "base": {
    // Required fields and product data (name, SKU, price, status, etc.)
  },
  "additional": {
    // Optional additional fields
  }
}

Response

Request Body (application/json)

["productId1", "productId2"]

Response

Returns all registered bulk operations along with their parameter schemas.

Response (200) — Array of ProductOperationRegistrationDTO

[{
  "operationId": "set-status",
  "description": "Sets the status of products",
  "parameterTypes": { "status": "string" },
  "previewProperties": ["status"]
}]

Simulates a bulk operation and shows the before/after state — without saving any data.

Request Body

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

Executes a bulk operation on filtered products. Changes data permanently.

Query Parameters

Request Body

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

Filter fields (parameter f)

Sort fields (parameter o)

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

Example

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: my-shop

Path Parameters

Query Parameters

Response (200)

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

Path Parameters

Query Parameters

Path Parameters

Query Parameters

Identical filter and sort options to the admin endpoint, but without Bearer authentication. Filters on the data accessible within the shop context.

Filter fields (parameter f)

personId, firstName, lastName, email

Response (200) — PageCrmPersonDTO

{
  "totalElements": 100,
  "content": [{
    "id": "507f1f77bcf86cd799439011",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john@example.com",
    "personId": "external-123",
    "addresses": [],
    "communications": [],
    "organisations": [],
    "types": []
  }]
}

Path Parameters

Request Body (application/json) — PersonDTO

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "salutation": "Mr",
  "title": "Dr.",
  "personId": "external-id-123",
  "addresses": [{
    "street": "Sample Street",
    "streetNumber": "1",
    "zipCode": "12345",
    "city": "Sampletown",
    "country": "DE",
    "type": "MAIN"
  }],
  "communications": [{
    "type": "PHONE",
    "value": "+49 123 4567890"
  }],
  "types": []
}

Same request body as POST. Fully replaces the record.

Request Body — RelationDeltaDTO

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

Response (200) — OkDTO

{ "ok": true }

Request Body

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

Filter fields

name (substring search)

Response (200) — PageCrmOrganisationDTO

{
  "totalElements": 10,
  "content": [{
    "id": "...",
    "name": "Example Inc.",
    "organisationId": "external-id",
    "addresses": [],
    "communications": [],
    "people": [],
    "types": []
  }]
}

Request Body — OrganisationDTO

{
  "name": "Example Inc.",
  "organisationId": "external-id",
  "addresses": [],
  "communications": [],
  "types": []
}

Request Body — RelationDeltaDTO

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

Response — PageSlug

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

Request Body — Slug

{
  "id": "507f...",           // Provide when updating
  "slug": "my-slug",        // URL segment (required)
  "collection": "products",  // MongoDB collection (required)
  "objectType": "product",   // "product" or "product-list" (required)
  "refId": "...",            // Product ID (for objectType "product")
  "fields": {                  // Filter for "product-list"
    "category": "beton"
  },
  "defaultSort": [{ "field": "name", "direction": "asc" }],
  "context": ["main-nav"],
  "inactive": false
}

Useful for finding the slug of a known product.

Path Parameters

Query Parameters

Query Parameters

Response (200)

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

Request Body — Array of ItemOrderDTO

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

Request Body — NavigationUpdateDTO

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

Path Parameters

Request Body — Setting

{
  "key": "settings-key",
  "public": {
    // Publicly accessible settings
    "theme": "dark"
  },
  "private": {
    // Accessible to authenticated requests only
    "apiKey": "secret"
  }
}

Query Parameters

Request as multipart/form-data with the field file.

Content-Type: multipart/form-data

file: [binary data]

Response (200)

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

Returns the shop's current payment state.

Header

Response (200) — WebhookTestStatusDTO

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

Path Parameters

Request Body (multipart)

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

Response (200) — UploadResponse

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

Path Parameters

Response

Binary file (string format: binary)