Configuring your Magento Channel
Tailor your Magento integration settings.
At this point in time, if your host name and credentials are valid, you should be able to conduct a small communication test:
- Open your Magento sales channel
- From the API ribbon, choose the Test Channel Communication
CSM will notify you if the test communication was successful or failed. Assuming test was successful you can continue your sales channel configuration. If it failed, please search the knowledgebase for help or contact support.
The General FastTabField | Description | Example Value |
Code |
This is unique code that identifies the Sales Channel. It can be any value you wish, but we recommend naming it something meaningful that describes the Sales Channel. |
MAGENTO_B2C |
Description | This is a text description of the Sales Channel. | Magento Retail Store (B2C) |
Type | Identifies the type of API connection. | Magento |
Enable B2B Feature | Not currently available for Magento |
Order Management FastTab - You may need to click on Show More to the right of the FastTab to view all options
Inventory Location | The Business Central inventory location that supplies this store. Business Central Sales Orders Created for this Sales Channel will specify this inventory location. | MAIN |
SO No. Series | The No. Series that should be used for Sales Order Number when build Business Central Sales Orders for this Sales Channel. | CSM-ORD-SHP |
Channel Dimension | If populated, this Business Central Financial Dimension will be set on all Business Central Sales Orders created from this Sales Channel. Primary Dimension 1. | SALES |
Channel Dimension 2 |
If populated, this Business Central Financial Dimension will be set on all Business Central Sales Orders created from this Sales Channel. Primary Dimension 2. |
|
SO build Codeunit | The Object number of the Codeunit that should create Business Central Sales Orders. By default, this should be 70338209 which is the supplied CSM functionality to build Sales Orders. You can however customize the functionality by creating a new Codeunit and specifying its number here. It is recommended that you keep the default value. | 70338209 |
External Document No. Format |
Enter the syntax you wish to use for assigning external document numbers to orders (such as sales and sales return orders) that are generated from this channel’s CSM orders. You can assign one or more fields from the CSM Order Header table as the source value(s) for external document numbers. Note that while fields such as text and code type fields will be acceptable, others such as options/enumerations, dates, and Booleans, will not. Each field must be entered according to its field (not caption) name and enclosed in < > brackets. For example, if you wanted to use the value from the CSM order’s Order ID field as the external document number on related sales orders, you would enter <Order ID> in this field. Any characters you enter in this field that are not enclosed in < > brackets will be treated as static values. This can be useful if you want to use multiple fields as the basis of an external document number, as you can include something like a hyphen as a delimiter. For example, an entry of <Sales Channel Code>-<Order ID> would indicate that the external document number will be comprised of a CSM order’s sales channel code and order ID, separated by a hyphen. In a scenario where the values that comprise an external document number exceed the character limitations of the field on the sales document, CSM will truncate the value based on the field’s maximum character length. If you leave this field blank, CSM will not assign any external document numbers to orders created for the channel. Note: you may need to choose the Show More action on the Order Management FastTab in order to see this field. |
<Sales Channel Code>- <Order ID> |
Start Processing Date |
It is possible to configure the channel order retrieval automation routine to automatically create an associated Business Central sales order as part of the retrieval activity. If you want to set a cut-off date and time as to when this sales order creation is performed against channel orders, you may do so in this field. Retrieved channel orders that fall before this date will be assigned a status of complete and become ineligible for further activity. Channel orders that fall on or after the channel’s start processing date and time will remain open and corresponding Business Central sales orders will be automatically created as part of the order retrieval process. Leaving this field blank will instruct CSM to create sales orders for all retrieved channel orders. |
|
Payment Behavior |
Indicates how this sales channel processes payments. This will be dependent on the Magento functionality you wish to deploy.
|
Channel |
Payment Method Code |
The Code of the Business Central Payment Method which should be used. If Payment Behavior = Payments, this will be the default value. If Payment Behavior = Channel, this will be the Payment method used on all orders. |
|
Payment Reference NO. Metadata Key | This field can be used to specify the metadata key that identifies an order’s external payment number in an API message’s response. This can be used in scenarios where an eCommerce order’s payment information is retrieved via an integration other than CSM and there is a need to associate the CSM order to the proper payment record in Business Central. If you are not using an integration tool such as Channel Payments Manager to retrieve payment platform information into Business Central, this field can be ignored. | |
Send Shipment Information |
Indicates whether CSM should send shipment information to the Channel. |
True |
Send Shipment When |
If CSM is sending Shipment information, this field tells CSM when to send it. Immediate: When the Shipment is posted Scheduled: Shipment information will be queued and sent by the CSM automation if setup Manual: Shipment information is sent by a user who presses the Send Shipment Information action button on the Channel Order card. |
Immediate |
Exclude G/L Account Line on Shipment |
Enable this field to instruct CSM to exclude any sales lines for G/L accounts when sending an order’s shipment information from Business Central to Magento. This results in CSM sending less data to Magento, which can improve performance. If you are working with CSM listings, this field will also serve as a default setting to indicate whether any channel listings for G/L accounts are set to be skipped when sending shipments. |
True |
Exclude Resource Line on Shipment |
Enable this field to instruct CSM to exclude any sales lines for resources when sending an order’s shipment information from Business Central to Magento. This results in CSM sending less data to Magento, which can improve performance. If you are working with CSM listings, this field will also serve as a default setting to indicate whether any channel listings for resources are set to be skipped when sending shipments. |
True |
Send Invoice Information |
Indicates whether CSM should send invoice information to the Channel. |
True |
Send Invoice When |
If CSM is sending Invoice information, this field tells CSM when to send it. Immediate: When the invoice is posted Scheduled: Invoice information will be queued and sent by the CSM automation if setup Manual: Invoice information is sent by a user who presses the Send Invoice Information action button on the Channel Order card. |
Immediate |
Send Invoice Capture |
If CSM is sending Invoice information, this field tells CSM whether a capture transaction should be sent immediately following the Invoice. For Magento, this is dependent on payment method. If your payment method Behavior is set to payments (recommended), CSM uses the Send Invoice Capture value set for each Payment Method. |
True |
Send Return Order Information |
Not Currently supported by Magento |
|
Send Return Order When |
Not Currently supported by Magento |
|
Send Return Rcpt Information |
Not Currently supported by Magento |
|
Send Return Rcpt Information When |
Not Currently supported by Magento |
|
Send Refund Cr. Memo |
Not Currently supported by Magento |
|
Send Refund Cr. Memo When |
Not Currently supported by Magento |
|
Deny Unbalanced Auto Release |
It is possible to configure the channel order retrieval automation routine to automatically create and release an associated Business Central sales order as part of the retrieval activity. If this option is enabled, it will override the automation routine’s setup if the channel order and sales order have different order total values. CSM will still generate the sales order, but it will not be released. Note: This field has been superseded by CSM’s sales operation rules feature and will be removed as part of a later release. If you want to enforce this process, it is recommended you use the sales operation rules feature, instead. |
|
Deny Unbalance Auto Release |
It is possible to configure the channel order retrieval automation routine to automatically create and post an associated Business Central sales order as part of the retrieval activity. If this option is enabled, it will override the automation routine’s setup if the channel order and sales order have different order total values. CSM will still generate the sales order, but it will not be posted. Note: This field has been superseded by CSM’s sales operation rules feature and will be removed as part of a later release. If you want to enforce this process, it is recommended you use the sales operation rules feature, instead. |
|
Currency Behavior |
Select the method by which you want CSM to assign currencies to sales orders. Customer: CSM will assign the currency that has been assigned to the related Business Central customer record to sales orders created for that customer.Order: CSM will assign the currency from the retrieved channel order to the Business Central sales order. In addition to enabling this setting, you must also map your Magento and Business Central currencies to one another. |
Customer |
Address 2 Behavior |
Select the method by which address 2 values on Business Central sales orders and customers that are created by CSM are populated. By default, Business Central allows for the definition of address and address 2 values for sales orders and customers. However, the CSM orders from which these records are created can retrieve address, address 2, and address 3 values. Due to this discrepancy, it is necessary to indicate how CSM should populate Business Central address 2 fields with retrieved channel data. Combine CSM Address 2 and 3: CSM will combine a CSM order’s address 2 and address 3 values, then assign this combined value as the address 2 for Business Central sales orders and customers.Use CSM Order Address 2: CSM will assign a CSM order’s address 2 value as the address 2 for Business Central sales orders and customers. Use CSM Order Address 3: CSM will assign a CSM order’s address 3 value as the address 2 for Business Central sales orders and customers. |
|
Order Total Discount Allocation |
Select the method by which order discount amounts will be allocated to channel orders. By default, Magento will provide discount information at the line level, meaning that a separate discount amount is calculated for each item included in an order. Using the order total discount allocation functionality, it is possible to instruct CSM as to how these retrieved discounts should be allocated to channel orders, which will in turn affect the way in which discounts are applied to Business Central sales orders that are created from channel orders. Not Applicable: channel discount information will be ignored by CSMOrder Level: channel discount information will be applied at the order level. Retrieved line discount amounts will be rolled up into a single document level invoice Line Level: channel discount information will be applied at the order line level. Retrieved line discount amounts will be assigned to the corresponding channel order lines. |
|
Archive After Days |
Enter the number of days to retain completed and cancelled CSM Channel Orders before they are moved to the archive. (Example: 2D would keep CSM Channel Orders in the current list for 2 days after being closed or cancelled.) |
30D |
Auto Channel Order Archive |
Use this field to enable and disable automatic archiving for Channel Orders for this Channel. |
|
Gift Wrap Behavior |
This setting tells CSM how it should handle Gift Wrap Charges on orders received from the Channel. If you select None, Gift Wrap Charges will be ignored. Use this setting if your Magento implementation does not include Gift wrap services. If you select Line, then when CSM creates the Business Central Sales Order for a Magento Order, a Sales Order Line will be added to account for Gift Wrap charge. |
None |
Gift Wrap Line Type |
If you choose Line as the Gift Wrap Behavior from above, this field specifies the Sales Order Line Type which should be used for the Gift Wrap Charge (Revenue from the Customer). The values can be G/L Account, Item, Resource, or Charge (Item). |
|
Gift Wrap Order Line No. |
If you choose Line as the Gift Wrap Behavior, this field specifies the Sales Order Line No. to be used (a value based on the Gift Wrap Line Type chosen). |
|
Other Charges Behavior |
This setting tells CSM how it should handle Other Charges on orders received from the Channel. If you select None, Other Charges will be ignored. If you select Line, a Sales Order Line will be added to account for Other Charges. |
Line |
Other Charges Line Type |
If you choose Line as the Other Charges Behavior, this field specifies the Sales Order Line Type which should be used for the Other Charges (Revenue from the Customer). The values can be G/L Account, Item, Resource, or Charge (Item). |
G/L Account |
Other Charges Order Line No. |
If you choose Line as the Other Charges Behavior, this field specifies the Sales Order Line No. to be used (a value based on the Other Charges Line Type chosen). |
45120 |
Sales Tax Behavior |
Select the manner in which sales tax will be entered on Business Central sales orders that are created from retrieved Magento orders. None: CSM will build sales orders according to Business Central’s standard sales tax behavior. The Tax Liable field on sales lines will be set to True, and tax will be calculated on those lines based on Business Central setup. Any sales tax information retrieved from Magento will be ignored as part of this process. Line: CSM will enter a separate line on sales orders for each item’s sales tax that was collected and retrieved from Magento . With this configuration, the Tax Liable field on sales lines will be set to False so that Business Central does not attempt to calculate tax values. In addition to entering separate lines for each item’s retrieved sales tax amount, CSM will also add a separate line for any tax that was collected on order-level charges such as shipping or gift wrap. Consolidated: CSM will enter a single line on sales orders for the total tax amount that was collected and retrieved from Magento. With this configuration, the Tax Liable field on sales lines will be set to False so that Business Central does not attempt to calculate tax values. The consolidated sales tax line includes both the tax for each item as well as any tax that was collected on order-level charges such as shipping or gift wrap. |
Line |
Sales Tax Line Type |
If you selected either the Line or Consolidated option in the Sales Tax Behavior field, choose the type of sales line you want to enter on sales orders for retrieved sales tax amounts. Standard Business Central sales line options are available: G/L accounts, items, resources, fixed assets, item charges, or allocation accounts. |
G/L Account |
Sales Tax Order Line No. |
Assign the Business Central record that will be added to sales lines for retrieved sales tax. The record you can assign is dependent on the selected sales tax line type. For example, if the sale channel’s sales tax line type was G/L account, you would assign a G/L account in this field. |
|
Use Item Sales UOM |
When selected and Item record is used to create a Sales Line, the Items Sales Unit of Measure will be utilized instead of the Base Unit of Measure. (This does not apply when Listings, Cross-References or Item Identifiers are utilized to create the Sales Line.) |
|
Customers FastTab
Field | Description | Example Value |
Customer Template | When Creating customers, CSM will use this customer as a template for the customer’s creation. When Sales Channel is chosen as a behavior or New Customers or Guest Customers, CSM will create the Sales Order with this customer and adjust the ship to address to the actual customers information. | CSMTEMPLATE |
New Customer Behavior |
Indicates how CSM will treat customers for what CSM determines is a new customer. A new customer from Magento could be any customer creating a new account when checking out, or an existing customer that has not previously been mapped to a Business Central Customer. Auto Create: CSM will automatically create a new Business Central customer and associated CSM Channel Customer based on the Customer Template defined above, this will occur when CSM builds the Business Central Sales Order from the Channel Order. Sales Channel: CSM will not create a new customer but will build the sales order to the Customer Template customer defined above and change the billing and ship-to addresses directly on the Sales Order appropriately. Manual: CSM will not automatically create a customer, and the Sales Order build process will fail unless a Channel Customer is manually setup and linked to a valid Business Central customer. |
Auto Create |
Guest Customer Behavior |
Indicates how CSM will treat customers for what CSM determines is a guest customer. For Magento if the customer checks out as a guest CSM considers them a guest customer. Auto Create: CSM will automatically create a new Business Central customer and associated CSM Channel Customer based on the Customer Template defined above, this will occur when CSM builds the Business Central Sales Order from the Channel Order. Even though they checked out as a guest, CSM can still identify the customer if they use the same email address for future orders the customer may place. Sales Channel: CSM will not create a new customer but will build the sales order to the Customer Template customer defined above and change the billing and ship-to addresses directly on the Sales Order appropriately. Manual: CSM will not automatically create a customer, and the Sales Order build process will fail unless a Channel Customer is manually setup and linked to a valid Business Central customer. |
Auto Create |
Auto Create Contact | Indicates whether CSM will also automatically create a Business Central contact for any new customers CSM creates. | True |
Default Customer Group ID. | Indicates which Magento Customer Group ID will be assigned to new customers sent to Magento. This ID will only be used if a relationship between the BC customer price group the BC customer is assigned to and Magento Customer groups does not exist in the CSM Price Group table. Normally the Magento General customer group has an ID of 1. | 1 |
New Customer No. Series | Indicates which No. Series should be used when CSM automatically creates a new Business Central customer. | CSM-CUST |
Listing Management FastTab
Only used if you are subscribed to the Listing Management module. Please refer to Listing Management Setup.
API Data FastTab
AP Logging Level | Fence used to determine what should be logged | |
Import Object Name |
The Import Object used for special file imports. Only used in custom situations. | |
Credentialing Sales Channel | The Credentialing or Parent Sales Channel if needed. This may be this Sales Channel. Meant for situations where an API Function can bring in data for multiple sales channels, but the settings / credentials are the same for all. | |
Store ID |
Enter the Magento store ID that is represented by the sales channel. If you have multiple Magento stores that you want to integrate with Business Central, you must set up a separate sales channel for each one. |
1 |
Store Code | It is possible to set up unique store codes for each Magento store. These codes are appended to a store’s URL. If the sales channel is associated to a Magento store with a defined code, you can enter it here. | |
API Store Code |
Identifies the API Set code that should be used for API communication with Magento. This should be the value that you used to setup the Magento API Set in the CSM API Sets section earlier in this document. | MAGENTO |
Website ID |
Enter the website ID for the Magento store that is associated to the sales channel. A website ID is unique from the store ID in that the latter identifies the Magento store itself, while the former identifies that store’s website. |
1 |
API Engine Execution |
This field contains the module code that indicates which CSM API operations will be used for Magento sales channels. The CSM API application contains a number of operations for various API activities. Each operation can be enabled for one or more modules. This architecture is supported by the refactored CSM Core and must be populated if you want to use the standalone API Engine to communicate with Magento. Should populate from the wizard. |
MAGENTO |
CSM API Set Code |
Identifies the API Set code that should be used for API communication with Magento. Should populate from the wizard. |
MAGENTO2 |
API User ID |
Certain API calls are made against specific sales channel records. CSM will use the user ID and password that are assigned to a specific store when calls are made against that store. In scenarios where the same user ID and password apply to multiple stores, the credentialing sales channel functionality can be used. |
|
API User Password | For API calls where the URL is store specific, this is the User ID portion of the credentials for the API Call. |