Skip to content
Support Portal
Request Demo
  • There are no suggestions because the search field is empty.

CSM Administration - API Messages/Log Entries

There may be scenarios in which it is necessary to reprocess an API message. For example, a connectivity issue might create an issue with an API message as it is being processed, leading to an incomplete activity. In such a scenario, the message may need to be edited and then reprocessed. This process will differ depending on whether you are working with the legacy or new API Engine.

Legacy API Engine (Amazon, BigCommerce, Shopify and WooCommerce)

  • Choose the looking glass and enter CSM API Messages, and then choose the related link
  • Choose the API message record you want to edit and reprocess.  You can only edit CSM API messages with a message status of Response.
  • Choose the Actions ribbon, then choose Edit Response Message.  This action will only be visible for CSM API messages with a message status of Response.
  • In the CSM Reprocess API Message window, make the necessary changes to the CSM API message’s response text.
  • Choose the Actions ribbon, then choose Reprocess

CSM will reprocess the CSM API message according to the new response information. If the record is successfully processed, its status will be updated accordingly.

New API Engine (Magento and Walmart)

  • Choose the looking glass enter API Messages, and then choose the related link
  • Choose the API message record you want to reprocess. You can edit any message type.
  • Choose the Actions ribbon, then select Copy & Edit API Message.  From here, choose the message element you want to edit.
  • In the Reprocess API Message window, make the necessary changes to the API message’s response text/
  • Choose the Actions ribbon, then select Manual Processing.  From here, choose the desired action you want to take.

CSM will reprocess the API message according to the new information. If the record is successfully processed, its status will be updated accordingly.


To further assist in troubleshooting activities, the Last API Message Processed field on the CSM Order Channel page presents a link to the most recent API message that was generated for a channel order. In the event that a channel order fails to process, this link allows someone looking into the issue to quickly access the most recent API activity in which the order was involved, where it can then be researched.

  • Processing Log Entries: if you have defined a log level on the CSM Setup page, processing log entries are created for warnings, errors, new pieces of information, or changes to existing information that occur through the execution of an API function. To understand how API messages and processing log entries relate to each other, an API message might be generated when a function to retrieve a new channel order is executed, while separate processing log entries would be generated to reflect the creation of that new order, the entry of a customer on that order, the entry of a shipping address on that order, the entry of a payment method on that order, and so forth. In this way, a single API message can be related to hundreds of processing log entries.

In some troubleshooting scenarios, it is necessary to review the specific processing log entries that were created as part of a routine. While it is possible to access a list of all processing log entries in Business Central, a better option is to open the relevant API message and choose the Related Processing Log Entries action in the ribbon. This will present a list of processing log entries that is filtered by the relevant API message ID. From here, additional filters can be set to further streamline the information, and the necessary research can occur.