SalesCatalogServiceImpl

string

The Spring bean identifier containing the service being called.salesCatalogServiceImpl

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

Deque<Map<String, Object>>

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

getPaginationUnits

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationUnits",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<UnitDTO>

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

searchUnits

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchUnits",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Unit>

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

searchUnitsPaged

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchUnitsPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<CurrencyItem>

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

getAllCurrencies

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAllCurrencies",
  "args": []
}

CurrencyItem

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

getCurrencyByCode

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCurrencyByCode",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

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

getSellerSkuFromChatTopic

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getSellerSkuFromChatTopic",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String,String>

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

getCountOfSellerSkusBySeller

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountOfSellerSkusBySeller",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

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

getCountOfSellerSkus

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCountOfSellerSkus",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Unit>

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

createUnit

Example JSON request object:

{
    "id":  null,
    "type":  null,
    "name":  null,
    "countPerUnitSuffix":  null,
    "minOrderSuffix":  null,
    "quantitySuffix":  null,
    "searchTerms":  null,
    "fallIntoSellerSKUs":  null,
    "translations":  null
}

Request:

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createUnit",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

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

addPackageItemToSellerSku

Example JSON request object:

{
    "id":  null,
    "countPerUnit":  0,
    "minOrder":  0,
    "quantity":  0,
    "lockedQuantity":  0,
    "embeddedSellerSKU":  null
}

Request:

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addPackageItemToSellerSku",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Type	Description
`sellerSkuId`	`String`	Passed through `args[0].0`.
`packageId`	`String`	Passed through `args[1].1`.

removePackageItemFromSellerSku

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removePackageItemFromSellerSku",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

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

removeFileResources

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeFileResources",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

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

saveSellerSkuAsDraft

Example JSON request object:

{
    "id":  null,
    "type":  null,
    "geneticType":  null,
    "name":  null,
    "packageItem":  null,
    "inventory":  null,
    "description":  null,
    "additionalTextInfo":  null,
    "price":  null,
    "currencyItem":  null,
    "countryOfOrigin":  null,
    "countryOfSeller":  null,
    "productsRef":  null,
    "expireDate":  null,
    "durabilityDate1":  null,
    "durabilityDate2":  null,
    "incoTerm":  null,
    "deliveryType":  null,
    "unit":  null,
    "imageURLs":  null,
    "keywords":  null,
    "searchTerms":  null,
    "embeddedSku":  null,
    "embeddedSeller":  null,
    "orderedItems":  null,
    "packagedItems":  null,
    "attributeValues":  null,
    "logicalTypeFilters":  null,
    "listTypeFilters":  null,
    "simpleTypeFilters":  null,
    "rangeFilters":  null,
    "numericFilters":  null,
    "documentURLs":  null,
    "isRandomGenerated":  false,
    "isPublishedForSale":  false,
    "score":  0
}

Request:

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveSellerSkuAsDraft",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

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

saveSellerSKU

Example JSON request object:

{
    "id":  null,
    "type":  null,
    "geneticType":  null,
    "name":  null,
    "packageItem":  null,
    "inventory":  null,
    "description":  null,
    "additionalTextInfo":  null,
    "price":  null,
    "currencyItem":  null,
    "countryOfOrigin":  null,
    "countryOfSeller":  null,
    "productsRef":  null,
    "expireDate":  null,
    "durabilityDate1":  null,
    "durabilityDate2":  null,
    "incoTerm":  null,
    "deliveryType":  null,
    "unit":  null,
    "imageURLs":  null,
    "keywords":  null,
    "searchTerms":  null,
    "embeddedSku":  null,
    "embeddedSeller":  null,
    "orderedItems":  null,
    "packagedItems":  null,
    "attributeValues":  null,
    "logicalTypeFilters":  null,
    "listTypeFilters":  null,
    "simpleTypeFilters":  null,
    "rangeFilters":  null,
    "numericFilters":  null,
    "documentURLs":  null,
    "isRandomGenerated":  false,
    "isPublishedForSale":  false,
    "score":  0
}

Request:

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveSellerSKU",
  "args": [
    {
      "0": null
    }
  ]
}

Unit

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

saveUnit

Example JSON request object:

{
    "id":  null,
    "type":  null,
    "name":  null,
    "countPerUnitSuffix":  null,
    "minOrderSuffix":  null,
    "quantitySuffix":  null,
    "searchTerms":  null,
    "fallIntoSellerSKUs":  null,
    "translations":  null
}

Request:

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveUnit",
  "args": [
    {
      "0": null
    }
  ]
}

Map<String, String>

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

getAllSellerTariff

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getAllSellerTariff",
  "args": []
}

void

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

removeSellerSkuAndClean

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeSellerSkuAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeSellerSkusByIds

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeSellerSkusByIds",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<SellerSKU>

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

createSellerSKU

Example JSON request object:

{
    "id":  null,
    "type":  null,
    "geneticType":  null,
    "name":  null,
    "packageItem":  null,
    "inventory":  null,
    "description":  null,
    "additionalTextInfo":  null,
    "price":  null,
    "currencyItem":  null,
    "countryOfOrigin":  null,
    "countryOfSeller":  null,
    "productsRef":  null,
    "expireDate":  null,
    "durabilityDate1":  null,
    "durabilityDate2":  null,
    "incoTerm":  null,
    "deliveryType":  null,
    "unit":  null,
    "imageURLs":  null,
    "keywords":  null,
    "searchTerms":  null,
    "embeddedSku":  null,
    "embeddedSeller":  null,
    "orderedItems":  null,
    "packagedItems":  null,
    "attributeValues":  null,
    "logicalTypeFilters":  null,
    "listTypeFilters":  null,
    "simpleTypeFilters":  null,
    "rangeFilters":  null,
    "numericFilters":  null,
    "documentURLs":  null,
    "isRandomGenerated":  false,
    "isPublishedForSale":  false,
    "score":  0
}

Request:

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createSellerSKU",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeUnitAndClean

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeUnitAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

void

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

removeUnitsByIds

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeUnitsByIds",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

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

publishForSale

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "publishForSale",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

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

withdrawFromSale

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "withdrawFromSale",
  "args": [
    {
      "0": null
    }
  ]
}

SellerSKU

Argument	Type	Description
`sellerSkuId`	`String`	Passed through `args[0].0`.
`type`	`String`	Passed through `args[1].1`.

changeType

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "changeType",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

SellerSKU

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

duplicate

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "duplicate",
  "args": [
    {
      "0": null
    }
  ]
}

List<Attachment>

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

getSellerSkuDocumentUrls

{
  "beanId": "salesCatalogServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getSellerSkuDocumentUrls",
  "args": [
    {
      "0": null
    }
  ]
}

Client integration

Clients

Services

REST API

Headers

Methods

getPaginationUnits

searchUnits

searchUnitsPaged

getAllCurrencies

getCurrencyByCode

getSellerSkuFromChatTopic

getCountOfSellerSkusBySeller

getCountOfSellerSkus

createUnit

addPackageItemToSellerSku

removePackageItemFromSellerSku

removeFileResources

saveSellerSkuAsDraft

saveSellerSKU

saveUnit

getAllSellerTariff

removeSellerSkuAndClean

removeSellerSkusByIds

createSellerSKU

removeUnitAndClean

removeUnitsByIds

publishForSale

withdrawFromSale

changeType

duplicate

getSellerSkuDocumentUrls

​Headers

​Methods

​getPaginationUnits

​searchUnits

​searchUnitsPaged

​getAllCurrencies

​getCurrencyByCode

​getSellerSkuFromChatTopic

​getCountOfSellerSkusBySeller

​getCountOfSellerSkus

​createUnit

​addPackageItemToSellerSku

​removePackageItemFromSellerSku

​removeFileResources

​saveSellerSkuAsDraft

​saveSellerSKU

​saveUnit

​getAllSellerTariff

​removeSellerSkuAndClean

​removeSellerSkusByIds

​createSellerSKU

​removeUnitAndClean

​removeUnitsByIds

​publishForSale

​withdrawFromSale

​changeType

​duplicate

​getSellerSkuDocumentUrls

Headers

Methods

getPaginationUnits

searchUnits

searchUnitsPaged

getAllCurrencies

getCurrencyByCode

getSellerSkuFromChatTopic

getCountOfSellerSkusBySeller

getCountOfSellerSkus

createUnit

addPackageItemToSellerSku

removePackageItemFromSellerSku

removeFileResources

saveSellerSkuAsDraft

saveSellerSKU

saveUnit

getAllSellerTariff

removeSellerSkuAndClean

removeSellerSkusByIds

createSellerSKU

removeUnitAndClean

removeUnitsByIds

publishForSale

withdrawFromSale

changeType

duplicate

getSellerSkuDocumentUrls