Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implemented: Added application layer services to create a sales order in the system. #7

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Implemented: Added application layer services to create a sales order in the system. #7

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2e85a22
Implemented: Added application layer services to create a sales order…
vyasdevanshu Dec 31, 2024
7aff84b
Fixed: Corrected the file directory structure and minor improvements.
vyasdevanshu Jan 2, 2025
453e1cc
Merge branch 'hotwax:main' into patch-2
vyasdevanshu Jan 9, 2025
354fe95
Improved: Updated the application layer services to create sales order.
vyasdevanshu Jan 14, 2025
79e3af3
Corrected the service name and used fully qualified name of Party entity
vyasdevanshu Jan 15, 2025
44838a8
Improved: Updated the create#SalesOrder service by adding validations…
vyasdevanshu Jan 28, 2025
b36ec01
Improved: Updated the input param name and used the new path of conta…
vyasdevanshu Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 166 additions & 0 deletions service/co/hotwax/order/OrderServices.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://moqui.org/xsd/service-definition-3.xsd">

<service verb="create" noun="SalesOrder">
<description>
This service will take in the order JSON in OMSNewOrdersFeed and set up a complete order by performing any surrounding crud operations as needed.
</description>
<in-parameters>
<parameter name="orderJson" type="Map" required="true"/>
</in-parameters>
<out-parameters>
<parameter name="orderId" required="true"/>
</out-parameters>
<actions>
<!-- TODO: Discuss the return error part -->
<entity-find-one entity-name="org.apache.ofbiz.product.store.ProductStore" value-field="productStore" cache="true">
<field-map field-name="productStoreId" from="orderJson.productStoreId"/>
</entity-find-one>
<if condition="!productStore">
<return error="true" type="warning" message="ProductStore [ID: ${orderJson.productStoreId}] - Not found"/>
</if>

<set field="orderContext" from="[:]"/>
<set field="orderContext.externalId" from="orderJson.externalId"/>
<set field="orderContext.orderTypeId" from="SALES_ORDER"/>
<set field="orderContext.orderName" from="orderJson.name"/>
<set field="orderContext.salesChannelEnumId" from="orderJson.salesChannelEnumId"/>
<set field="orderContext.orderDate" from="orderJson.createdAt"/>
<set field="orderContext.currencyUomId" from="orderJson.currencyUom"/>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have the concept of presentmentCurrencyUomId.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OrderHeader has been extended with presentmentCurrencyUom field and it is being stored in legacy. Default ProductStore currency is stored in OrderHeader.currencyUom field. Same is true for OrderPaymentPreference and it also involves unnecessary UOM conversion. I think we should not use the extended fields and Uom conversion and just store Shopify's presentment amount and currency.

<set field="orderContext.presentmentCurrencyUomId" from="orderJson.presentmentCurrencyUom"/>
<set field="orderContext.grandTotal" from="orderJson.grandTotal"/>
<set field="orderContext.remainingSubTotal" from="orderJson.remainingSubTotal"/>
<set field="orderContext.statusId" from="orderJson.statusId"/>
<set field="orderContext.productStoreId" from="orderJson.productStoreId"/>
<set field="orderContext.adjustments" from="orderJson.adjustments"/>
<set field="orderContext.attributes" from="orderJson.attributes"/>

<set field="orderRoles" from="[]"/>
<entity-find entity-name="Party" list="customerParty" limit="1">
<econdition field-name="externalId" from="orderJson.customer.externalId"/>
</entity-find>
<if condition="customerParty">
<set field="customerPartyId" from="customerParty.partyId"/>
<else>
<service-call name="create#org.apache.ofbiz.party.party.Party" in-map="orderJson.customerMap" out-map="createCustomerOutput"/>
<set field="customerPartyId" from="createCustomerOutput.partyId"/>
</else>
</if>
<set field="nowTimestamp" from="ec.user.nowTimestamp"/>
<script>
orderRoles.add([partyId:customerPartyId, roleTypeId:"SHIP_TO_CUSTOMER", formDate:nowTimestamp])
orderRoles.add([partyId:productStore.payToPartyId, roleTypeId:"SHIP_TO_CUSTOMER", formDate:nowTimestamp])
orderContext.put("roles", orderRoles)
</script>

<set field="orderContactMechs" from="[]"/>
<!-- Shipping Address -->
<service-call name="co.hotwax.oms.order.OrderServices.create#PostalAddress" in-map="[postalAddressJson:orderJson.shipToAddress]" out-map="createPostalAddressOutput"/>
<set field="shipToAddressContactMechId" from="createPostalAddressOutput.contactMechId"/>
<script>
orderContactMechs.add([contactMechId:shipToAddressContactMechId, contactMechPurposeTypeId:"SHIPPING_LOCATION"])
</script>

<!-- Shipping Phone -->
<service-call name="create#org.apache.ofbiz.party.contact.ContactMech" in-map="[contactMechTypeId:'TELECOM_NUMBER', infoString:orderJson.shipToPhone]" out-map="createContactMechOutput"/>
<set field="shipToPhoneContactMechId" from="createContactMechOutput.contactMechId"/>
<script>
orderContactMechs.add([contactMechId:shipToPhoneContactMechId, contactMechPurposeTypeId:"PHONE_SHIPPING"])
</script>

<!-- Order Email -->
<service-call name="create#org.apache.ofbiz.party.contact.ContactMech" in-map="[contactMechTypeId:'EMAIL_ADDRESS', infoString:orderJson.email]" out-map="createContactMechOutput"/>
<script>
orderContactMechs.add([contactMechId:createContactMechOutput.contactMechId, contactMechPurposeTypeId:"ORDER_EMAIL"])
</script>

<!-- Billing Address -->
<if condition="orderJson.billToAddress">
<service-call name="create#org.apache.ofbiz.party.contact.PostalAddress" in-map="orderJson.billToAddress" out-map="createPostalAddressOutput"/>
<script>
orderContactMechs.add([contactMechId:createPostalAddressOutput.contactMechId, contactMechPurposeTypeId:"BILLING_LOCATION"])
</script>
</if>

<!-- Billing Phone -->
<if condition="orderJson.billToPhone">
<service-call name="create#org.apache.ofbiz.party.contact.ContactMech" in-map="[contactMechTypeId:'TELECOM_NUMBER', infoString:orderJson.billToPhone]" out-map="createContactMechOutput"/>
<script>
orderContactMechs.add([contactMechId:createContactMechOutput.contactMechId, contactMechPurposeTypeId:"PHONE_BILLING"])
</script>
</if>
<script>
orderContext.put("contactMechs", orderContactMechs)
</script>

<set field="orderItemShipGroups" from="[]"/>
<iterate list="orderJson.shipGroups" entry="shipGroup">
<iterate list="shipGroup.items" entry="item">
<set field="productSku" from="item.productSku"/>
<service-call name="co.hotwax.oms.order.OrderServices.findOrCreate#Product" in-map="[internalName:productSku]" out-map="findOrCreateProductOutput"/>
<set field="item.productId" from="findOrCreateProductOutput.productId"/>
</iterate>
</iterate>
<!--
Set orderContext.shipGroups = orderJson.shipGroups
8. Call create#org.apache.ofbiz.order.order.OrderHeader for orderContext
-->
<set field="orderContext.shipGroups" from="orderJson.shipGroups"/>
<service-call name="create#org.apache.ofbiz.order.order.OrderHeader" in-map="orderContext" out-map="createOrderHeaderOutput"/>
<set field="orderId" from="createOrderHeaderOutput.orderId"/>
</actions>
</service>

<service verb="create" noun="PostalAddress">
<in-parameters>
<parameter name="postalAddressJson" type="Map" required="true"/>
</in-parameters>
<out-parameters>
<parameter name="contactMechId" required="true"/>
</out-parameters>
<actions>
<service-call name="create#org.apache.ofbiz.party.contact.ContactMech" in-map="[contactMechTypeId:'POSTAL_ADDRESS', postalAddress:postalAddressJson]" out-map="createContactMechOutput"/>
<set field="contactMechId" from="createContactMechOutput.contactMechId"/>
</actions>
</service>

<service verb="findOrCreate" noun="Product">
<description>This service either finds a product by its internal name or creates a new one</description>
<in-parameters>
<parameter name="internalName" required="true"/>
</in-parameters>
<out-parameters>
<parameter name="productId" required="true"/>
</out-parameters>
<actions>
<entity-find entity-name="org.apache.ofbiz.product.product.Product" list="product" limit="1">
<econdition field-name="internalName" from="internalName"/>
</entity-find>
<if condition="product">
<set field="productId" from="product.productId"/>
<else>
<service-call name="create#org.apache.ofbiz.product.product.Product" in-map="[internalName:internalName]" out-map="createProductOutput"/>
<set field="productId" from="createProductOutput.productId"/>
</else>
</if>
</actions>
</service>

</services>