Skip to main content

RestJson - Connector settings

RestJson - Connector Settings These settings control the behavior of the RestJson connector, allowing administrators to configure authenti...

Updated over a week ago

RestJson - Connector Settings

These settings control the behavior of the RestJson connector, allowing administrators to configure authentication, data synchronization, order processing, and other integration aspects. Proper configuration is crucial for ensuring seamless communication between App4Sales and the connected ERP system.

Settings are configured within the App4Sales portal on the connector configuration page. They are stored in the App4Sales database and applied at runtime whenever a task involving the connector is executed.

Authentication

Setting

Description

Values / Defaults

Dependencies / Effects

Client Secret

The client secret for OAuth 2.0 authentication.

String

Required for OAuth 2.0 authentication flows.

Client Id

The client ID for OAuth 2.0 authentication.

String

Required for OAuth 2.0 authentication flows.

Use basic authentication

Enables HTTP Basic Authentication. The username and password must be configured on the administration page.

Boolean (True/False)

When enabled, the connector sends an `Authorization` header with a base64-encoded username and password.

Use windows authentication

Enables Windows Authentication (NTLM/Kerberos).

Boolean (True/False)

The credentials of the App4Sales service account are used for authentication.

No authorization is used

Disables all authentication mechanisms.

Boolean (True/False)

Use this only for endpoints that do not require authentication.

Use an insecure SSL3 connection

Forces the connection to use the outdated and insecure SSLv3 protocol.

Boolean (True/False)

Only enable this for legacy systems that do not support modern TLS versions. This is highly discouraged.

Data Synchronization

Setting

Description

Values / Defaults

Dependencies / Effects

Warehouse

Specifies the warehouse code to be used for stock synchronization.

String

If a value is provided, stock levels will be fetched for this specific warehouse.

Use warehouse from user

If enabled, the connector will use the warehouse associated with the App4Sales user account.

Boolean (True/False)

This setting overrides the global 'Warehouse' setting if both are set.

Use relative picture url

Determines whether the connector should treat image URLs as relative or absolute.

Boolean (True/False)

If enabled, the base URL from the connector settings will be prepended to the image paths.

Use multiple item group levels

Enables the creation of a hierarchical item group structure based on multiple levels defined in the source data.

Boolean (True/False)

Requires the source data to provide item group levels in a specific format.

Sync customer notes from ERP

Enables the synchronization of customer notes from the ERP system to App4Sales.

Boolean (True/False)

The connector will call the corresponding endpoint to fetch notes.

Use prefix for prospects and suspects

Adds a prefix to the customer number for customers classified as 'prospect' or 'suspect'.

Boolean (True/False)

Helps distinguish non-customer accounts in the ERP system.

Include unknown elements for new customers

Allows sending non-standard or custom fields when creating a new customer in the ERP.

Boolean (True/False)

The ERP system must be able to process these extra fields.

Supports stock batch call

Enables the connector to fetch stock information for multiple items in a single API call.

Boolean (True/False), Default: True

Improves performance by reducing the number of API requests. The ERP must support a batch endpoint for stock.

Use stock for items batch

Enables fetching stock information in a batch when synchronizing items.

Boolean (True/False)

Improves performance during item syncs. Requires the ERP to have a batch-capable stock endpoint.

Use item prices batch

Enables fetching item prices in a batch.

Boolean (True/False)

Improves performance during price syncs. Requires the ERP to have a batch-capable price endpoint.

Order, Quote & Invoice Handling

Setting

Description

Values / Defaults

Dependencies / Effects

Order history backoffice

Retrieves order history from the backoffice system.

Boolean (True/False)

When enabled, users can view their historical orders placed in the ERP.

Send new customers to ERP

Allows the connector to send newly created customers from App4Sales to the ERP system.

Boolean (True/False)

If disabled, new customers created in App4Sales will not be created in the ERP.

Send new customer notes to ERP

When sending a new customer, also include any notes attached to the customer.

Boolean (True/False)

Depends on 'Send new customers to ERP' being enabled.

Add state to note subject

Includes the note's status (e.g., "Open", "Closed") in the subject line when sending it to the ERP.

Boolean (True/False)

Provides more context for the note in the ERP system.

Validate order number before sending

Checks if the order number already exists in the ERP before sending a new order.

Boolean (True/False)

Helps prevent duplicate orders. Requires an endpoint to validate order numbers.

Show invoices on relation card

Displays a customer's invoice history on their details page in App4Sales.

Boolean (True/False)

The connector will query the ERP for invoices linked to the customer.

Show backorders on relation card

Displays a customer's backorders on their details page.

Boolean (True/False)

The connector will query the ERP for backorders linked to the customer.

Show quotations on relation card

Displays a customer's quotations on their details page.

Boolean (True/False)

The connector will query the ERP for quotations linked to the customer.

Don't send alternative address on order to the backoffice.

Prevents the alternative shipping address from being sent with the order.

Boolean (True/False)

The order will always use the customer's primary address.

Use customer code for order history retrieve

Uses the customer's code instead of their unique ID (GUID) when fetching order history.

Boolean (True/False)

Should be enabled if the ERP's order history endpoint uses the customer code for filtering.

Sort orders in history by order date

Sorts the retrieved order history by the order date.

Boolean (True/False)

If disabled, the sorting is determined by the ERP response.

Use discount percent in order line history price calculation

Applies the discount percentage from the order line history to calculate the final price.

Boolean (True/False)

Ensures historical order line prices are calculated correctly if the ERP provides discount percentages.

Real-time Information & Search

Setting

Description

Values / Defaults

Dependencies / Effects

Real-time info calls based on comma-separated

Uses a comma-separated list of IDs for real-time API calls instead of multiple individual requests.

Boolean (True/False)

Can improve performance if the ERP API supports batch queries with comma-separated values.

Use customer code for item price for customer search

Uses the customer code instead of the unique ID when searching for customer-specific item prices.

Boolean (True/False)

Enable if the ERP's pricing endpoint identifies customers by their code.

Use url parameter for customer code for backorders search

Sends the customer code as a URL parameter when searching for backorders.

Boolean (True/False)

Should be enabled if the ERP's backorder endpoint expects the customer code in the URL.

Use url parameters for item stock search

Uses URL parameters to specify items when searching for stock levels.

Boolean (True/False)

Enable if the ERP's stock endpoint expects item identifiers in the URL.

Use url parameters for order lines search

Uses URL parameters to specify the order when searching for its lines.

Boolean (True/False)

Enable if the ERP's order line endpoint expects an order identifier in the URL.

OData Settings

Setting

Description

Values / Defaults

Dependencies / Effects

Use OData filter for item price for customer search

Uses OData `$filter` syntax for querying customer-specific item prices.

Boolean (True/False), Default: True

Enable if the ERP API supports OData filtering on the pricing endpoint.

Use OData filter for the item stock

Uses OData `$filter` syntax for querying item stock.

Boolean (True/False)

Enable if the ERP API supports OData filtering on the stock endpoint.

Omit OData service version headers

Prevents the connector from sending OData version headers in the request.

Boolean (True/False)

May be required for some OData implementations that do not expect version headers.

OData Response Version

Specifies the OData version of the response payload.

Dropdown ('', 'V2', 'V4')

The connector will parse the response according to the selected OData version (V2 or V4).

Did this answer your question?