OrderServiceImpl - MastermindCMS Documentation

string

Die Spring-Bean-ID des aufzurufenden Services.orderServiceImpl

string

Standard:"PROTOTYPE"

Bean-Scope. Für Serviceaufrufe wird PROTOTYPE verwendet.

string

Der öffentliche Methodenname des Services, der in der Signatur angegeben ist.

object[]

Das Argument-Array der Methode. Jedes Argument wird mit dem Index 0, 1 usw. übergeben; der Wert muss dem Java-Parametertyp entsprechen.

Headers

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

Senden Sie Lang-Context und Site-Context mit jeder Anfrage. Für geschützte Methoden senden Sie das JWT im Header Authorization im Format Bearer <token>. Zugriff: ADMIN. Bearer Token: bedingt für USER/ADMIN.

GUEST — nicht angemeldete Benutzer; nur Whitelist-Services sind verfügbar.
USER — Authentifizierung erforderlich; Methoden mit USER-Prüfung sind verfügbar.
ADMIN — vollständiger Zugriff auf öffentliche Methoden aller Services.
Wenn eine Methode intern eine Rolle prüft, kann GUEST null erhalten.

Methoden

void

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

handleNotify

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

OrderRepository

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getRepository

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

String

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

activeLogisticsProvider

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

String

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

activePaymentProvider

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

CommerceItemRepository

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getCommerceItemRepository

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

Deque<Map<String, Object>>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

getPaginationFilter

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

LinkedHashSet<OrderDTO>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

getOrders

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

Page<Order>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

getOrdersPaged

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

Optional<Order>

Argument	Typ	Beschreibung
`orderAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createOrder

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
`orderAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

saveOrder

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

orderCheckout

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

Order

Argument	Typ	Beschreibung
`paymentRequestAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

digitalOrderCheckout

Beispiel für das JSON-Anfrageobjekt:

{
    "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	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

createInvoiceBuyerToVendor

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

void

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

removeOrder

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

void

Argument	Typ	Beschreibung
`orderIds`	`ArrayList<String>`	Übergeben über `args[0].0`.

removeOrdersByIds

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`commerceItemId`	`String`	Übergeben über `args[1].1`.

removeCommerceItemFromOrder

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

List<OrderDTO>

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getOrdersFromLoggedUser

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

LinkedHashSet<OrderDTO>

Argument	Typ	Beschreibung
`orderIds`	`ArrayList<String>`	Übergeben über `args[0].0`.

getOrdersFromLoggedUserByIds

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

OrderDTO

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

getOrder

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

approve

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

PaymentStatus

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

pay

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

String

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

obtain3DSecureLink

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

ship

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

deliver

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

String

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

payout

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

complete

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`createInvoice`	`Boolean`	Übergeben über `args[1].1`.

completeDigitalOrder

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

prepareForShipment

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

cancel

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

refund

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

List<OrderTimeLineBean>

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

getOrderTimeLine

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`asVendor`	`boolean`	Übergeben über `args[1].1`.

isUserParticipatesInOrder

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

OrderTimeLineBean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

getLastOrderTimelineBean

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`attachmentName`	`String`	Übergeben über `args[1].1`.

removeAttachment

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`orderTimelineStep`	`String`	Übergeben über `args[1].1`.
`attachmentName`	`String`	Übergeben über `args[2].2`.

removeAttachment

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

Set<Address>

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getShippingAddresses

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

canCancel

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

canAddAttachment

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`params`	`LinkedHashMap<String, Object>`	Übergeben über `args[1].1`.

changeAddress

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.
`paymentMethod`	`LinkedHashMap<String, Object>`	Übergeben über `args[1].1`.

changePaymentMethod

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

canChangeStatus

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

boolean

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

mustAddAttachments

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

String

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

getInvoiceTemplate

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

BigDecimal

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

calculateDelivery

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

Order

Argument	Typ	Beschreibung
`orderId`	`String`	Übergeben über `args[0].0`.

clearPaymentInfo

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

CommerceItem

Argument	Typ	Beschreibung
`commerceItemId`	`String`	Übergeben über `args[0].0`.
`metaInfo`	`LinkedHashMap<String, Object>`	Übergeben über `args[1].1`.

updateCommerceItemMetaInfo

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

​Headers

​Methoden

​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

Methoden

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