OrderServiceImpl - MastermindCMS Documentation

string

The Spring bean identifier containing the service being called.orderServiceImpl

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

void

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

handleNotify

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

OrderRepository

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

getRepository

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

String

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

activeLogisticsProvider

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

String

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

activePaymentProvider

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

CommerceItemRepository

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

getCommerceItemRepository

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

Deque<Map<String, Object>>

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

getPaginationFilter

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

LinkedHashSet<OrderDTO>

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

getOrders

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

Page<Order>

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

getOrdersPaged

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

Optional<Order>

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

createOrder

Example JSON request object:

{
    "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

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

saveOrder

Example JSON request object:

{
    "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>

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

orderCheckout

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

Order

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

digitalOrderCheckout

Example JSON request object:

{
    "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

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

createInvoiceBuyerToVendor

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

void

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

removeOrder

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

void

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

removeOrdersByIds

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

boolean

Argument	Type	Description
`orderId`	`String`	Passed through `args[0].0`.
`commerceItemId`	`String`	Passed through `args[1].1`.

removeCommerceItemFromOrder

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

List<OrderDTO>

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

getOrdersFromLoggedUser

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

LinkedHashSet<OrderDTO>

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

getOrdersFromLoggedUserByIds

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

OrderDTO

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

getOrder

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

boolean

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

approve

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

PaymentStatus

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

pay

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

String

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

obtain3DSecureLink

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

boolean

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

ship

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

boolean

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

deliver

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

String

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

payout

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

boolean

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

complete

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

boolean

Argument	Type	Description
`orderId`	`String`	Passed through `args[0].0`.
`createInvoice`	`Boolean`	Passed through `args[1].1`.

completeDigitalOrder

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

boolean

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

prepareForShipment

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

boolean

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

cancel

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

boolean

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

refund

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

List<OrderTimeLineBean>

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

getOrderTimeLine

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

boolean

Argument	Type	Description
`orderId`	`String`	Passed through `args[0].0`.
`asVendor`	`boolean`	Passed through `args[1].1`.

isUserParticipatesInOrder

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

OrderTimeLineBean

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

getLastOrderTimelineBean

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

boolean

Argument	Type	Description
`orderId`	`String`	Passed through `args[0].0`.
`attachmentName`	`String`	Passed through `args[1].1`.

removeAttachment

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

boolean

Argument	Type	Description
`orderId`	`String`	Passed through `args[0].0`.
`orderTimelineStep`	`String`	Passed through `args[1].1`.
`attachmentName`	`String`	Passed through `args[2].2`.

removeAttachment

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

Set<Address>

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

getShippingAddresses

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

boolean

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

canCancel

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

boolean

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

canAddAttachment

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

boolean

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

changeAddress

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

boolean

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

changePaymentMethod

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

boolean

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

canChangeStatus

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

boolean

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

mustAddAttachments

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

String

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

getInvoiceTemplate

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

BigDecimal

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

calculateDelivery

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

Order

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

clearPaymentInfo

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

CommerceItem

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

updateCommerceItemMetaInfo

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

​Headers

​Methods

​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

Methods

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