Creating an API key

To let the module send site orders to the CRM it needs an API access to your RetailCRM account. Go to the Settings > Integration > API access keys page and press the Add button.

Adding an API key

RetailCRM will generate a new key and open its settings page. Choose the Access to all stores variant in the Access type dropdown list if you want to set up an integration for all of your sites. Or you can choose the Access to a particular store and then select stores you want to integrate in the Stores field below. Stores are set up on the Settings > Stores page.

Enable the following actions in the Allowed actions in API field:

  • Orders
    • Editing (order_write) - for orders creation
  • Customers
    • Getting (customer_read)- for finding duplicates
  • Data book
    • Getting (reference_read)- for getting lists of available shops, payment and delivery types
  • Custom fields
    • Getting (custom_fields_read)- for getting lists of custom fields and dictionaries
  • Integration
    • Editing (integration_write) - for registering the module in the CRM

RetailCRM API key settings

To save the changes you made click the Save button.