Overview
Functionality
- Account orders
- Calculation
- Channable orders
- Incl. return and attributes
- Delivery
- Incl. countries, options and promises
- Documents
- Orders
- Incl. return / refunds and attributes
- OrdersTags
- Add/delete/get order tags
- Payment
- Payment methods
- Pickup
- Shopping cart
- Incl. promotions
Relevant links
Implementations
Gender mapping
In the cart and order contracts a 'consumerGender' property is available been added. Within this property it is possible to send in the Gender for the customer as a string.
When one of the following values is used, Core-commerce will automatically apply the correct conversion to external systems for gender like a PSP:
- Male
- Female
All other values are handled as 'Unknown' or 'null' depending on the consuming system.
Tagging
Orders can be extended with one or more tags. Tags are different than attributes since they can be used for quick searching (index), are visible in the order list view and can contain the following properties:
| Field | Remark |
|---|---|
| Key | For filtering |
| Value | For filtering |
| DisplayValue | Html allowed Used for visual display in Orders list view and for filtering |
In the Orders list view it is now possible to filter on applied tags on orders.
Endpoints
The following endpoints can be used for managing tags, adding/remove them from an order or to search on orders with tags:
- Tags management: OrderTags
- Add tag to order: Orders_PutTag
- Delete tag from order: Orders_DeleteTag
- Search by tags: Orders_SearchByTags
Reference on order
Orders in Core-commerce use a GUID as identifier for the 'orderId'. This GUID is not readable or easy to share by customers in conversations. Therefore alse an order reference is added on an order. This field is 'auto-incremented' and the default starting value can be determined by the customer and configured by the Core-commerce team.
The reference can be used while searching for an order in the OMS or to get the correct orderId by using the Orders_Get endpoint.
Shipping costs
Core-commerce has the option to handle shipping costs on an order supplied by the integration team. This is especially useful when an external best of breed solution like Sendcloud determines the shipping costs
Shipping costs can be added on the shopping cart (see contract) on the "shippingCosts" property. Core-commerce will then use this in the calculation and also persist the shipping costs on order convert.
SKU
Core-commerce creates a separate line per SKU, this means that when a customer orders a quantity of 2 for one product, this will be stored as two separate lines (both in shopping cart as on orderline level). By doing this, functionality like returns, refunds and promotions can be applied on SKU level, allowing better calculations. For example:
| SKU | Price |
|---|---|
| A | 12.95 |
| A | 12.95 |
| B | 16.50 |
In management modules, like the orders, lines are grouped again to make sure that orders with higher quantities, are still visible. For example:
| Line | Price | Quantity | Total Amount |
|---|---|---|---|
| A | 12.95 | 2 | 25.90 |
| B | 16.50 | 1 | 16.50 |
Tier pricing
When a customer wants to use tier pricing, the shopping cart can be extended with a fixed pricingAttribute "CC-product-quantity". Per shopping cart line the total quantity can be added and this will be sent to the DMS GET /pricing/ call for further calculation.
Updated 6 months ago