Using standard custom field names
Purpose and scope
Aphix Digital Platform integrates seamlessly with your ERP, allowing you to use and extend your business data without compromising its quality and integrity. Aphix has developed and maintains a standard set of services to integrate its Digital Platform with Intact iQ.
Data is requested and sent through a standard data interface using a web service. Which web service you integrate with depends on the ERP you use.
Integrating your ERP with Aphix Digital Platform is a key task that occurs when your solution is being built. Often, it is necessary to use custom fields when integrating your ERP with Aphix Digital Platform so that business data can be used to carry out typical eCommerce tasks, such as placing sales orders or creating quotes. Consequently, there is a set of custom fields that are frequently used. In order to streamline integrating Aphix Digital Platform with your ERP, there is a standard convention when naming these custom fields.
The custom fields listed in this guide are all required fields for successfully integrating Aphix Digital Platform with your ERP.
This feature guide lists the names of the custom field that are typically used to support a seamless integration with your ERP.
Benefits
Using custom fields as part of an integration between Aphix Digital Platform and your ERP allows you to get the most out of your Aphix eCommerce, MobileApps or eProcurement solution.
Using the standard naming convention and the standard custom name fields listed in this article enables a more streamlined and standard integration to take place.
Introducing terms and concepts used in this article
Term | Definition |
|---|---|
Enterprise resource planning (ERP) | a collection of your critical business operating systems, such as product, stock levels, financial, customers, suppliers and so on that run on the same platform. |
Web service | service that allows two disparate systems communicate with each other via a standard messaging system. |
Standard custom field names
Aphix Digital Platform uses standard custom field names to extend the integration between it and your ERP.
As a general rule, custom field names that are used in Aphix Digital Platform are prefixed with "AX-".
Custom field names in Intact iQ
Recommendation
When creating user-defined fields in Intact iQ that map to those listed on this page, we recommend that you use the following convention: D_<Field-Name>.
Feature set | Feature | Field Name | Field Format | Document | Purpose |
|---|---|---|---|---|
| AX_Channel_Type | alphanumeric |
| To identify how or through what channel ,the order was placed. Channels could be set to "WebShop", "SalesRep", "PocketShop" or "API" for orders, invoices and quotations in those different channels. |
| AX_Channel_Ref | alphanumeric |
| To identify a specific channel. For example, you could have two WebShops called webshop-A.com and webshop-B.com; use this field to specify which WebShop to use for sales through that specific channel. |
| AX_Doc_Ref | alphanumeric |
| To identify a specific order, invoice or quotation. In WebShop, this typically is set to the next number in series. |
| AX_PhoneNumber | alphanumeric |
| To specify a contact phone number of a delivery contact. |
| AX_EmailAddress | alphanumeric |
| To specify an email address on sales orders and invoices. |
| AX_COUPON_CODE | alphanumeric |
| To capture the coupon code used on an order. Currently, this is only used by a percentage discount coupon. |
| AX_VOUCHER_CODE | alphanumeric |
| To capture the voucher code spent on an order. Currently, this is only used where the coupon amount is fixed and by shipping vouchers. |
| AX_VOUCHER_SPENT | numeric |
| To capture the voucher amount spent on an order. Currently, this is only used where the coupon amount is fixed and by shipping vouchers. |