Skip to content
  • There are no suggestions because the search field is empty.

Shopify Definitions and Mapping

CSM Cross Reference

Shopify uses a standardized format for addresses and expects to receive both a code and full name for each country and state/province from Business Central.  If the countries and state/provinces assigned to your customers and contacts in Business Central are not the same as the corresponding values in Shopify, it is necessary to map them in the cross-reference table.

  • Open your Shopify sales channel
  • From the Related ribbon select Setup then choose CSM Cross References
  • You will need manually add mappings by selecting a new line 
    • API Set Code: select the API being used for your Shopify channel
    • Sales Channel Code: select your Shopify sales channel
    • Type: for country cross references, enter COUNTRY; for state/province cross references, enter STATE_PROV
    • Code: enter the Shopify value for the cross reference you want to map
    • Value: enter the Business Central value for that specific cross reference
    • Value 2: enter the description of the code you entered
  • Repeat as needed

CSM Shipping Methods

CSM shipping methods correspond to “delivery method” records in Shopify. Shopify uses this record type to represent general delivery scenarios, such as free shipping and flat rate shipping. 

It is recommended that you use CSM shipping methods to link your Business Central shipping agent codes and your Shopify delivery methods. When shipping information is sent between your Business Central and Shopify environments, this association will ensure that the proper order information is maintained in both platforms. You can automatically load new CSM shipping method records that are based on Shopify's default records:

  • Open your Shopify Sales Channel
  • From the Related ribbon, select the Setup then choose the Shipping Methods
  • In the CSM Shipping Methods window, from the Actions ribbon, choose Retrieve Shipping Methods

    Note: the functionality to load CSM shipping methods does not extend beyond the default methods that are supported by Shopify.

    • In the Shipping Agent Code field, assign a Business Central shipping agent code to the shipping method. You must assign a shipping agent code to each shipping method.
    • In the Shipping Agent Service Code field, assign one of the assigned shipping agent’s services to the shipping method. This step is optional.
    • It is possible to add a line for shipping charges to sales orders on which a shipping method is assigned, allowing you to post these charges to a dedicated account in Business Central:
      • If you want to post a shipping method’s shipping charges to a Business Central account, leave the Shipping Order Behavior field set to Default, then use the Shipping Order Charge Type and Shipping Order Change No. fields to identify the account to which charges will be recorded.
      • If you do not want to post a shipping method’s shipping charges to a Business Central account, change the value in the Shipping Order Behavior field to Skip, then leave the Shipping Order Charge Type and Shipping Order Change No. fields blank.

        CSM Payment Methods

        CSM Payment Methods correspond to 'Payment Methods' in Shopify.  Shopify uses this record type to represent specific payment processes such as Stripe and PayPal. 

        It is recommended that you use CSM payment methods to link your Business Central payment methods and your Shopify payment methods. When payment information is sent between your Business Central and Shopify environments, this association will ensure that the proper order information is maintained in both platforms. You can automatically load new CSM payment method records that are based on Shopify's default records.

        • Open your Shopify Sales Channel 
        • From the Related ribbon, select the Setup then choose the Payment Methods
        • In the CSM Payment Methods window, from the Actions ribbon, choose Retrieve Payment Methods
        • Make any necessary adjustments to the assigned values in the Payment Method Code For example, if you wish to link multiple Shopify payment methods to the same Business Central payment method, you can manually make this change.

        Depending on the payment method type, a balancing account may need to be present. Payment methods that represent credit card transactions should have a balancing account so that Business Central can automatically post and apply the payment entry in the customer’s ledger when the sales order is invoiced. For other payment method types such as check or on account, a blank balancing account will typically make more sense.

        • If you need to assign a balancing account to a payment method, there are two options available to you:
          • You can assign a balancing account to the Business Central payment method code that is linked to the CSM payment method.
          • If you do not wish to assign a balancing account to your Business Central payment method, you can instead define one for the CSM payment method by using the Account Type and Bal. Account No. fields on the CSM payment method line.

        When CSM posts a payment, it will first look to the CSM payment method line to see if a balancing account has been defined and use that. If it does not find a balancing account for the CSM payment method, it will check the linked Business Central payment method and use the balancing account that has been assigned to it.

        • To provide additional instructions as to how CSM should process orders to which a given payment method is assigned, fill in the fields as follows:
          • Automatic Application: enter a check mark in this field to instruct CSM to automatically apply payments that are recorded for the payment method to the associated Business Central sales invoice or credit
          • Single Capture: enter a check mark in this field to instruct CSM to permit only a single payment capture activity against this payment method.

        Note: Shopify does not permit multiple credit card payments for a given transaction. When you are defining a CSM payment method that is mapped to shopify_payments, the Single Capture field should be enabled.

        • Perform Invoice Capture: enter a check mark in this field to instruct CSM to automatically perform and send a capture transaction (such as a credit card settlement) to the external channel following the transmission of invoice activities recorded for the payment method.
        • Perform Capture for Zero Amt: enter a check mark in this field to instruct CSM to automatically perform and send a capture transaction to the external channel following the transmission of invoice activity when an invoice amount is zero recorded for the payment method.

        CSM Shipping Carriers

        CSM shipping carriers correspond to “shipping carrier” records in Shopify.

        It is recommended that you use CSM shipping carriers to link your Business Central shipping agent codes and your Shopify shipping carriers. When shipping information is sent between your Business Central and Shopify environments, this association will ensure that the proper order information is maintained in both platforms. You can automatically load new CSM shipping carrier records that are based on Shopify's default records:

        • Open your Shopify sales channel 
        • From the Related ribbon, select Setup then choose the Shipping Carriers
        • In the CSM Shipping Carriers window, choose the Actions ribbon, then choose the Retrieve Shipping Carriers

          CSM creates new CSM shipping carrier records based on the default carriers that are supported by Shopify. If CSM is able to identify a Business Central shipping agent code that is identical to a CSM shipping carrier record’s external ID, it will automatically link these records by assigning the value in the Shipping Agent Code field. If CSM cannot identify a shipping agent code that matches a CSM shipping carrier’s external ID, a new shipping agent code will be created and assigned to the CSM shipping carrier line.

          Note: the functionality to load CSM shipping carriers does not extend beyond the default carriers that are supported by Shopify.

          CSM Tax Groups

          CSM Tax Groups are used by Listing Management and will be described in the Listing Management documentation.

          CSM Price Groups

          CSM Tax Groups are used by Listing Management and will be described in the Listing Management documentation.

          Gift Cards

          It is possible to retrieve and issue Shopify gift cards from a CSM sales channel in Business Central.

          • Open your Shopify sales channel
          • From the Related ribbon choose Gift Cards.
          • This will open a page that presents any gift cards that have been issued for the channel. Information about each gift card is presented on each line, including the gift card’s unique ID, starting and remaining balance, and dates of expiration or disablement. Filter options at the top of the page allow you to include or exclude zero balance, expired, and disabled gift cards from the list.

          To retrieve active gift cards from your Shopify platform

          • From the Actions ribbon choose Retrieves Active Gift Cards
          • CSM will retrieve all active gift cards from Shopify. Subsequent updates to gift cards will be communicated through CSM’s automation routines.

          You can also issue new gift cards directly from the Gift Cards page in Business Central:

          • Choose the Issue Gift Card action in the ribbon
          • In the General FastTab on the Gift Card page, specify the initial amount, expiration date, and, if desired, any additional notes regarding the gift card.
          • If you have defined gift card posting accounts for the Shopify sales channel, the Post to GL field on the Posting FastTab will be automatically It is recommended that this stay enabled, but you can manually disable it, if necessary.
          • Choose the OK button to close the confirmation message

          Multiple Currencies

          If you configured your sales channel to assign currencies from retrieved orders to the related sales orders in Business Central, you must map the currency codes from your Shopify channel to corresponding records in Business Central. When an order is retrieved from Shopify, CSM will review the currency on that order and assign a Business Central currency code to the related sales order based on this channel mapping.

          To define currencies for your sales channel:

          • Open your Shopify sales channel 
          • From the Related ribbon, select Setup then choose Currencies
          • In the Currencies window, enter a Shopify currency code in the Sales Channel Currency Code field
          • Enter a Business Central currency in the Currency Code field 
          • Repeat this process for additional currencies

          Note: Be sure the Allow Multi-Currency field is enabled on the main Shopify sales channel windows.  This is under the Order Management FastTab.

          Order Matrix Setup

          When an order is retrieved into Business Central, CSM assigns an order status to it. This order status can be used in different ways. For example, routines may be developed to automatically take action against orders that have a particular status.

          There are a number of different factors that can influence an order’s status, with different combinations of these factors resulting in potentially different status settings. To support these combinations, each CSM sales channel contains an “order status matrix.” This matrix allows you to assign an “implied order status” to each combination of values that constitute a unique status.

          You can view a sale channel’s order status matrix from the CSM Sales Channel card by choosing the Related ribbon, then selecting the Setup menu and choosing the Order Status Matrix action. The order status matrix screen contains lines for unique combinations of the following values:

          • Channel Status: this is the status that has been assigned to the order on the external channel. Because every channel has its unique status definitions, these values will change from channel to channel.
          • BC Order Status: this is the status that has been assigned to a channel order’s corresponding Business Central sales order. Standard Business Central sales order status values such as Open and Released are available for selection, as well as a No Order value to indicate a retrieved channel order that does not have a corresponding sales order.
          • Balanced: indicates whether a retrieved order’s total at the header level matches the sum of the retrieved order lines.
          • Existing Orders: indicates whether or not the status should apply to a retrieved channel order if that order already exists within Business Central.

          On each line, the value in the Implied Order Status field indicates the CSM order value that will be assigned to orders that share that line’s particular combination of values.

          For example, let’s say that we are working with an eCommerce platform that assigns both “pending” and “processing” status values to its orders. From the perspective of that external platform, these status values have significant meaning, but from the perspective of Business Central and CSM, maybe we want to treat both types in the same manner. In this scenario, we could create separate order status matrix lines for both pending and processing channel status values, then assign the same implied order status to them. When a pending or processing order is retrieved from the external platform, CSM will process them in the same way.

          A sales channel’s order status matrix is automatically loaded as part of the channel creation process. Oftentimes this default data load meets a company’s needs out-of-the-box. We recommend you do not attempt to add or modify any order status matrix lines for your sales channel until you begin the process of order retrieval. If certain orders are not being processed in the way you wish, you can then review the settings in the order status matrix and make the necessary adjustments.

          Order Note Placement

          When CSM retrieves an order from Shopify, it is possible to include any notes that have been entered for it. By default, CSM will automatically retrieve any notes that have been entered through the Shopify administration portal along with the rest of the order information. Retrieved order notes are entered as CSM order document lines on the related CSM order.

          If you wish, you can instruct CSM to place retrieved order notes on the sales order that is created from the CSM order:

          • Open your Shopify sales channel
          • Choose the Related ribbon, then select the Setup menu and choose the Order Notes Placement
          • On a new line, enter the code or reference value that the channel uses to identify the order note type in the Order Document No. field.

          If you are unfamiliar with the correct syntax used by the channel, we recommend you retrieve an order with the desired comment type into Business Central, then review the CSM Order Documents FastTab. The identifying value will be presented in the Order Document No. field.

          • In the Placement field, use the dropdown to indicate how you want these comments to be placed on sales orders. You can choose to have comments placed on sales lines or as sales order comments.

          Additional content: Setting up and using Shopify POS

          Next: CSM Customer Mapping