OrderServiceImpl - MastermindCMS Documentation

string

Идентификатор Spring bean, который содержит вызываемый сервис.orderServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

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

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: GUEST* / USER или ADMIN. Bearer Token: условно для USER/ADMIN.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

void

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

handleNotify

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "handleNotify",
  "args": []
}

OrderRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getRepository

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

String

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

activeLogisticsProvider

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "activeLogisticsProvider",
  "args": []
}

String

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

activePaymentProvider

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "activePaymentProvider",
  "args": []
}

CommerceItemRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getCommerceItemRepository

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getCommerceItemRepository",
  "args": []
}

Deque<Map<String, Object>>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getPaginationFilter

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

LinkedHashSet<OrderDTO>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getOrders

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getOrders",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Order>

Аргумент	Тип	Описание
`requestJson`	`String`	Передаётся через `args[0].0`.

getOrdersPaged

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getOrdersPaged",
  "args": [
    {
      "0": null
    }
  ]
}

Optional<Order>

Аргумент	Тип	Описание
`orderAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createOrder

Пример JSON объекта запроса:

{
    "id":  null,
    "contactProfileId":  null,
    "embeddedVendor":  null,
    "embeddedBuyer":  null,
    "orderTimeLines":  null,
    "commerceItems":  null,
    "tax":  null,
    "currencySymbol":  null,
    "currencyCode":  null,
    "packageItem":  null,
    "paymentMethodId":  null,
    "paymentIntentId":  null,
    "parcelId":  null,
    "payoutId":  null,
    "shippingAddress":  null,
    "sellerTaxRate":  null,
    "buyerTaxRate":  null,
    "serviceTaxRate":  null
}

Request:

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createOrder",
  "args": [
    {
      "0": null
    }
  ]
}

Order

Аргумент	Тип	Описание
`orderAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

saveOrder

Пример JSON объекта запроса:

{
    "id":  null,
    "contactProfileId":  null,
    "embeddedVendor":  null,
    "embeddedBuyer":  null,
    "orderTimeLines":  null,
    "commerceItems":  null,
    "tax":  null,
    "currencySymbol":  null,
    "currencyCode":  null,
    "packageItem":  null,
    "paymentMethodId":  null,
    "paymentIntentId":  null,
    "parcelId":  null,
    "payoutId":  null,
    "shippingAddress":  null,
    "sellerTaxRate":  null,
    "buyerTaxRate":  null,
    "serviceTaxRate":  null
}

Request:

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveOrder",
  "args": [
    {
      "0": null
    }
  ]
}

List<OrderDTO>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

orderCheckout

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "orderCheckout",
  "args": []
}

Order

Аргумент	Тип	Описание
`paymentRequestAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

digitalOrderCheckout

Пример JSON объекта запроса:

{
    "orderId":  null,
    "paymentMethodId":  null,
    "paymentIntentId":  null,
    "toAccountId":  null,
    "description":  null,
    "quantity":  0,
    "amount":  0,
    "currencyCode":  null,
    "email":  null,
    "commerceItems":  null,
    "metadata":  null,
    "confirm":  false
}

Request:

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "digitalOrderCheckout",
  "args": [
    {
      "0": null
    }
  ]
}

Attachment

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

createInvoiceBuyerToVendor

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createInvoiceBuyerToVendor",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

removeOrder

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeOrder",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`orderIds`	`ArrayList<String>`	Передаётся через `args[0].0`.

removeOrdersByIds

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeOrdersByIds",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`commerceItemId`	`String`	Передаётся через `args[1].1`.

removeCommerceItemFromOrder

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCommerceItemFromOrder",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

List<OrderDTO>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getOrdersFromLoggedUser

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getOrdersFromLoggedUser",
  "args": []
}

LinkedHashSet<OrderDTO>

Аргумент	Тип	Описание
`orderIds`	`ArrayList<String>`	Передаётся через `args[0].0`.

getOrdersFromLoggedUserByIds

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getOrdersFromLoggedUserByIds",
  "args": [
    {
      "0": null
    }
  ]
}

OrderDTO

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

getOrder

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getOrder",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

approve

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "approve",
  "args": [
    {
      "0": null
    }
  ]
}

PaymentStatus

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

pay

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "pay",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

obtain3DSecureLink

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "obtain3DSecureLink",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

ship

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "ship",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

deliver

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "deliver",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

payout

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "payout",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

complete

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "complete",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`createInvoice`	`Boolean`	Передаётся через `args[1].1`.

completeDigitalOrder

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "completeDigitalOrder",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

prepareForShipment

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "prepareForShipment",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

cancel

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "cancel",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

refund

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "refund",
  "args": [
    {
      "0": null
    }
  ]
}

List<OrderTimeLineBean>

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

getOrderTimeLine

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getOrderTimeLine",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`asVendor`	`boolean`	Передаётся через `args[1].1`.

isUserParticipatesInOrder

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "isUserParticipatesInOrder",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

OrderTimeLineBean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

getLastOrderTimelineBean

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getLastOrderTimelineBean",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`attachmentName`	`String`	Передаётся через `args[1].1`.

removeAttachment

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeAttachment",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`orderTimelineStep`	`String`	Передаётся через `args[1].1`.
`attachmentName`	`String`	Передаётся через `args[2].2`.

removeAttachment

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

Set<Address>

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getShippingAddresses

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getShippingAddresses",
  "args": []
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

canCancel

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "canCancel",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

canAddAttachment

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "canAddAttachment",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`params`	`LinkedHashMap<String, Object>`	Передаётся через `args[1].1`.

changeAddress

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "changeAddress",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.
`paymentMethod`	`LinkedHashMap<String, Object>`	Передаётся через `args[1].1`.

changePaymentMethod

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "changePaymentMethod",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

canChangeStatus

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "canChangeStatus",
  "args": [
    {
      "0": null
    }
  ]
}

boolean

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

mustAddAttachments

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "mustAddAttachments",
  "args": [
    {
      "0": null
    }
  ]
}

String

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

getInvoiceTemplate

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getInvoiceTemplate",
  "args": [
    {
      "0": null
    }
  ]
}

BigDecimal

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

calculateDelivery

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "calculateDelivery",
  "args": [
    {
      "0": null
    }
  ]
}

Order

Аргумент	Тип	Описание
`orderId`	`String`	Передаётся через `args[0].0`.

clearPaymentInfo

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "clearPaymentInfo",
  "args": [
    {
      "0": null
    }
  ]
}

CommerceItem

Аргумент	Тип	Описание
`commerceItemId`	`String`	Передаётся через `args[0].0`.
`metaInfo`	`LinkedHashMap<String, Object>`	Передаётся через `args[1].1`.

updateCommerceItemMetaInfo

{
  "beanId": "orderServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCommerceItemMetaInfo",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

​Headers

​Методы

​handleNotify

​getRepository

​activeLogisticsProvider

​activePaymentProvider

​getCommerceItemRepository

​getPaginationFilter

​getOrders

​getOrdersPaged

​createOrder

​saveOrder

​orderCheckout

​digitalOrderCheckout

​createInvoiceBuyerToVendor

​removeOrder

​removeOrdersByIds

​removeCommerceItemFromOrder

​getOrdersFromLoggedUser

​getOrdersFromLoggedUserByIds

​getOrder

​approve

​pay

​obtain3DSecureLink

​ship

​deliver

​payout

​complete

​completeDigitalOrder

​prepareForShipment

​cancel

​refund

​getOrderTimeLine

​isUserParticipatesInOrder

​getLastOrderTimelineBean

​removeAttachment

​removeAttachment

​getShippingAddresses

​canCancel

​canAddAttachment

​changeAddress

​changePaymentMethod

​canChangeStatus

​mustAddAttachments

​getInvoiceTemplate

​calculateDelivery

​clearPaymentInfo

​updateCommerceItemMetaInfo

Headers

Методы

handleNotify

getRepository

activeLogisticsProvider

activePaymentProvider

getCommerceItemRepository

getPaginationFilter

getOrders

getOrdersPaged

createOrder

saveOrder

orderCheckout

digitalOrderCheckout

createInvoiceBuyerToVendor

removeOrder

removeOrdersByIds

removeCommerceItemFromOrder

getOrdersFromLoggedUser

getOrdersFromLoggedUserByIds

getOrder

approve

pay

obtain3DSecureLink

ship

deliver

payout

complete

completeDigitalOrder

prepareForShipment

cancel

refund

getOrderTimeLine

isUserParticipatesInOrder

getLastOrderTimelineBean

removeAttachment

removeAttachment

getShippingAddresses

canCancel

canAddAttachment

changeAddress

changePaymentMethod

canChangeStatus

mustAddAttachments

getInvoiceTemplate

calculateDelivery

clearPaymentInfo

updateCommerceItemMetaInfo