PrestaShop - Connector Settings
This document describes the general REST/JSON connector settings that are likely utilized by the PrestaShop connector. These settings influence various aspects of how the connector interacts with external systems, including authentication, data synchronization, and specific feature toggles. Application Administrators and Implementation Consultants can configure these values to tailor the connector's behavior to their specific ERP system and business requirements.
Data Source Configuration
Connector settings are typically stored and managed within the App4Sales platform's administration interface. Changes made to these settings are applied at runtime, affecting how the connector retrieves and sends data to the connected external system.
Data Mapping Table
Setting | Description | Values / Defaults | Dependencies / Effects |
Client Secret | Secret key used for authenticating with the external system. This is a required setting. | String | Required for secure API communication. Marked as encrypted. |
Client Id | Identifier for the client application when authenticating with the external system. This is a required setting. | String | Required for secure API communication. Marked as encrypted. |
Use Basic authentication | Determines if basic authentication (username and password) should be used for API requests. This is a required setting. | Boolean | If enabled, the connector will attempt to use basic authentication. |
Use windows authentication | Determines if Windows integrated authentication should be used for API requests. This is a required setting. | Boolean | If enabled, the connector will attempt to use Windows authentication. |
No authorization is used | Indicates that no authorization mechanism is required for API requests. This is a required setting. | Boolean | If enabled, the connector will not send any authorization headers. |
Warehouse | Specifies the default warehouse code to be used in various operations. | String | Affects inventory lookups and order processing if not explicitly overridden. |
Order History Backoffice | Enables or disables the synchronization of order history from the backoffice system. | Boolean | When enabled, order history data will be retrieved from the backoffice. |
Use Relative Picture Url | Determines if relative URLs should be used for product images. | Boolean | Affects how product image URLs are constructed and displayed. |
Use multiple item group levels | If enabled, the connector will retrieve and utilize multiple levels of item groups (categories). | Boolean | Impacts how product categories are structured and synchronized. |
Send new customers to ERP | Controls whether newly created customers in App4Sales are sent to the ERP system. | Boolean | If enabled, new customer records will be pushed to the ERP. |
Send new customer notes to ERP | Controls whether customer notes created in App4Sales are sent to the ERP system. | Boolean | If enabled, customer notes will be pushed to the ERP. |
Real-time info calls based on comma-separated | If enabled, real-time information calls will use comma-separated values for parameters. | Boolean | Affects the format of parameters in real-time API requests. |
Add state to note subject | If enabled, the state information will be included in the subject of notes sent to the ERP. | Boolean | Modifies the subject line of synchronized notes. |
Validate order number before sending | If enabled, the order number will be validated before sending the order to the ERP system. | Boolean | Ensures order number format or uniqueness before submission. |
Use an insecure SSL3 connection | Enables the use of the SSL3 protocol for connections, which is generally insecure. | Boolean | Should only be enabled if absolutely necessary for compatibility with legacy systems, as it poses a security risk. |
Sync customer notes from ERP | Enables or disables the synchronization of customer notes from the ERP system to App4Sales. | Boolean | If enabled, customer notes will be pulled from the ERP. |
Use prefix for prospects and suspects | If enabled, a prefix will be used for prospects and suspects when creating customer records. | Boolean | Modifies the naming convention for specific customer types. |
Include unknown elements for new customers | If enabled, unknown data elements will be included when creating new customer records. | Boolean | Affects the completeness of new customer data synchronized to the ERP. |
Show invoices on relation card | Determines whether invoices related to a customer are displayed on their relation card in App4Sales. | Boolean | Controls UI visibility of invoice data. |
Don't send alternative address on order to the backoffice. | If enabled, an alternative shipping address provided on an order will not be sent to the backoffice system. | Boolean | Controls whether alternative addresses are synchronized with the ERP. |
Use customer code for order history retrieve | If true, the connector will use the customer code field for retrieving order history instead of the customer GUID field. | Boolean | Affects the lookup mechanism for customer order history. |
Use customer code for item price for customer search | If enabled, the customer code will be used when searching for item prices specific to a customer. | Boolean | Affects how customer-specific pricing is retrieved. |
Use url parameter for customer code for backorders search | If enabled, the customer code will be passed as a URL parameter when searching for backorders. | Boolean | Affects the API request format for backorder searches. |
Use url parameters for item stock search | If enabled, item stock search queries will utilize URL parameters. | Boolean | Affects the API request format for item stock searches. |
Use url parameters for order lines search | If enabled, order line search queries will utilize URL parameters. | Boolean | Affects the API request format for order line searches. |
Use OData filter for item price for customer search | If enabled, an OData filter will be used for item price searches specific to a customer. | Boolean (Default: true) | Affects the query mechanism for customer-specific item prices. |
Use OData filter for the item stock | If enabled, an OData filter will be used for item stock searches. | Boolean | Affects the query mechanism for item stock. |
Sort orders in history by order date | If enabled, orders in the history view will be sorted by their order date. | Boolean | Affects the presentation order of historical orders. |
Use discount percent in order line history price calculation | If enabled, discount percentages will be factored into the price calculation for order line history. | Boolean | Affects how historical order line prices are calculated and displayed. |
Omit OData service version headers | If enabled, OData service version headers will be omitted from API requests. | Boolean | Can be used for compatibility with certain OData services. |
Supports Stock Batch Call | Indicates whether the connected system supports batch calls for stock information. | Boolean (Default: true) | Influences the efficiency of stock synchronization. |
Show backorders on relation card | Determines whether backorders related to a customer are displayed on their relation card in App4Sales. | Boolean | Controls UI visibility of backorder data. |
Use warehouse from user | If enabled, the warehouse associated with the user will be used for operations. | Boolean | Affects warehouse selection for various functions. |
Use stock for items batch | If enabled, stock information will be included when processing items in batches. | Boolean | Influences the data included in batched item operations. |
Use item prices batch | If enabled, item price information will be included when processing items in batches. | Boolean | Influences the data included in batched item operations. |
Show quotations on relation card | Determines whether quotations related to a customer are displayed on their relation card in App4Sales. | Boolean | Controls UI visibility of quotation data. |
OData Response Version | Specifies the desired OData response version (e.g., V2 or V4). | String (Options: "", "V2", "1", "V4", "2") | Controls the OData protocol version used for responses, ensuring compatibility with the ERP system's OData implementation. |
Special Logic & Filters
These settings primarily control the authentication, data fetching, and data sending mechanisms for generic REST/JSON connectors. Conditional logic often revolves around the boolean flags to enable or disable certain behaviors, such as different authentication methods or specific data synchronization features. The [RequiredConnectorSetting] attribute indicates settings that are mandatory for the connector to function correctly.
Domain Specifics / Extension Section
This section details settings that are common across REST/JSON based connectors. While the PrestaShop connector specifically utilizes these settings, they are not unique to PrestaShop but rather provide a flexible configuration for any REST/JSON integration.
Authentication
Settings like "Client Secret", "Client Id", "Use Basic authentication", "Use windows authentication", and "No authorization is used" dictate how the connector authenticates with the external system. It is crucial to configure these correctly based on the ERP's security requirements.
Customer and Order Processing
Settings such as "Send new customers to ERP", "Send new customer notes to ERP", and various "Use customer code for..." settings control the flow and lookup mechanisms for customer and order related data between App4Sales and the ERP.
Data Querying and Filtering
Settings related to "Use OData filter for..." and "Use url parameters for..." indicate how the connector constructs API queries to efficiently retrieve specific data, such as item prices, stock, or backorders. The "OData Response Version" setting allows for compatibility with different versions of OData services.
Related Settings & Prerequisites
Many of these settings are interdependent. For instance, authentication settings must align with the security configuration of the target ERP system. Correct configuration of client IDs and secrets is a prerequisite for successful authenticated API calls.
Settings marked with [RequiredConnectorSetting] are essential for the connector's basic operation.
Known Limitations
Since these are generic REST/JSON settings, they provide a broad range of configuration options. However, specific nuances or unique features of the PrestaShop platform that are not covered by these general settings might require custom logic within the connector itself, which is not configurable via these settings. For example, there are no specific settings here for PrestaShop-specific concepts like "Shop IDs" or "Language IDs" for multi-language or multi-shop setups.