Order—this is a customer request for a product or service placed via the website or mobile application.
- Orders—this is an optional feature that is not enabled by default. To activate this functionality, contact Loymax specialists.
- 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.
Unlike a receipt, which records the fact of payment and the list of purchased items, an order contains a broader dataset: customer information, order value, order statuses, detailed fulfillment, payment, and delivery data, as well as order contents. Like receipts, orders are used for building segments for subsequent communications with customers and serve as the basis for analyzing purchasing behavior and generating reports.
Order structure
In addition to standard data typical for receipt entities, orders have the following attributes:
- Statuses—three status types are available for each order. Users can create statuses of the respective types in the section Settings > Order statuses.
- General: includes general stages of the order lifecycle. For example: received, confirmed, in progress, completed.
- Delivery status: includes stages related to order delivery. For example: being assembled, shipped, at pickup point, issued.
- Payment status: includes stages related to order payment. For example: invoice issued, awaiting payment, paid.
- Delivery block
- Delivery status,
- Delivery type: courier, self-pickup, pickup point,
- Provider: shipping carrier handling order delivery,
- Address: country, city, street,
- Date and time,
- Customer comment.
- Payment block
- Payment status,
- Payment type: card, cash, cash on delivery,
- Payment provider: multiple payment providers can be configured,
- Order amount information:
- 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,
- Cash amount.
All the above order attributes can be used for customer communications via mass messaging and marketing campaigns.
| Sample order structure in REST API request | Request parameters |
{
"data": {
"attributes": {
"external_id": "1050",
"client_external_id": "724",
"date": "2020-07-03 17:30:22",
"number": "1218/112",
"items_cnt": 1,
"items_sum": 200.3,
"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",
"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
}
]
}
}
} | - external_id—external order identifier
- client_external_id—external user identifier
- date—order date. If not specified, current date and time are used
- number—order number
- items_cnt—number of products in the order
- items_sum—order value
- status_code—general order status
- unit—point of sale
- actions—offers
- delivery—delivery block:
- status_code—delivery status
- type—delivery type
- provider—delivery provider
- country—delivery country
- city—delivery city
- address—delivery address
- date—delivery date
- time—delivery time
- note—comment
- payment—payment block:
- status_code—payment status
- type—payment method type
- provider—payment provider
- total—total paid
- cash—paid in cash
- bonuses—paid with bonus points
- delivery—delivery cost
- discount—discount amount
- items—order contents:
- external_id—order line identifier in the user's information system
- product_external_id—product identifier
- cnt—product quantity
- sum—order line total
- price—product cost
- quantity—item weight
- discount—discount
- bonus_to_card—bonus points accrued
- bonus_from_card—bonus points deducted
- cash_sum—cash amount
|
Order functionality integration
Order functionality integration is performed by contacting Loymax specialists and includes the following steps:
- Enable the EnableShopEorders feature flag, which activates visibility of tabs and toggles for orders/order lines across various System sections.
- Configure fields to match the Partner's business processes.
- Configure order statuses.
- Testing.
Instructions for working with order functionality can be found in the relevant sections:
| In all reports for mass messaging, campaigns, including the dashboard, as well as consolidated reports in the Analytics section, you can switch between receipts and orders (provided both functionalities are enabled). 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. |
| Similar to receipt attribution, order attribution is available for mass messaging and campaigns. Order attribution—these are rules that link orders to communications sent to the customer. |
| For customizing message text in mass messaging and campaigns, the following template engine macros are supported for order functionality: - Number of customer orders
- Total amount of all customer orders
- Date of customer's first/last order
- Number of customer's first/last order
- Value of attribute in customer's first/last order
- Contents of customer's first/last order
|
| The following API methods are available for working with orders: - Register an order
- Update order status
- Get a list of orders
- Get an order by external identifier
- Get a list of customer orders by customer external identifier
- Link an order to a receipt
- Delete an order
|
| 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. | Example list of order fields | Example list of order line fields |
|
|
It is also possible to manage field display: for orders and order lines, you can change the field set or their sequence in the customer profile. |
| For customer segmentation using order data, the Segment builder provides the following filters: - Customer
- Number of orders
- Number of attributed orders
- Date of first/last order
- Days since first/last order
- Average order amount
- Average number of items per order
- Total order value
- Last order value
- Median order amount
- Average item price in order
- Order
- Last order/delivery/payment status
- Identifier
- Date
- Status
- Number
- Item quantity/value
- Point of sale
- Offers
- Card
- Delivery status/type
- Delivery provider
- Delivery country/city/address
- Delivery date/time
- Delivery comment
- Payment status/type
- Total paid
- Paid in cash/bonus points
- Delivery cost
- Discount amount
- Order contents
- Average item price
- Identifier
- Quantity
- Value
- Price
- Item weight
- Discount
- Bonus points accrued
- Bonus points deducted
- Cash amount
- Interaction
- Ordered via email campaign
- Ordered via SMS campaign
- Ordered via push campaign
- Ordered via campaign
|
| - When order functionality is enabled, a separate orders tab appears in the customer profile, displaying detailed information about all customer orders, including payment, delivery, item quantity, and order value.
- The Activity tab in the customer profile also displays customer order information.
- For orders whose statuses are included in statistics and reports, the following metrics are available in the customer profile:
- Number of orders
- Total order value
- Average order value
- Average number of items per order
|
| Viewing and creating order statuses is available in the Settings > Order statuses section. Three status types are available for orders: - General
- Delivery status
- Payment status
|
| A Trigger—is an event that activates a campaign. The following triggers are available for order functionality: |
| In customer lists within the Segment builder and consolidated reports in the Analytics section, you can export order and order line data to a file. |
