ProductServiceImpl

string

The Spring bean identifier containing the service being called.productServiceImpl

string

default:"PROTOTYPE"

Bean scope. Use PROTOTYPE for service calls.

string

The public service method name shown in the signature below.

object[]

The method argument array. Each argument is passed as an object with index 0, 1, and so on; the value must match the Java parameter type.

Headers

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

Send Lang-Context and Site-Context with every request. For protected methods, send the JWT in the Authorization header as Bearer <token>. Access: ADMIN. Bearer Token: conditional for USER/ADMIN.

GUEST — unauthenticated users; only whitelist services are available.
USER — authentication is required; methods with USER checks are available.
ADMIN — full access to public methods of all services.
If a method checks a role internally, GUEST may receive null.

Methods

ProductRepository

Argument	Type	Description
—	—	This method does not accept arguments.

getRepository

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

Deque<Map<String, Object>>

Argument	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

getPaginationFilter

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

SearchResponse

Argument	Type	Description
`requestJson`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

searchProducts

Example JSON request object:

{
    "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	Type	Description
`requestJson`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

searchProductsLightweight

Example JSON request object:

{
    "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	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchProducts

Example JSON request object:

{
    "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	Type	Description
`requestJson`	`String`	Passed through `args[0].0`.

searchProductsPaged

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

List<Product>

Argument	Type	Description
`query`	`String`	Passed through `args[0].0`.
`offset`	`String`	Passed through `args[1].1`.
`limit`	`String`	Passed through `args[2].2`.

searchProducts

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

Optional<Product>

Argument	Type	Description
`productAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

createProduct

Example JSON request object:

{
    "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	Type	Description
`categoryId`	`String`	Passed through `args[0].0`.
`productAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[1].1`.

addProductToCategory

Example JSON request object:

{
    "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	Type	Description
`categoryId`	`String`	Passed through `args[0].0`.
`productId`	`String`	Passed through `args[1].1`.

addProductToCategory

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

Product

Argument	Type	Description
`productAsMap`	`LinkedHashMap<String, Object>`	Passed through `args[0].0`.

saveProduct

Example JSON request object:

{
    "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	Type	Description
`categoryId`	`String`	Passed through `args[0].0`.

getSortedProductsByCategory

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

List<Map<String, Object>>

Argument	Type	Description
`categoryId`	`String`	Passed through `args[0].0`.
`firstLetter`	`String`	Passed through `args[1].1`.

getProductsByCategoryAndFirstLetter

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.
`categoryId`	`String`	Passed through `args[1].1`.

removeProductFromCategory

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.
`skuId`	`String`	Passed through `args[1].1`.

removeProductFromSKU

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.
`attrId`	`String`	Passed through `args[1].1`.

removeProductFromAttribute

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.
`tranId`	`String`	Passed through `args[1].1`.

removeProductFromTranslation

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.

removeProductFromCategories

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.

removeProductFromSKUs

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.

removeProductFromAttributes

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.

removeProductFromTranslations

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

void

Argument	Type	Description
`productId`	`String`	Passed through `args[0].0`.

removeProductAndClean

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

void

Argument	Type	Description
`productsIds`	`ArrayList<String>`	Passed through `args[0].0`.

removeProductsByIds

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

Client integration

Clients

Services

REST API

Headers

Methods

getRepository

getPaginationFilter

searchProducts

searchProductsLightweight

searchProducts

searchProductsPaged

searchProducts

createProduct

addProductToCategory

addProductToCategory

saveProduct

getSortedProductsByCategory

getProductsByCategoryAndFirstLetter

removeProductFromCategory

removeProductFromSKU

removeProductFromAttribute

removeProductFromTranslation

removeProductFromCategories

removeProductFromSKUs

removeProductFromAttributes

removeProductFromTranslations

removeProductAndClean

removeProductsByIds

​Headers

​Methods

​getRepository

​getPaginationFilter

​searchProducts

​searchProductsLightweight

​searchProducts

​searchProductsPaged

​searchProducts

​createProduct

​addProductToCategory

​addProductToCategory

​saveProduct

​getSortedProductsByCategory

​getProductsByCategoryAndFirstLetter

​removeProductFromCategory

​removeProductFromSKU

​removeProductFromAttribute

​removeProductFromTranslation

​removeProductFromCategories

​removeProductFromSKUs

​removeProductFromAttributes

​removeProductFromTranslations

​removeProductAndClean

​removeProductsByIds

Headers

Methods

getRepository

getPaginationFilter

searchProducts

searchProductsLightweight

searchProducts

searchProductsPaged

searchProducts

createProduct

addProductToCategory

addProductToCategory

saveProduct

getSortedProductsByCategory

getProductsByCategoryAndFirstLetter

removeProductFromCategory

removeProductFromSKU

removeProductFromAttribute

removeProductFromTranslation

removeProductFromCategories

removeProductFromSKUs

removeProductFromAttributes

removeProductFromTranslations

removeProductAndClean

removeProductsByIds