CustomerServiceImpl

string

The Spring bean identifier containing the service being called.customerServiceImpl

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: GUEST. Bearer Token: not required.

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

SellerRepository

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

getRepository

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

Deque<Map<String, Object>>

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

getPaginationCustomers

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationCustomers",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

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

validateVerificationToken

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "validateVerificationToken",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

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

validatePasswordResetToken

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "validatePasswordResetToken",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

sendVerificationEmail

Example JSON request object:

{
    "id":  null,
    "username":  null,
    "password":  null,
    "savedPassword":  null,
    "fallIntoObjects":  null,
    "active":  false,
    "roles":  null,
    "permissions":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "sendVerificationEmail",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

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

searchCustomers

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": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCustomers",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

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

searchCustomersLightweight

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": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCustomersLightweight",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Seller>

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

getCustomersPaged

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCustomersPaged",
  "args": [
    {
      "0": null
    }
  ]
}

Seller

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

registerCustomerFull

Example JSON request object:

{
    "id":  null,
    "stripeCustomerId":  null,
    "stripeConnectId":  null,
    "address":  null,
    "shippingAddresses":  null,
    "companyName":  null,
    "vatNumber":  null,
    "numberOfEmployees":  null,
    "sellerType":  null,
    "sellerTariff":  null,
    "subscription":  null,
    "companyEmailAddress":  null,
    "companyPhone":  null,
    "companyWebSite":  null,
    "imageURLs":  null,
    "documentURLs":  null,
    "description":  null,
    "profiles":  null,
    "certificates":  null,
    "sellerSKUs":  null,
    "ordersBuyer":  null,
    "ordersVendor":  null,
    "favoriteSellersIds":  null,
    "favoriteSellerSkuIds":  null,
    "sellerCategoriesIds":  null,
    "sellerProductsIds":  null,
    "emailNotifications":  false,
    "onlineActive":  false
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "registerCustomerFull",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<Profile>

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

searchEmployees

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchEmployees",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Profile>

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

searchEmployeesPaged

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchEmployeesPaged",
  "args": [
    {
      "0": null
    }
  ]
}

Profile

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

registerCustomerSimplified

Example JSON request object:

{
    "id":  null,
    "user":  null,
    "firstName":  null,
    "lastName":  null,
    "website":  null,
    "phone":  null,
    "mobilePhone":  null,
    "birthday":  null,
    "emailAddress":  null,
    "gender":  null,
    "salutation":  null,
    "embeddedParent":  null,
    "emailNotifications":  false,
    "imageURLs":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "registerCustomerSimplified",
  "args": [
    {
      "0": null
    }
  ]
}

Seller

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

updateCustomer

Example JSON request object:

{
    "id":  null,
    "stripeCustomerId":  null,
    "stripeConnectId":  null,
    "address":  null,
    "companyName":  null,
    "vatNumber":  null,
    "numberOfEmployees":  null,
    "sellerType":  null,
    "sellerTariff":  null,
    "subscription":  null,
    "companyEmailAddress":  null,
    "companyPhone":  null,
    "companyWebSite":  null,
    "description":  null,
    "imageURLs":  null,
    "shippingAddresses":  null,
    "documentURLs":  null,
    "profileIds":  null,
    "certificateIds":  null,
    "sellerSkuIds":  null,
    "ordersAsBuyerIds":  null,
    "ordersAsVendorIds":  null,
    "favoriteSellersIds":  null,
    "favoriteSellerSkuIds":  null,
    "sellerCategoriesIds":  null,
    "sellerProductsIds":  null,
    "emailNotifications":  false,
    "onlineActive":  false,
    "imageUrlRemove":  false,
    "metaInfo":  null,
    "createdBy":  null,
    "createdDate":  null,
    "lastModifiedBy":  null,
    "lastModifiedDate":  null,
    "alias":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCustomer",
  "args": [
    {
      "0": null
    }
  ]
}

Profile

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

updateCustomerProfile

Example JSON request object:

{
    "id":  null,
    "user":  null,
    "firstName":  null,
    "lastName":  null,
    "website":  null,
    "phone":  null,
    "mobilePhone":  null,
    "birthday":  null,
    "emailAddress":  null,
    "gender":  null,
    "salutation":  null,
    "embeddedParent":  null,
    "emailNotifications":  false,
    "imageURLs":  null
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCustomerProfile",
  "args": [
    {
      "0": null
    }
  ]
}

SellerDTO

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

mapSellerToDto

Example JSON request object:

{
    "id":  null,
    "stripeCustomerId":  null,
    "stripeConnectId":  null,
    "address":  null,
    "shippingAddresses":  null,
    "companyName":  null,
    "vatNumber":  null,
    "numberOfEmployees":  null,
    "sellerType":  null,
    "sellerTariff":  null,
    "subscription":  null,
    "companyEmailAddress":  null,
    "companyPhone":  null,
    "companyWebSite":  null,
    "imageURLs":  null,
    "documentURLs":  null,
    "description":  null,
    "profiles":  null,
    "certificates":  null,
    "sellerSKUs":  null,
    "ordersBuyer":  null,
    "ordersVendor":  null,
    "favoriteSellersIds":  null,
    "favoriteSellerSkuIds":  null,
    "sellerCategoriesIds":  null,
    "sellerProductsIds":  null,
    "emailNotifications":  false,
    "onlineActive":  false
}

Request:

{
  "beanId": "customerServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "mapSellerToDto",
  "args": [
    {
      "0": null
    }
  ]
}

Client integration

Clients

Services

REST API

Headers

Methods

getRepository

getPaginationCustomers

validateVerificationToken

validatePasswordResetToken

sendVerificationEmail

searchCustomers

searchCustomersLightweight

getCustomersPaged

registerCustomerFull

searchEmployees

searchEmployeesPaged

registerCustomerSimplified

updateCustomer

updateCustomerProfile

mapSellerToDto

​Headers

​Methods

​getRepository

​getPaginationCustomers

​validateVerificationToken

​validatePasswordResetToken

​sendVerificationEmail

​searchCustomers

​searchCustomersLightweight

​getCustomersPaged

​registerCustomerFull

​searchEmployees

​searchEmployeesPaged

​registerCustomerSimplified

​updateCustomer

​updateCustomerProfile

​mapSellerToDto

Headers

Methods

getRepository

getPaginationCustomers

validateVerificationToken

validatePasswordResetToken

sendVerificationEmail

searchCustomers

searchCustomersLightweight

getCustomersPaged

registerCustomerFull

searchEmployees

searchEmployeesPaged

registerCustomerSimplified

updateCustomer

updateCustomerProfile

mapSellerToDto