ProductServiceImpl

string

Die Spring-Bean-ID des aufzurufenden Services.productServiceImpl

string

Standard:"PROTOTYPE"

Bean-Scope. Für Serviceaufrufe wird PROTOTYPE verwendet.

string

Der öffentliche Methodenname des Services, der in der Signatur angegeben ist.

object[]

Das Argument-Array der Methode. Jedes Argument wird mit dem Index 0, 1 usw. übergeben; der Wert muss dem Java-Parametertyp entsprechen.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: de
Site-Context: my-site
Authorization: Bearer <token>

Senden Sie Lang-Context und Site-Context mit jeder Anfrage. Für geschützte Methoden senden Sie das JWT im Header Authorization im Format Bearer <token>. Zugriff: ADMIN. Bearer Token: bedingt für USER/ADMIN.

GUEST — nicht angemeldete Benutzer; nur Whitelist-Services sind verfügbar.
USER — Authentifizierung erforderlich; Methoden mit USER-Prüfung sind verfügbar.
ADMIN — vollständiger Zugriff auf öffentliche Methoden aller Services.
Wenn eine Methode intern eine Rolle prüft, kann GUEST null erhalten.

Methoden

ProductRepository

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getRepository

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getRepository",
  "args": []
}

Deque<Map<String, Object>>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

getPaginationFilter

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationFilter",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Argument	Typ	Beschreibung
`requestJson`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

searchProducts

Beispiel für das JSON-Anfrageobjekt:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchProducts",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Argument	Typ	Beschreibung
`requestJson`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

searchProductsLightweight

Beispiel für das JSON-Anfrageobjekt:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchProductsLightweight",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<ProductDTO>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchProducts

Beispiel für das JSON-Anfrageobjekt:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchProducts",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Product>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchProductsPaged

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchProductsPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<Product>

Argument	Typ	Beschreibung
`query`	`String`	Übergeben über `args[0].0`.
`offset`	`String`	Übergeben über `args[1].1`.
`limit`	`String`	Übergeben über `args[2].2`.

searchProducts

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchProducts",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

Optional<Product>

Argument	Typ	Beschreibung
`productAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createProduct

Beispiel für das JSON-Anfrageobjekt:

{
    "id":  null,
    "name":  null,
    "description":  null,
    "fallIntoCategories":  null,
    "attributes":  null,
    "keywords":  null,
    "searchTerms":  null,
    "active":  false,
    "SKUs":  null,
    "translations":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createProduct",
  "args": [
    {
      "0": null
    }
  ]
}

Product

Argument	Typ	Beschreibung
`categoryId`	`String`	Übergeben über `args[0].0`.
`productAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[1].1`.

addProductToCategory

Beispiel für das JSON-Anfrageobjekt:

{
    "id":  null,
    "name":  null,
    "description":  null,
    "fallIntoCategories":  null,
    "attributes":  null,
    "keywords":  null,
    "searchTerms":  null,
    "active":  false,
    "SKUs":  null,
    "translations":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addProductToCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Product

Argument	Typ	Beschreibung
`categoryId`	`String`	Übergeben über `args[0].0`.
`productId`	`String`	Übergeben über `args[1].1`.

addProductToCategory

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addProductToCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Product

Argument	Typ	Beschreibung
`productAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

saveProduct

Beispiel für das JSON-Anfrageobjekt:

{
    "id":  null,
    "name":  null,
    "description":  null,
    "fallIntoCategories":  null,
    "attributes":  null,
    "keywords":  null,
    "searchTerms":  null,
    "active":  false,
    "SKUs":  null,
    "translations":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveProduct",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String, String>>

Argument	Typ	Beschreibung
`categoryId`	`String`	Übergeben über `args[0].0`.

getSortedProductsByCategory

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getSortedProductsByCategory",
  "args": [
    {
      "0": null
    }
  ]
}

List<Map<String, Object>>

Argument	Typ	Beschreibung
`categoryId`	`String`	Übergeben über `args[0].0`.
`firstLetter`	`String`	Übergeben über `args[1].1`.

getProductsByCategoryAndFirstLetter

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getProductsByCategoryAndFirstLetter",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.
`categoryId`	`String`	Übergeben über `args[1].1`.

removeProductFromCategory

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.
`skuId`	`String`	Übergeben über `args[1].1`.

removeProductFromSKU

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromSKU",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.
`attrId`	`String`	Übergeben über `args[1].1`.

removeProductFromAttribute

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromAttribute",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.
`tranId`	`String`	Übergeben über `args[1].1`.

removeProductFromTranslation

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromTranslation",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.

removeProductFromCategories

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromCategories",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.

removeProductFromSKUs

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromSKUs",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.

removeProductFromAttributes

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromAttributes",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.

removeProductFromTranslations

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductFromTranslations",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productId`	`String`	Übergeben über `args[0].0`.

removeProductAndClean

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`productsIds`	`ArrayList<String>`	Übergeben über `args[0].0`.

removeProductsByIds

{
  "beanId": "productServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeProductsByIds",
  "args": [
    {
      "0": null
    }
  ]
}

Client-Integration

Clients

Services

REST API

Headers

Methoden

getRepository

getPaginationFilter

searchProducts

searchProductsLightweight

searchProducts

searchProductsPaged

searchProducts

createProduct

addProductToCategory

addProductToCategory

saveProduct

getSortedProductsByCategory

getProductsByCategoryAndFirstLetter

removeProductFromCategory

removeProductFromSKU

removeProductFromAttribute

removeProductFromTranslation

removeProductFromCategories

removeProductFromSKUs

removeProductFromAttributes

removeProductFromTranslations

removeProductAndClean

removeProductsByIds

​Headers

​Methoden

​getRepository

​getPaginationFilter

​searchProducts

​searchProductsLightweight

​searchProducts

​searchProductsPaged

​searchProducts

​createProduct

​addProductToCategory

​addProductToCategory

​saveProduct

​getSortedProductsByCategory

​getProductsByCategoryAndFirstLetter

​removeProductFromCategory

​removeProductFromSKU

​removeProductFromAttribute

​removeProductFromTranslation

​removeProductFromCategories

​removeProductFromSKUs

​removeProductFromAttributes

​removeProductFromTranslations

​removeProductAndClean

​removeProductsByIds

Headers

Methoden

getRepository

getPaginationFilter

searchProducts

searchProductsLightweight

searchProducts

searchProductsPaged

searchProducts

createProduct

addProductToCategory

addProductToCategory

saveProduct

getSortedProductsByCategory

getProductsByCategoryAndFirstLetter

removeProductFromCategory

removeProductFromSKU

removeProductFromAttribute

removeProductFromTranslation

removeProductFromCategories

removeProductFromSKUs

removeProductFromAttributes

removeProductFromTranslations

removeProductAndClean

removeProductsByIds