Orders - Loymax

* Visibility of orders/order lines in various System sections is controlled by a feature flag. When the flag is enabled, the corresponding tabs and functional capabilities become available.

15

)))

16

17

Unlike a [[receipt>>doc:Main.Smart_Communications.SMC_Use.Customers.All_clients.WebHome||anchor="HReceipts"]], which records the fact of payment and the list of purchased items, an [[order>>doc:Main.Smart_Communications.SMC_Use.Customers.All_clients.WebHome||anchor="HOrders"]] contains a broader dataset: customer information, order value, order statuses, fulfillment details, payment, and delivery data, as well as order contents. Like receipts, orders are used for building segments for subsequent [[communications>>doc:Main.Usage.Smart_Communications.Mass_messaging.WebHome]] with customers and serve as the basis for analyzing purchasing behavior and generating [[reports>>doc:Main.Usage.Smart_Communications.Mass_messaging.Mailing_report.WebHome]].

18

19

=== Order structure {{id name="Structure"/}} ===

20

21

In addition to standard data typical for receipt entities, orders have the following attributes:

22

23

* **Statuses**—three status types are available for each order. Users can create statuses of the respective types in the section [[Settings ~> Order statuses>>doc:Main.Usage.Smart_Communications.Settings_SC.Order_statuses.WebHome]].

24

** **General**: includes general stages of the order lifecycle. For example: received, confirmed, in progress, completed.

25

** **Delivery**: includes stages related to order delivery. For example: being assembled, shipped, at pickup point, delivered.

26

** **Payment**: includes stages related to order payment. For example: invoice issued, awaiting payment, paid.

27

* **Delivery block**

28

** Delivery status,

29

** Delivery type: courier, self-pickup, pickup point,

30

** Provider: shipping carrier handling order delivery,

31

** Address: country, city, street,

** Date and time,

** Customer note.

* **Payment block**

** Payment status,

** Payment type: card, cash, cash on delivery,

37

** Payment provider: multiple payment providers can be configured,

38

** Order amount information:

39

*** Total order amount,

*** Cash payment,

*** Bonus payment,

*** Delivery cost,

*** Discount.

* **Order contents block**

** Number of items,

** Item cost,

** Order line total,

** Item weight,

** Discount amount,

** Bonus accrual and deduction,

51

** Cash amount.

52

53

All the above order attributes can be used for customer communications via [[mass messagings>>doc:Main.Usage.Smart_Communications.Mass_messaging.WebHome]] and marketing [[campaigns>>doc:Main.Smart_Communications.SMC_Use.Campaigns.WebHome]].

54

55

{{showhide showmessage="Show sample order structure in REST API request" hidemessage="Hide sample order structure"}}

56

(% class="table-bordered" %)

57

(% class="info" %)|(% style="width:870px" %)**Sample order structure in REST API request**|(% style="width:781px" %)**Request parameters**

58

|(% style="width:870px" %)(((

{

"data": {

"attributes": {

"external_id": "1050",

64

"client_external_id": "724",

65

"date": "2020-07-03 17:30:22",

66

"number": "1218/112",

67

"items_cnt": 1,

68

"items_sum": 200.3,

69

"status_code": "new",

"unit": "",

"actions": "",

"delivery": {

"status_code": "delivered",

"type": "",

"provider": "",

"country": "",

"city": "",

"address": "",

"date": "",

"time": "",

"note": ""

},

"payment": {

"status_code": "paid",

"type": "",

"provider": "",

"total": 200.3,

"cash": 190,

"bonuses": 15,

"delivery": 20,

"discount": 24.87

},

"items": [

{

"external_id": "577",

96

"product_external_id": "789",

"cnt": 1,

"sum": 120,

"price": 120,

"quantity": 0,

"discount": 0,

"bonus_to_card": 0,

"bonus_from_card": 0,

"cash_sum": 0

}

]

}

}

}

)))|(% style="width:781px" %)(((

112

* **external_id**—external order identifier

113

* **client_external_id**—external user identifier

114

* **date**—order date. If not specified, current date and time are used

115

* **number**—order number

116

* **items_cnt**—number of products in the order

117

* **items_sum**—order value

118

* **status_code**—general order status

119

* **unit**—point of sale

120

* **actions**—offers

121

* **delivery**—delivery block:

122

** status_code—delivery status

123

** type—delivery type

124

** provider—delivery provider

125

** country—delivery country

126

** city—delivery city

127

** address—delivery address

128

** date—delivery date

129

** time—delivery time

130

** note—customer note

131

* **payment**—payment block:

132

** status_code—payment status

133

** type—payment method type

134

** provider—payment provider

135

** total—total paid

136

** cash—paid in cash

137

** bonuses—paid with bonus points

138

** delivery—delivery cost

139

** discount—discount amount

140

* **items**—order contents:

141

** external_id—order line identifier in the user's information system

142

** product_external_id—product identifier

143

** cnt—product quantity

144

** sum—order line total

145

** price—product cost

146

** quantity—item weight

147

** discount—discount

148

** bonus_to_card—bonus points accrued

149

** bonus_from_card—bonus points deducted

150

** cash_sum—cash amount

)))

=== Order functionality integration {{id name="Integration"/}} ===

155

156

Order functionality integration is performed by contacting Loymax specialists and includes the following steps:

157

158

1. Enable the **EnableShopEorders** feature flag, which activates visibility of tabs and toggles for orders/order lines across various System sections.

159

1. Configure [[fields>>doc:Main.Usage.Smart_Communications.Settings_SC.Data_field.WebHome]] to match the Partner's business processes.

160

1. Configure [[order statuses>>doc:Main.Usage.Smart_Communications.Settings_SC.Order_statuses.WebHome]].

161

1. Testing.

162

163

==== Instructions for working with order functionality can be found in the relevant sections: {{id name="Instructions"/}} ====

164

165

(% class="table-bordered" %)

166

|(% style="width:423px" %)(((

167

(% class="lead" %)

168

Analytics and reports

169

)))|(% style="width:1019px" %)(((

170

You can switch between receipts and orders (provided both functionalities are enabled) in all reports for [[mass messagings>>doc:Main.Usage.Smart_Communications.Mass_messaging.Mailing_report.WebHome]] and [[campaigns>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Report.WebHome]], including the [[dashboard>>doc:Main.Smart_Communications.SMC_Use.Overview.WebHome]], as well as consolidated reports in the **Analytics** section.

171

172

(% class="box infomessage" %)

173

(((

174

Reports include only orders with statuses marked with the **Include in analytics** flag during creation/editing. Order statuses can be created in the section [[Settings ~> Order statuses>>doc:Main.Usage.Smart_Communications.Settings_SC.Order_statuses.WebHome]].

175

)))

176

)))

177

|(% style="width:423px" %)(((

178

(% class="lead" %)

179

Attribution

180

)))|(% style="width:1019px" %)(((

181

**Attribution** is a configurable criterion that links orders to communications sent to the customer.

182

183

Similar to [[receipt attribution>>doc:Main.Usage.Smart_Communications.Receipt_attribution.WebHome]], order attribution is available for [[mass messagings>>doc:Main.Usage.Smart_Communications.Mass_messaging.WebHome]] and [[campaigns>>doc:Main.Smart_Communications.SMC_Use.Campaigns.WebHome]].

184

)))

185

|(% style="width:423px" %)(((

186

(% class="lead" %)

187

[[Template engine macros>>doc:Main.Usage.Smart_Communications.Mass_messaging.Template_engine.WebHome||anchor="HSystemVariables"]]

188

)))|(% style="width:1019px" %)(((

189

For customizing message text in [[mass messagings>>doc:Main.Usage.Smart_Communications.Mass_messaging.Template_engine.WebHome]] and [[campaigns>>doc:Main.Smart_Communications.SMC_Use.Campaigns.WebHome]], the following template engine macros are supported for order functionality:

190

191

* Customer orders count

192

* Total amount of all customer orders

193

* Date of customer's first/last order

194

* Number of customer's first/last order

195

* Value of attribute in customer's first/last order

196

* Contents of customer's first/last order

197

)))

198

|(% style="width:423px" %)(((

199

(% class="lead" %)

200

API methods for working with orders

201

)))|(% style="width:1019px" %)(((

202

The following API methods are available for working with orders:

203

204

* Register an order

205

* Update order status

206

* Get a list of orders

207

* Get an order by external identifier

208

* Get a list of customer orders by customer external identifier

209

* Link an order to a receipt

210

* Delete an order

211

)))

212

|(% style="width:423px" %)(((

213

(% class="lead" %)

214

[[Fields>>doc:Main.Usage.Smart_Communications.Settings_SC.Data_field.WebHome]]

215

)))|(% style="width:1019px" %)(((

216

The fields configuration section allows managing the set of fields for orders and order lines. System fields are present by default. Users can also create custom fields for orders and order lines, which can be deleted or edited.

217

218

(% class="table-bordered" %)

219

(% class="info" %)|(% style="width:647px" %)**Example list of order fields**|(% style="width:686px" %)**Example list of order line fields**

220

|(% style="width:647px" %){{lightbox image="order_fields.png" width="700"/}}|(% style="width:686px" %){{lightbox image="order_item_fields.png" width="700"/}}

221

222

It is also possible to [[manage field display>>doc:Main.Usage.Smart_Communications.Settings_SC.Data_field.Views_management.WebHome]]: for orders and order lines, you can change which fields are displayed in the [[customer profile>>doc:Main.Smart_Communications.SMC_Use.Customers.All_clients.WebHome||anchor="HCustomerprofile"]] and in what order.

223

)))

224

|(% style="width:423px" %)(((

225

(% class="lead" %)

226

[[Segment builder>>doc:Main.Smart_Communications.SMC_Use.Customers.User_segments.Segment_builder.WebHome]]

227

)))|(% style="width:1019px" %)(((

228

For customer segmentation using order data, the **Segment builder** provides the following filters:

* **Customer**

** Number of orders

** Number of attributed orders

233

** Date of first/last order

234

** Days since first/last order

235

** Average order amount

236

** Average number of items per order

237

** Total order value

238

** Last order value

239

** Median order amount

240

** Average item price in order

241

* **Order**

242

** Last order/delivery/payment status

** Identifier

** Date

** Status

** Number

** Item quantity/value

** Point of sale

** Offers

** Card

** Delivery status/type

252

** Delivery provider

253

** Delivery country/city/address

254

** Delivery date/time

255

** Delivery comment

256

** Payment status/type

257

** Total paid

258

** Paid in cash/bonus points

** Delivery cost

** Discount amount

* **Order contents**

** Average item price

** Identifier

** Quantity

** Value

** Price

** Item weight

** Discount

** Bonus points accrued

270

** Bonus points deducted

271

** Cash amount

272

* **Interaction**

273

** Ordered via email campaign

274

** Ordered via SMS campaign

275

** Ordered via push campaign

276

** Ordered via campaign

277

)))

278

|(% style="width:423px" %)(((

279

(% class="lead" %)

280

[[Customer profile>>doc:Main.Smart_Communications.SMC_Use.Customers.All_clients.WebHome||anchor="HCustomerprofile"]]

281

)))|(% style="width:1019px" %)(((

282

* When order functionality is enabled, a separate [[orders>>doc:Main.Smart_Communications.SMC_Use.Customers.All_clients.WebHome||anchor="HOrders"]] tab appears in the customer profile, displaying detailed information about all customer orders, including payment, delivery, item quantity, and order value.

283

* The [[Activity>>doc:Main.Smart_Communications.SMC_Use.Customers.All_clients.WebHome||anchor="HActivity"]] tab in the customer profile also displays customer order information.

284

* For orders whose statuses are included in statistics and [[reports>>doc:Main.Usage.Smart_Communications.Mass_messaging.Mailing_report.WebHome]], the following [[metrics>>doc:Main.Smart_Communications.SMC_Use.Customers.User_segments.Segment_builder.Metrics.WebHome]] are available in the customer profile:

285

** Number of orders

286

** Total order value

287

** Average order value

288

** Average number of items per order

289

)))

290

|(% style="width:423px" %)(((

291

(% class="lead" %)

292

[[Order statuses>>doc:Main.Usage.Smart_Communications.Settings_SC.Order_statuses.WebHome]]

293

)))|(% style="width:1019px" %)(((

294

Viewing and creating order statuses is available in the [[Settings>>doc:Main.Usage.Smart_Communications.Settings_SC.WebHome]] > **Order statuses** section. Three status types are available for orders:

* General

* Delivery

* Payment

)))

|(% style="width:423px" %)(((

301

(% class="lead" %)

302

[[Triggers>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome]] for orders

303

)))|(% style="width:1019px" %)(((

304

A **Trigger **is an event that activates a [[campaign>>doc:Main.Smart_Communications.SMC_Use.Campaigns.WebHome]]. The following triggers are available for order functionality:

305

306

* [[Days since order>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome||anchor="HDayssinceorder"]]

307

* [[Item ordered>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome||anchor="HItemordered"]]

308

* [[Item from category ordered>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome||anchor="HItemfromspecificcategoryordered"]]

309

* [[Order status changed>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome||anchor="HOrderstatuschanged"]]

310

* [[Date come for order>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome||anchor="HDatecomefororder"]]

311

* [[Order created>>doc:Main.Smart_Communications.SMC_Use.Campaigns.Triggers.WebHome||anchor="HOrdercreated"]]

312

)))

313

|(% style="width:423px" %)(((

314

(% class="lead" %)

315

[[Export>>doc:Main.Smart_Communications.SMC_Use.Customers.User_segments.Segment_builder.WebHome||anchor="02"]]

316

)))|(% style="width:1019px" %)(((

317

In customer lists within the [[Segment builder>>doc:Main.Smart_Communications.SMC_Use.Customers.User_segments.Segment_builder.WebHome]] and consolidated reports in the **Analytics** section, you can export order and order line data to a file.

318

)))

Navigation

Wiki source code of Orders